For the complete documentation index, see llms.txt. This page is also available as Markdown.

Internal transfer

Transfers funds between a merchant account and an eligible partner account without using an external payment rail.

Endpoint

POST /remittance/account/transfer

Sandbox base URL: https://rem-api-sandbox.pagsmile.com Content-Type: application/json; charset=UTF-8

The request uses the standard Remittance API request envelope. The fields below describe the decrypted biz_data object.

Requirement: M = Mandatory, O = Optional, and C = Conditional. A conditional field is mandatory only when the condition stated in its description applies.

Request body

Decrypted biz_data fields

Field
Type
Requirement
Description

merchant_id

long

M

Pagsmile-assigned unique identifier of the merchant.

order_no

string

M

Merchant-defined order number used to submit, query, and reconcile the internal transfer.

partner_account_no

string

M

Partner account number involved in the transfer.

transfer_type

integer

M

Direction of the internal transfer. Supported values: 1 — Partner to merchant 2 — Merchant to partner

amount

string

M

Monetary amount of the transaction, expressed in the corresponding currency.

currency

string

M

Three-letter ISO 4217 code of the currency in which the internal transfer values are denominated.

reference

string

O

Merchant-provided reference used to reconcile the transaction with the merchant's internal records.

Plaintext biz_data example

This example includes mandatory fields and representative optional or conditional fields. Submit fields marked C only when the condition in the field description applies.

{
  "merchant_id": 100398,
  "order_no": "ORDER_202607200001",
  "partner_account_no": "1234567890",
  "transfer_type": 1,
  "amount": "100.00",
  "currency": "USD",
  "reference": "Example reference"
}

Request example

Use the partner_id and app_id assigned to your integration. The values above are placeholders.

Response

Last updated

Was this helpful?