跳至主要內容

代付/付款(Pay-Out)

smilepayz teams大约 3 分钟

印尼代付;银行、虚拟账户、电子钱包等。

Request

POST/v2.0/disbursement/pay-out

Request Path:

sandbox: https://sandbox-gateway.smilepayz.com/v2.0/disbursement/pay-out
production: https://gateway.smilepayz.com/v2.0/disbursement/pay-out

Header Parameters

FieldRequiredTypeDescription
Content-TypeMStringapplication/json
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATUREMStringRequest signature; Signature Generation.
X-PARTNER-IDMStringmerchantID (alphanumeric).

Body Parameters

FieldRequiredTypeDescription
orderNoMString(32)6–32 alphanumeric; unique per merchant.
purposeMString(64)UTF-8; length 1–64.
merchantMObjectMerchant routing and settlement.
    merchantIdMStringPlatform merchant ID.
    merchantNameOStringUTF-8 display name.
    subMerchantIdOStringSub-merchant ID.
    subMerchantNameOStringSub-merchant name (UTF-8).
moneyMObjectAmount and currency.
    currencyMStringIDR only.
    amountMNumberInteger minor units; range 10000–999999999.
paymentMethodMString(6)Channel code (e.g. BRI, BCA, DANA, OVO).
cashAccountMString(32)Bank VA or wallet ID; DANA uses 8xxxxxxx.
receiverOObjectOptional recipient details.
    nameOStringRecipient name (UTF-8).
    accountNoOStringAlternative account hint.
callbackUrlOString(256)Webhook URL; HTTP(S); max 256.

Example Body – Disbursement Request:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00
X-SIGNATURE: 7MHd9v5/m9JeqmDZVwWBZUZ5J5...7120QnFEny7Qm7uQR1G0TWCh10fsU6nVxiRoeoQ==
X-PARTNER-ID: 20001

Responses

HTTP Request

FieldRequiredTypeDescription
Content-TypeMStringapplication/json
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

FieldRequiredTypeDescription
codeMString00 = success; other codes = error.
messageMStringResult text (UTF-8).
orderNoMStringEcho of orderNo.
tradeNoOStringPlatform trade ID.
merchantMObjectMerchant Model.
    merchantIdMStringMerchant ID.
    merchantNameOStringDisplay name.
    subMerchantIdOStringSub-merchant ID.
    subMerchantNameOStringSub-merchant name.
moneyMObjectMoney Model.
    currencyMStringIDR.
    amountMNumberInteger minors.
disbursementTimeMStringWhen disbursement was processed (yyyy-MM-ddTHH:mm:ss±HH:mm).
channelMObjectChannel / recipient snapshot.
    paymentMethodOStringSettled method code.
    cashAccountOStringRecipient account.
    accountNameOStringAccount holder name.
statusOStringStatus Model.

Example Body – Disbursement Response:

Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

Notification/Callback

HTTP Request

FieldRequiredTypeDescription
Content-TypeMStringapplication/json
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATUREMStringCallback signature; verify.

Body Parameters

FieldRequiredTypeDescription
orderNoMStringSame orderNo as payout request.
tradeNoMStringPlatform tradeNo.
merchantIdMStringMerchant ID.
merchantNameMStringDisplay name.
subMerchantIdOStringSub-merchant ID.
subMerchantNameOStringSub-merchant name.
paymentMethodMStringSettled channel (e.g. BRI, BCA).
transactionTimeMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm
moneyMObjectFinal amount; Money Model.
    currencyMStringIDR.
    amountMNumberInteger minors.
statusMStringStatus Model.

Return

重要

仅返回字符串 SUCCESS

{
  "orderNo": "2000102900000000000001",
  "tradeNo": "1022000109e998347483949",
  "merchantId": "20001",
  "merchantName": "test",
  "subMerchantId": "",
  "subMerchantName": "",
  "paymentMethod": "BRI",
  "transactionTime": "2024-12-17T10:55:00",
  "money": {
    "currency": "IDR",
    "amount": 10000
  },
  "status": "SUCCESS"
}