Skip to content

Create Pix Charge

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

Create a new Pix Charge

Body params

Field name Data type Filter type
processor_id string Processor reference responsible for this charge
amount float Decimal value of the amount being charged (in R$)
merchant_transaction_id string Transaction id on the side of the merchant
first_name string First name of the one being charged
last_name string Last name of the one being charged
email string Email address for the one being charged
document_number string Document number for the one being charged. Usually CPF for people and CNPJ for companies.
message string Pix message

Examples

Pix

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

import request

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

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

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

print(response.text)

Responses

200 - Success 
{
    "transaction": {
        "id":"string",
        "merchant_id":"string",
        "user_id":"string",
        "processor_id":"string",
        "merchant_transaction_id":"string",
        "transaction_type":"string",
        "first_name":"string",
        "last_name":"string",
        "email":"string",
        "checkout_url":"string",
        "updated_at":"string",
        "created_at":"string",
        "events": [
            {
                "id": "string",
                "success": "boolean",
                "status":"String",
                "event_type":"string",
                "amount":"string"
                "processor_transaction_id":"string",
                "qrcode":"string",
                "qrcode_image":"string",
                "updated_at":"string",
                "created_at":"string"
            }
        ]
    }
}
401 - Not authenticated 
{
"error": {
    "message": {
    "base": ["Not authenticated"]
    },
    "status": 401
},
"debug": []
}
422 - Unprocessable 
{
"error": {
    "message": {
    "base": ["Unprocessable"]
    },
    "status": 422
},
"debug": []
}