Skip to content

Make Pix payment

[POST] https://gateway.paag.dev/api/pix/pay

PIX Key types reference

Key Description
Use a phone number as PIX Key, format: XXYYYYYYYYY.
phone XX - first 2 numbers being the code area
YYYYYYYYY - last 9 numbers being phone itself
document Use a Brazilian document as a key. It could be a CPF or CNPJ document
email Use an email as key. It should be a valid email.
random Use a random token as key.

Body params

Field name Data type Filter type
processor_id string Processor reference responsible for this charge
merchant_transaction_id string Transaction id on the side of the merchant
amount float Decimal value of the amount being charged (in R$)
pix_key_type string The type of the PIX Key being used, see reference above
pix_key_value string The value of PIX Key being used
pix_message string A message that is sent with the PIX Payment
first_name string Receiver's first name
last_name string Receiver's last name
document_number string Receiver's document
email string Receiver's email

Examples

Pix

curl --request POST \
--url https://gateway.paag.dev/api/pix/pay \
--header 'Authorization: Bearer MY_API_TOKEN' \
--header 'accept: application/json' \
--header 'content-type: application/json'

import requests

url = "https://gateway.paag.dev/api/pix/pay"

headers = {
    "accept": "application/json",
    "content-type": "application/json",
    "Authorization": "Bearer MY_API_TOKEN"
}

response = requests.post(url, headers=headers)

print(response.text)
200 - Success 
{

  "transaction": {
    "id": "f74a178e-cee1-4bff-8d80-8738384cc511",
    "merchant_id": "ea6b792b-ccb4-4d32-ba46-b7076c5acc42",
    "user_id": "0b15988e-9501-46a0-92c1-8673b6ca07cf",
    "processor_id": "6268c2a9-047b-475a-a461-0bb9cccaa31c",
    "merchant_transaction_id": "111222333",
    "transaction_type": "pix",
    "first_name": "Testing",
    "last_name": "Paag",
    "email": "dev@gateway.local",
    "updated_at": "2024-02-20T13:35:23+0000",
    "created_at": "2024-02-20T13:35:23+0000",
    "events": [
      {
        "id": "f0936449-3b1b-442f-a58b-d81b8e31f343",
        "success": true,
        "status": "pending_settlement",
        "event_type": "payment",
        "amount": "1.35",
        "ip_address": null,
        "processor_transaction_id": null,
        "batch_id": null,
        "qrcode": null,
        "qrcode_image": null,
        "pix_key_type": "document",
        "pix_key_value": "08476407602",
        "pix_message": "This is a test",
        "updated_at": "2024-02-20T13:35:23+0000",
        "created_at": "2024-02-20T13:35:23+0000"
      }
    ],
    "document_number": "98610246035",
    "status": "pending",
    "flow_type": "cashout",
    "error": null,
    "e2e_id": null
  }
}
401 - Not authenticated 
{
"error": {
    "message": {
    "base": [
        "Not authenticated"
      ]
    },
    "status": 401
  }
}
422 - Insufficient funds on processor 
{
"error": {
    "message": {
    "amount": [
        "Insufficient funds on processor"
    ]
    },
    "status": 422
},
"debug": []
}