การโอนจ่าย (Pay-out · บราซิล)

Disburse in Brazil (BRL) via PIX keys (CPF, CNPJ, PHONE, EMAIL, EVP); see Payment methods. Send cashAccount, paymentMethod, and receiver.taxNumber.

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. BRT −03: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	BRL only.
amount	M	Number	Integer centavos (e.g. 10000 = BRL 100.00).
paymentMethod	M	String(6)	CPF, CNPJ, PHONE, EMAIL, EVP; Payment methods.
cashAccount	M	String(32)	PIX key value (CPF/CNPJ/phone/email/EVP).
receiver	M	Object	Receiver Model.
taxNumber	M	String	Recipient tax id (CPF 11 / CNPJ 14 digits).
callbackUrl	O	String(256)	Webhook URL; HTTP(S); max 256.
additionalParam	O	Object	Extra parameters when required by product.

---

Example Body – Disbursement Request:

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

{
    "additionalParam": {},
    "cashAccount": "12532481501",
    "receiver": {
        "taxNumber": "12345678909"
    },
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "amount": 10000,
        "currency": "BRL"
    },
    "orderNo": "2000102900000000000001",
    "paymentMethod": "CPF",
    "purpose": "Purpose For Disbursement from Java SDK"
}

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.
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	BRL.
amount	M	Number	Integer centavos.
disbursementTime	M	String	When disbursement was accepted (yyyy-MM-ddTHH:mm:ss±HH:mm).
channel	M	Object	Channel Model.
paymentMethod	M	String	Echo paymentMethod.
cashAccount	M	String	Echo cashAccount.
accountName	O	String	Display name when returned.
tradeNo	O	String	Platform trade ID.
status	O	String	Status Model.

Example Body – Disbursement Response:

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

{
  "code": "00",
  "message": "Successful",
  "orderNo": "2000102900000000000001",
  "tradeNo": "1022000109e998347483949",
  "status": "PROCESSING",
  "disbursementTime": "2024-12-17T10:55:00-03:00",
  "merchant": {
    "merchantId": "20001",
    "merchantName": "test",
    "accountNo": "2000124234782342"
  },
  "money": {
    "currency": "BRL",
    "amount": 10000
  },
  "channel": {
    "paymentMethod": "CPF",
    "cashAccount": "12532481501",
    "accountName": "Betty"
  }
}

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 PIX key type (CPF, CNPJ, …).
transactionTime	M	String	Completion time.
money	M	Object	Final amount; Money Model.
currency	M	String	BRL.
amount	M	Number	Integer centavos. Note: may differ from the request for fees/partials—reconcile on tradeNo.
status	M	String	Status Model.

Return

Important

Respond with the string SUCCESS only.

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

SUCCESS