Pix

How to use Pix to submit a payout in Brazil.

Submit a payout by PIX in Brazil.

POST https://sandbox.transfersmile.com/api/payout

This endpoint allows you to submit a payout by PIX in Brazil.

Headers

Name	Type	Description
Content-Type*	string	application/json; chartset=UTF-8
AppId*	string	Your App ID in payout platform
Authorization*	string	SHA256($sorted_params + $app_key)

Request Body

Name	Type	Description
name*	string	Beneficiary's name - Length between 5 and 100 - When document_id = CPF The name field only supports English alphabet characters (A–Z, a–z) and spaces. When document_id = CNPJ The name field supports: English alphabet characters (A–Z, a–z) Numbers (0–9) Dot (.) Hyphen (-) Spaces
phone	string	Beneficiary's phone - 0 ~ 15 digits -
email	string	Beneficiary's email
document_id*	string	Beneficiary's personal identification number
account*	string	Beneficiary's PIX account
account_type*	string	Beneficiary's PIX account type - One of: CPF, CNPJ, EVP, PHONE, EMAIL -
method*	string	Fixed value: PIX
custom_code*	string	Merchant Payout ID - Max. 50 chars -
fee_bear*	string	Processing fee charges to merchant or beneficiary. - One of: merchant beneficiary -
amount*	number	Payout Amount, 2 decimal numbers - Min 0.01, Max 50,000 -
source_currency*	string	Merchant Account Currency - One of: USD, EUR, GBP, BRL -
arrival_currency*	string	Fixed value: BRL
notify_url*	string	Where pagsmile will send notification to.
additional_remark*	string	Descriptor on the user's bank bill - Max length: 40 -
country*	string	BRA for Brazil
document_type*	string	Beneficiary's personal identification type - One of: CPF, CNPJ -
amount_type	String	Specify the amount value is fixed for merchant or beneficiary - One of: source_amount, arrival_amount(default) -

200: OK submit successfully

{
    "code": 200,
    "msg": "success",
    "time": 1628580845,
    "data": {
        "id": "TS202108100734054iRiUZFPXfQM",
        "custom_code": "custom_code9982674851738108",
        "arrival_amount": "0.51",
        "arrival_currency": "BRL",
        "source_amount": "0.07",
        "source_currency": "USD",
        "status": "IN_PROCESSING"
    }
}

401: Unauthorized unauthorized

400: Bad Request order already existed

500: Internal Server Error system error

500: Internal Server Error balance insufficient

500: Internal Server Error fee not configured

Example

curl --location --request POST 'https://sandbox.transfersmile.com/api/payout' \
--header 'AppId: 94FAC**********************68548' \
--header 'Authorization: d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302' \
--header 'Content-Type: application/json' \
--data-raw '{
    * "name": "GUILHERME ****** SOUZA",
      "phone": "",
      "email": "[email protected]",
    * "amount": 150,
    * "arrival_currency": "BRL", // fixed value: BRL
    * "custom_code" : "custom_code_your_order_id",
    * "document_id": "22*******99",
    * "document_type": "CPF",
    * "fee_bear": "merchant",
    * "method": "PIX",   // fixed value: PIX
    * "notify_url": "https://notify.url",
    * "account": "22*******99",
    * "account_type": "CPF",  // should be one of CPF CNPJ PHONE EMAIL EVP
    * "source_currency": "BRL", 
    * "additional_remark": "pagsmile payout test remark",
    * "country": "BRA" // fixed value: BRA
}'

Note: 94FAC*********************68548 is Pagsmile's test App ID for sandbox, and d6181db0d6548b94b162e75d095b59147172d914699f83b2bd17951a671b6302 is authorization token associated with the test App ID.

Example of Document

Document Type	Document ID	Description
CPF	22*******99	11 digits
CNPJ	23**********31	14 digits

Third-party CPF/CNPJ Validator

• Go: https://github.com/paemuri/brdoc

• JavaScript: https://www.npmjs.com/package/cpf-cnpj-validator

• Online: https://4app.net/tools/validator/document/cpf_validator

Example of PIX account

Account Type	Account	Description
CPF	22*******99	11 digits
CNPJ	23**********31	14 digits
Phone	[phone] or 11987654321	country code (+55) is optional
Email	[email protected]
EVP	A UUID-like string: a1073db4-a3a0-11ed-a8fc-0242ac120002	alphanumeric string of 32 digits that is sent from the central bank to the institution