Skip to main content

Disbursement (pay-out)

About 2 min

USDT region pay-out API (USDT).

Request

POST/v2.0/disbursement/digital-pay-out

Request Path:

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

Header Parameters

FieldRequiredTypeDescription
Content-TypeMStringapplication/json request body.
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATUREMStringSignature of JSON body (see product Signature doc).
X-PARTNER-IDMStringYour merchantID

Body Parameters

FieldRequiredTypeDescription
orderNoMString(32)Merchant-unique id
purposeMString(64)Memo to beneficiary
merchantMObjectWraps merchantId and optional sub-merchant fields.
    merchantIdMStringSmilepayz merchantId.
    merchantNameOStringMerchant display name.
moneyMObjectCurrency plus amount.
    currencyMStringFixed to USDT.
    amountMNumberAmount
paymentMethodMString(6)See Payment methods.
cashAccountMString(32)Recipient wallet address.
networkMString(32)Blockchain network: TRC20; ERC20, BEP20 temporarily unavailable.
callbackUrlOString(256)HTTPS async status URL, max 256 chars.

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 request body.
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

FieldRequiredTypeDescription
codeMString00 success; other codes indicate failure.
messageMStringUTF-8 result message.
orderNoMStringMerchant-unique id
tradeNoOStringPlatform tradeNo.
merchantMObjectWraps merchantId and optional sub-merchant fields.
moneyMObjectCurrency plus amount.
    currencyMStringFixed to USDT.
    amountMNumberAmount
disbursementTimeMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm
channelMObjectChannel payload.
    paymentMethodMStringPayment method code.
    cashAccountMStringRecipient wallet address.
statusOStringOrder or payment status enum.
Content-type: application/json
X-TIMESTAMP: 2020-12-17T10:55:00+07:00

Notification/Callback

HTTP Request

FieldRequiredTypeDescription
Content-TypeMStringapplication/json request body.
X-TIMESTAMPMStringFormat: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATUREMStringCallback body signature (see Callback verification).

Body Parameters

FieldRequiredTypeDescription
orderNoMStringMerchant-unique id
tradeNoMStringPlatform tradeNo.
merchantIdMStringSmilepayz merchantId.
merchantNameMStringMerchant display name.
paymentMethodMStringSee Payment methods.
transactionTimeMStringFormat: yyyy-MM-ddTHH:mm:ss
moneyMObjectCurrency plus amount.
    currencyMStringFixed to USDT.
    amountMNumberAmount
statusMStringOrder or payment status enum.

Return

Important

Respond with the string SUCCESS only.

{
  "orderNo": "2000102900000000000001",
  "tradeNo": "20001032432400001",
  "merchantId": "20001",
  "merchantName": "Smilepayz Demo Store",
  "subMerchantId": "",
  "subMerchantName": "",
  "paymentMethod": "USDT",
  "transactionTime": "2024-12-17T10:55:00+07:00",
  "money": {
    "currency": "USDT",
    "amount": 100
  },
  "status": "SUCCESS"
}