Deposit PIX (BRL) h2h

Initial request

The request contains certain fields:

Field	Description
type	transaction type (PIX);
merchant	unique merchant ID;
order	transaction number in the merchant system;
amount	transaction amount in the currency, separator character is a point “.”;
currency	transaction currency, may take BRL;
item_name	goods name;
country	customer’s country in the ISO 3166-1 alpha-2 format;
custom	additional information about the client;
ip	customer's IP address;
first_name	customer’s name. Maximum length is 30 characters (Only Latin chars are available);
last_name	customer’s surname (Only latin chars are available);
email	customer's e-mail;
phone	customer's phone number;
cpf	Client’s CPF Only 11 digits are accepted, without spaces or any other characters. (Only for PIX payment method);
payment_url	url address of the site in whose favor the payment is made;
sign	digital signature with the merchant’s key. Available fields are: “type”, “merchant”, “order”, “amount”, “currency” are used. It is hashed using the SHA256 method. (for more details read the “Digital signature in requests” section).

POST /api/h2hpix

https://<provided url>/api/h2hpix

Example:

application/json

{
    "type": "pix",
    "merchant": "M1VJDHSI6DYXS",
    "order": "125327341124",
    "amount": "123.45",
    "currency": "BRL",
    "item_name": "test",
    "country": "BR",
    "custom": "test",
    "ip": "127.0.0.1",
    "first_name": "JOHN",
    "last_name": "SMITH",
    "email": "test@gmail.com",
    "phone": "+35988222763",
    "cpf": "xxxxxxxxxxxxxxxxxx",
    "payment_url": "http://test.com",
    "sign": "XXXXXXXXXXXXXXXXXX"
}

If the data is successfully received (for further payment), the response contains the fields:

Field	Description
status	transaction status (pending);
merchant	unique merchant ID;
order	transaction number in the merchant system (the same as in the request);
uuid	unique transaction ID, use it to search or to contact tech support (if necessary);
co_inv_id	unique transaction number;
qr_code	string containing the payment address;
img	base64 encoded string view of qr code image.

Example of the response:

application/json

{
    "status": "pending",
    "merchant": "QZLF99CVT3WMF",
    "order": "125327341124",
    "uuid": "P1FMNCQDPGI0O",
    "co_inv_id": 15356471,
    "qr_code": "0002012682...A0D28263049620",
    "img": "iVBORw0KGg...UVORK5CYII="
}

If the payment is canceled, the response contains certain fields:

Field	Description
status	transaction status (error);
code	error code;
description	error description;

Example of the response:

application/json

{
    "status": "error",
    "code": "10",
    "description": "The order is already in the system. Request a status."
}