PayOut PIX (BRL) h2h

The request contains certain fields:

Field	Description
merchant	unique merchant ID;
method	payout method, integer number: 21 – Payout PIX BRL;
payout_id	the number of the outgoing payment in the merchant’s system;
account	taxpayer Identification Number;
pix_key	PIX user key;
customs_email	customer's e-mail;
full_name	first name, last name of the client. Maximum length 30 characters;
amount	amount of the transaction in currency, separator character is a period “.”;
currency	transaction currency “BRL”;
customs_phone	customer's phone number;
sign	digital signature with the merchant’s key. Available fields are: "merchant", "method", "payout_id", "account", "amount", "currency", "customs_email", "customs_phone", "full_name". Hashed using the MD5 method (for more details read the “Digital signature in requests” section).

POST /merchant/api/payout_send

https://<provided url>
/merchant/api/payout_send

Example of the request:

application/json

{
    "merchant" : "M1VJDHSI6DYXS",
    "method" : 21,
    "payout_id" : "000002",
    "account" : "73859120463",
    "pix_key" : "73859120463",
    "customs_email" : "test@gmail.com",
    "full_name" : "Lorena Garcia",
    "amount" : "102.81",
    "currency" : "BRL",
    "customs_phone" : "+35988222763",
    "sign" : "XXXXXXXXXXXXXXXX"
}

The response contains the fields:

Field	Description
status	transaction status: Success – the payment was made successfully (the status is final) Pending – the payment is new or is in the line for processing. The Pending status requires an additional request (for more details read the “Payment Status Request (payment)” section). Blocked – payment rejected (final status) Error – received data error. The response contains a signature with an empty key (the status is not final and is the basis for finding out the reason of this status);
code	transaction status code;
payout_id	the number of the outgoing payment in the merchant’s system;
description	status description;
sign	digital signature with the merchant’s key.

An example of a response is a Success status:

application/json

{
    "status" : "Success",
    "code" : "0",
    "payout_id" : 000002,
    "description" : "Payment successful. Status final",
    "sign" : "XXXXXXXXXXXXXXXX"
}

An example of a response is the Pending status:

application/json

{
    "status" : "Pending",
    "code" : "40",
    "payout_id" : 000002,
    "description" : "Payment in order",
    "sign" : "XXXXXXXXXXXXXXXX"
}

An example of a response is the Error status:

application/json

{
    "status" : "Error",
    "code" : "99",
    "payout_id" : "",
    "description" : "Sign error",
    "sign" : "XXXXXXXXXXXXXXXX"
}

Final status (callback)

To notify the merchant that the transaction has received the final status (for example, from “Pending” to “Success”), the callback mechanism is used.

For more information read the Callbacks section.