Brazil-BRL

POST

/trade/payout/unifiedorder

PAYOUT

💡

When integrating the Brazilian channel, the relationship between accountNo and bank

When bank=PIX type [CPF/CNPJ/PHONE/EMAIL] the accountNo field value is the value of the corresponding type
For example:

bank	accountNo
CPF	Private tax number (11-digit pure numeric string, no formatted tax number required)
CNPJ	Enterprise tax number Tax number (14-digit pure numeric string, no formatted tax number required)
PHONE	11-digit mobile phone number
EMAIL	email

Request

Body Params application/json

payee

object

required

bank

enum<string>

PIX Type

required

PIX Type

Allowed values:

CPFCNPJPHONEEMAIL

accountNo

string

Receive account

required

For Example: When bank=CPF, accountNo => Private tax number (11 digits) When bank=CNPJ, accountNo => Corporate tax number (14 digits), when bank=PHONE, accountNo => 11 digits mobile phone number bank= When EMAIL, accountNo => Email

accountName

string

Receive account name

required

bankCode

string | null

No need to fill in

optional

phone

string | null

No need to fill in

optional

tradeAmount

integer

Trade Amount

required

Note: The unit is cents. For example, placing an order in legal currency (Brazilian Real) 100 = 1 BRL

channelCode

string

Channel Code

required

Please log in to the merchant management backend to view

outTradeNo

string

Merchant Trade No

required

notifyUrl

string

Callback URL

optional

attrch

string

Additional Information

optional

It will be returned as it is when called back.

Example

// CPF
{
    "payee": {
        "accountNo": "14414455123",
        "accountName": "Jack",
        "bank": "CPF",
        "bankCode": null,
        "phone": null
    },
    "tradeAmount": 10000,
    "outTradeNo": "346234624562342342",
    "channelCode": "1111",
    "attrch": "Additional Information",
    "notifyUrl": "http://qydayotghr.gp/biltdna"
}

// CNPJ
{
    "payee": {
        "accountNo": "42331134554422",
        "accountName": "Jack",
        "bank": "CNPJ",
        "bankCode": null,
        "phone": null
    },
    "tradeAmount": 10000,
    "outTradeNo": "346234624562342342",
    "channelCode": "1111",
    "attrch": "Additional Information",
    "notifyUrl": "http://qydayotghr.gp/biltdna"
}

// PHONE
{
    "payee": {
        "accountNo": "13133334333",
        "accountName": "Jack",
        "bank": "PHONE",
        "bankCode": null,
        "phone": null
    },
    "tradeAmount": 10000,
    "outTradeNo": "346234624562342342",
    "channelCode": "1111",
    "attrch": "Additional Information",
    "notifyUrl": "http://qydayotghr.gp/biltdna"
}

// EMAIL
{
    "payee": {
        "accountNo": "example@gmail.com",
        "accountName": "Jack",
        "bank": "EMAIL",
        "bankCode": null,
        "phone": null
    },
    "tradeAmount": 10000,
    "outTradeNo": "346234624562342342",
    "channelCode": "1111",
    "attrch": "Additional Information",
    "notifyUrl": "http://qydayotghr.gp/biltdna"
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/trade/payout/unifiedorder' \
--header 'Content-Type: application/json' \
--data-raw '// CPF
{
    "payee": {
        "accountNo": "14414455123",
        "accountName": "Jack",
        "bank": "CPF",
        "bankCode": null,
        "phone": null
    },
    "tradeAmount": 10000,
    "outTradeNo": "346234624562342342",
    "channelCode": "1111",
    "attrch": "Additional Information",
    "notifyUrl": "http://qydayotghr.gp/biltdna"
}

// CNPJ
{
    "payee": {
        "accountNo": "42331134554422",
        "accountName": "Jack",
        "bank": "CNPJ",
        "bankCode": null,
        "phone": null
    },
    "tradeAmount": 10000,
    "outTradeNo": "346234624562342342",
    "channelCode": "1111",
    "attrch": "Additional Information",
    "notifyUrl": "http://qydayotghr.gp/biltdna"
}

// PHONE
{
    "payee": {
        "accountNo": "13133334333",
        "accountName": "Jack",
        "bank": "PHONE",
        "bankCode": null,
        "phone": null
    },
    "tradeAmount": 10000,
    "outTradeNo": "346234624562342342",
    "channelCode": "1111",
    "attrch": "Additional Information",
    "notifyUrl": "http://qydayotghr.gp/biltdna"
}

// EMAIL
{
    "payee": {
        "accountNo": "example@gmail.com",
        "accountName": "Jack",
        "bank": "EMAIL",
        "bankCode": null,
        "phone": null
    },
    "tradeAmount": 10000,
    "outTradeNo": "346234624562342342",
    "channelCode": "1111",
    "attrch": "Additional Information",
    "notifyUrl": "http://qydayotghr.gp/biltdna"
}'

Responses

🟢200成功

application/json

Body

code

integer

required

data

object

required

receive

object

required

amount

object

Amount Info

required

tradeNo

string

Platform Trade No

required

Trade No

outTradeNo

string

Merchant Trade No

required

Merchant Trade No

tradeStatus

enum<string>

Trade Status

required

Trade Status

Allowed values:

PROCESSINGSUCCESSFAIL

attach

string

Additional Information

optional

msg

string

required

Example

{
  "code": 0,
  "data": {
    "receive": {
      "bankCode": null,
      "bank": "CPF",
      "accountName": "JACK",
      "accountNo": "13123454311"
    },
    "amount": {
      "tradeAmount": 10000,
      "currency": "BRL",
      "digits": 2
    },
    "tradeNo": "1582677551840301056",
    "tradeStatus": "PROCESSING",
    "outTradeNo": "7727d8d2f01a4273b0643e2862423a82",
    "attach": null
  },
  "msg": ""
}

Modified at 2023-09-18 19:22:38

India-INR

Blockchain-USDT