Payout

Developing

POST

/gateway/base/biz

API Header parameters, API Request parameters, API Response parameters (refer to Transaction-API [PAYOUT-API] public template parameters)，follow is extra parameters

API Request parameters（extra）

Field Code	Field Name	Type	Required	E.g.
beneficiaryAccountNumber	Pix number：should be enter one of CPF/CNPJ/Email/phone/EVP, if enter phone ,please add +55 prefix on the phone,total vlue is +55xxxxxxxxxxx	String	required	demo@gmail.com
docType	Fix Value： PIX	String	required	PIX
docNumber	CPF or CNPJ，required when pixCheck = true	String	optional	79595049468
pixCheck	if value =true ,payout apply need check CPF（docNumber） equal PIX（beneficiaryAccountNumber）,if check there are not the same person informations will rejected this payout apply	Boolean	required	true

Request

Header Params

Body Params application/json

Example

{
    "mchOrderId": "string",
    "amount": "string",
    "currency": "string",
    "purpose": "string",
    "paymentType": "string",
    "beneficiaryName": "string",
    "beneficiaryEmail": "string",
    "beneficiaryMobile": "string",
    "beneficiaryAccountNumber": "string",
    "callbackUrl": "string",
    "docType": "PIX",
    "docNumber": "string",
    "pixCheck": true
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/gateway/base/biz' \
--header 'method: payOut' \
--header 'signType: SHA512' \
--header 'serviceName: api.pay' \
--header 'mchId: 1416010331032883200' \
--header 'timestamp: 1631671670' \
--header 'sign: 32554324534545432543' \
--header 'Content-Type: application/json' \
--data-raw '{
    "mchOrderId": "string",
    "amount": "string",
    "currency": "string",
    "purpose": "string",
    "paymentType": "string",
    "beneficiaryName": "string",
    "beneficiaryEmail": "string",
    "beneficiaryMobile": "string",
    "beneficiaryAccountNumber": "string",
    "callbackUrl": "string",
    "docType": "PIX",
    "docNumber": "string",
    "pixCheck": true
}'

Responses

🟢200Success

application/json

Body

Example

{
    "data": [
        {
            "orderId": "string"
        }
    ],
    "resultCode": "string",
    "errorCode": "string",
    "errorMsg": "string"
}

Modified at 2025-12-05 12:56:10

Payment