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

Create Topup Order

Creates a top-up order to add funds to a partner balance and records the expected incoming payment details.

Endpoint

POST /remittance/partner/create-topup

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

order_no

string

M

Merchant-defined order number used to submit, query, and reconcile the top-up order.

pay_amount

string

M

Amount debited in the payment currency.

pay_currency

string

M

Three-letter ISO 4217 code of the currency debited for the transaction. See currency for supported values.

topup_currency

string

M

Three-letter ISO 4217 code of the currency credited by the top-up. See currency for supported values.

reference

string

O

Merchant-provided reference used to reconcile the top-up order with the merchant's internal records.

payment.account_no

string

O

Bank or platform account number to which the top-up is credited.

payment.bank_name

string

O

Name of the financial institution that holds the account.

payment.arrive_date

string

O

Expected date and time when the incoming top-up payment will arrive.

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.

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

order_id

long

O

Pagsmile-assigned unique identifier of the order.

Last updated