Create withdraw order

POST

/api/payOut/unifiedOrder

withdraw code

Type code	Type name	Account format
PIX_CPF	PIX_CPF	11 digits
PIX_CNPJ	PIX_CNPJ	14 digits
PIX_PHONE	PIX_PHONE	+55{10-11 digits}
PIX_EMAIL	PIX_EMAIL	Email format
PIX_EVP	PIX_EVP	^[0-9 a-z]{8}-[0-9 a-z]{4}-[0-9 a-z]{4}-[0-9 a-z]{4}-[0-9 a-z]{12}$

Limit information

	Withdraw amount rule
Withdraw channel	Minimum single transaction	Maximum single transaction
PIX	10	50,000

Request

Header Params

Body Params application/json

Example

{
    "mchNo": "string",
    "mchOrderNo": "string",
    "wayCode": "string",
    "currency": "string",
    "amount": "string",
    "notifyUrl": "string",
    "customerName": "string",
    "customerEmail": "string",
    "customerContact": "string",
    "customerAccountNumber": "string",
    "bankName": "string",
    "accountTax": "string"
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/payOut/unifiedOrder' \
--header 'X-API-KEY: 02106af2a085fbfc6d1bb49f485205fcdfcc79a4ddb1913c72a271fedd24c2d7fe' \
--header 'X-API-NONCE: 1702279880267' \
--header 'X-API-SIGNATURE: 304502207a4a88a5b0def29b9dbbf8563112d090c0e0b793ff6a5c57fe9d4fd1254d8ecf022100ff63c279f5926069fa1d161598e8d3249cb90e9d728e88e514352cdae6feff72' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mchNo": "string",
    "mchOrderNo": "string",
    "wayCode": "string",
    "currency": "string",
    "amount": "string",
    "notifyUrl": "string",
    "customerName": "string",
    "customerEmail": "string",
    "customerContact": "string",
    "customerAccountNumber": "string",
    "bankName": "string",
    "accountTax": "string"
}'

Responses

🟢200成功

application/json

Body

Example

{
    "code": 0,
    "data": {
        "mchOrderNo": "M1655535407",
        "payOrderId": "P1551409540398772225"
    },
    "msg": "SUCCESS"
}

Modified at 2025-05-29 06:32:57

Query TrxId

Query withdraw order