Disbursement (pay-out)

Disburse to bank accounts in Mexico (MXN): rails such as BANXICO, BANAMEX, BBVAMX; see Payment methods. Send cashAccount and paymentMethod.

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

Field	Required	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. Mexico CST −06:00).
X-SIGNATURE	M	String	Request signature; Signature Generation.
X-PARTNER-ID	M	String	merchantID (alphanumeric).

Body Parameters

Field	Required	Type	Description
orderNo	M	String(32)	6–32 alphanumeric; unique per merchant.
purpose	M	String(64)	UTF-8; length 1–64.
merchant	M	Object	Merchant routing and settlement.
merchantId	M	String	Platform merchant ID.
merchantName	O	String	UTF-8 display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Sub-merchant name (UTF-8).
money	M	Object	Amount and currency.
currency	M	String	MXN only.
amount	M	Number	Integer centavos (minor units).
paymentMethod	M	String	Pay-out bank / rail code (e.g. BANXICO, BANAMEX); Payment methods.
cashAccount	M	String(32)	Beneficiary CLABE or account id (max 32).
additionalParam	O	Object	Extra parameters when required by product.
callbackUrl	O	String(256)	Webhook URL; HTTP(S); max 256.

---

Example Body – Disbursement Request:

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

{
  "orderNo": "2000102900000000000001",
  "paymentMethod": "BANXICO",
  "purpose": "Salary payment for March 2024",
  "additionalParam": {},
  "cashAccount": "17385238451",
  "merchant": {
    "merchantId": "20001"
  },
  "money": {
    "amount": 20000,
    "currency": "MXN"
  }
}

Responses

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm

Body Parameters

Field	Required	Type	Description
code	M	String	00 = success; other codes = error.
message	M	String	Result text (UTF-8).
orderNo	M	String	Echo of orderNo.
tradeNo	O	String	Platform trade ID.
merchant	M	Object	Merchant Model.
merchantId	M	String	Merchant ID.
merchantName	O	String	Display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Sub-merchant name.
accountNo	O	String	Merchant account number when returned.
money	M	Object	Money Model.
currency	M	String	MXN.
amount	M	Number	Integer centavos.
disbursementTime	M	String	When disbursement was processed (yyyy-MM-ddTHH:mm:ss±HH:mm).
channel	M	Object	Channel snapshot; Channel Model.
paymentMethod	M	String	Settled method code.
cashAccount	M	String	Recipient account.
status	O	String	Status Model.

Example Body – Disbursement Response:

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

{
  "code": "00",
  "message": "Successful",
  "orderNo": "2000102900000000000001",
  "merchant": {
    "merchantId": "20001",
    "merchantName": "20001",
    "accountNo": "21220019202402271029"
  },
  "money": {
    "currency": "MXN",
    "amount": 20000
  },
  "disbursementTime": "2024-01-13T13:31:11-06:00",
  "channel": {
    "paymentMethod": "BANXICO",
    "cashAccount": "123456789"
  },
  "tradeNo": "122200192401131501111816",
  "status": "PROCESSING"
}

Notification/Callback

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	Callback signature; verify.

Body Parameters

Field	Required	Type	Description
orderNo	M	String	Same orderNo as payout request.
tradeNo	M	String	Platform tradeNo.
merchantId	M	String	Merchant ID.
merchantName	M	String	Display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	Sub-merchant name.
paymentMethod	M	String	Settled channel (e.g. BANXICO).
transactionTime	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
money	M	Object	Final amount; Money Model.
currency	M	String	MXN.
amount	M	Number	Integer centavos.
status	M	String	Status Model.

Return

Important

Respond with the string SUCCESS only.

{
  "orderNo": "2000102900000000000001",
  "tradeNo": "1022000109e998347483949",
  "merchantId": "20001",
  "merchantName": "test",
  "subMerchantId": "",
  "subMerchantName": "",
  "paymentMethod": "BANXICO",
  "transactionTime": "2024-07-03T17:34:07-06:00",
  "status": "SUCCESS",
  "money": {
    "currency": "MXN",
    "amount": 10000
  }
}

SUCCESS