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

Query Withdrawal Account Detail

Retrieves the current details of a specific withdrawal account.

Endpoint

POST /remittance/withdrawal/query-withdrawal-account-detail

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

payee_id

long

O

Unique identifier of the payee or withdrawal beneficiary.

account_num

string

O

Bank account number registered as a withdrawal destination.

choose one of withdrawal_account_id and account_num

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.

{
  "payee_id": 100001,
  "account_num": "1234567890"
}

Request example

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

Response

Response data fields

Field
Type
Requirement
Description

withdrawal_account_id

long

O

Unique identifier of the merchant's withdrawal account.

merchant_id

long

M

Pagsmile-assigned unique identifier of the merchant associated with the returned withdrawal account.

payee_name

string

M

Name of the payee or withdrawal beneficiary.

bank_country

string

M

Two-letter ISO 3166-1 alpha-2 code of the country where the bank account is held.

receive_currency

string

M

Three-letter ISO 4217 code of the currency credited to the recipient.

payment_type

integer

M

Payment route used to deliver funds to the recipient. See Pay Type for supported values.

account_type

integer

M

Type of destination bank account. See Account Type for supported values.

payee_type

integer

M

Classification of the payee or beneficiary. See Payee Type for supported values.

payee_values

object

M

Country- and payment-route-specific beneficiary account details.

account_num

string

M

Bank account number registered as a withdrawal destination.

remark

string

O

Optional note supplied by the merchant for operational review and reconciliation.

Last updated

Was this helpful?