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

API Pay-out ภูมิภาค บราซิล (BRL). ดู Payment methods。

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 request body.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm (e.g. BRT −03:00).
X-SIGNATURE	M	String	Signature of JSON body (see product Signature doc).
X-PARTNER-ID	M	String	Your merchantID (alphanumeric).

Body Parameters

Field	Required	Type	Description
orderNo	M	String(32)	Merchant-unique id, 6–32 alphanumeric.
purpose	M	String(64)	Memo to payer, 1–64 UTF-8 chars.
merchant	M	Object	Wraps merchantId and optional sub-merchant fields.
merchantId	M	String	Smilepayz merchantId for this call.
merchantName	O	String	UTF-8 merchant display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	UTF-8 name for subMerchantId.
money	M	Object	Currency plus amount for this transaction.
currency	M	String	Fixed to BRL.
amount	M	Number	BRL integer minor units (e.g. 5000 = BRL 50.00).
paymentMethod	M	String(6)	Same as pixType, Code (see Payment methods doc).
cashAccount	M	String(32)	Same as pixAccount: beneficiary account identifier.
receiver	M	Object	Beneficiary object (see Receiver model).
pixType	O	String	Recommended; identifier type (e.g. CPF, CNPJ);
pixAccount	O	String	Recommended; identifier value;
taxNumber	O	String	Recommended; for CPF/CNPJ, same as pixAccount.
callbackUrl	O	String(256)	HTTPS async status URL, max 256 chars.

---

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

{
    "orderNo": "2000102900000000000001",
    "purpose": "Freelancer payout — Rio",
    "merchant": {
        "merchantId": "20001"
    },
    "money": {
        "currency": "BRL",
        "amount": 1000
    },
    "paymentMethod": "CPF",
    "cashAccount": "12345678901",
    "receiver": {
        "name": "João da Silva",
        "taxNumber": "12345678901"
    }
}

Responses

HTTP Request

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

Body Parameters

Field	Required	Type	Description
code	M	String	00 success, other values error.
message	M	String	UTF-8 human-readable result line.
orderNo	M	String	Merchant-unique id, 6–32 alphanumeric.
tradeNo	O	String	Smilepayz tradeNo for this order.
merchant	M	Object	Wraps merchantId and optional sub-merchant fields.
merchantId	M	String	Smilepayz merchantId for this call.
merchantName	O	String	UTF-8 merchant display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	UTF-8 name for subMerchantId.
accountNo	O	String	Settlement accountNo if gateway returns it.
money	M	Object	Currency plus amount for this transaction.
currency	M	String	Fixed to BRL.
amount	M	Number	BRL integer minor units (e.g. 5000 = BRL 50.00).
disbursementTime	M	String	Format (yyyy-MM-ddTHH:mm:ss±HH:mm).
channel	M	Object	Channel payload (paymentUrl, qrString, …).
paymentMethod	M	String	Same as pixType, Code (see Payment methods doc).
cashAccount	M	String	Same as pixAccount: beneficiary account identifier.
accountName	O	String	Display name when returned.
status	O	String	Order or payment status enum value.

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",
    "merchant": {
        "merchantId": "20001",
        "merchantName": "Smilepayz Demo Store",
        "accountNo": "2000124234782342"
    },
    "money": {
        "currency": "BRL",
        "amount": 1000
    },
    "disbursementTime": "2024-12-17T10:55:00-03:00",
    "channel": {
        "paymentMethod": "CPF",
        "cashAccount": "12345678901",
        "accountName": "João da Silva"
    },
    "status": "PROCESSING"
}

Notification/Callback

HTTP Request

Field	Required	Type	Description
Content-Type	M	String	application/json request body.
X-TIMESTAMP	M	String	Format: yyyy-MM-ddTHH:mm:ss±HH:mm
X-SIGNATURE	M	String	Callback body signature (see Callback signature guide).

Body Parameters

Field	Required	Type	Description
orderNo	M	String	Merchant-unique id, 6–32 alphanumeric.
tradeNo	M	String	Smilepayz tradeNo for this order.
merchantId	M	String	Smilepayz merchantId for this call.
merchantName	M	String	UTF-8 merchant display name.
subMerchantId	O	String	Sub-merchant ID.
subMerchantName	O	String	UTF-8 name for subMerchantId.
paymentMethod	M	String	Same as pixType, Code (see Payment methods doc).
transactionTime	M	String	Format: yyyy-MM-ddTHH:mm:ss
money	M	Object	Currency plus amount for this transaction.
currency	M	String	Fixed to BRL.
amount	M	Number	BRL integer minor units (e.g. 5000 = BRL 50.00).
status	M	String	Order or payment status enum value.

Return

Important

Respond with the string SUCCESS only.

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

SUCCESS