Criar uma Transação PIX

POST

/v1/transactions

Última modificação:2025-03-27 19:53:15

Requisição

Parâmetros Bodyapplication/json

Exemplo

{
    "amount": 2000,
    "payment_method":"pix",
    "billing":{
      "name":"LUCILUCI DOS SANTOS",
      "address":{
         "country":"br",
         "street":"Rua Jesuíno Anastácio Pereira",
         "street_number":"665",
         "state":"SC",
         "city":"CAMBORIÚ",
         "neighborhood":"Santa Regina"
      }
    },
    "customer":{
        "name":"LUCILUCI DOS SANTOS",
        "email":"allex@nogue.dev",
        "type":"individual",
        "country":"br",
        "documents":[
            {
                "type":"cnpj",
                "number":""
            }
        ],
        "external_id":"1"
    },
    "shipping":{
        "name":"LUCILUCI DOS SANTOS",
        "fee":"0",
        "address":{
            "street":"Rua Jesuíno Anastácio Pereira",
            "street_number":"665",
            "zipcode":"88345572",
            "country":"br",
            "state":"SC",
            "city":"CAMBORIÚ"
        }
    }
}

Códigos de solicitação

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://prod.your-api-server.com/v1/transactions' \
--header 'Content-Type: application/json' \
--data-raw '{
    "amount": 2000,
    "payment_method":"pix",
    "billing":{
      "name":"LUCILUCI DOS SANTOS",
      "address":{
         "country":"br",
         "street":"Rua Jesuíno Anastácio Pereira",
         "street_number":"665",
         "state":"SC",
         "city":"CAMBORIÚ",
         "neighborhood":"Santa Regina"
      }
    },
    "customer":{
        "name":"LUCILUCI DOS SANTOS",
        "email":"allex@nogue.dev",
        "type":"individual",
        "country":"br",
        "documents":[
            {
                "type":"cnpj",
                "number":""
            }
        ],
        "external_id":"1"
    },
    "shipping":{
        "name":"LUCILUCI DOS SANTOS",
        "fee":"0",
        "address":{
            "street":"Rua Jesuíno Anastácio Pereira",
            "street_number":"665",
            "zipcode":"88345572",
            "country":"br",
            "state":"SC",
            "city":"CAMBORIÚ"
        }
    }
}'

Respostas

🟢200Criar uma Transação

application/json

Body

Examples

Criar uma TransaçãoSucesso

{
    "id": 23,
    "ip_address": "127.0.0.1",
    "tid": null,
    "amount": 15090,
    "capture_amount": 15090,
    "paid_amount": null,
    "payment_type": null,
    "ref_id": "5992873329",
    "status": "processing",
    "created_at": "2022-02-02T18:05:37.000000Z",
    "updated_at": "2022-02-02T18:05:37.000000Z",
    "card": {
        "card_id": 409902444,
        "card_holder_name": "Customer Name",
        "created_at": "2022-02-02T17:47:10.000000Z",
        "updated_at": "2022-02-02T18:05:36.000000Z",
        "card_first_digits": "0000",
        "card_last_digits": "0009",
        "brand": "0",
        "fingerprint": "7b9d48a31a672a58a976da3dbc71e8e8",
        "valid": false
    },
    "pix_qr_code": null,
    "pix_expiration_date": null,
    "pix_additional_fields": null,
    "installments": 1,
    "reference_key": null,
    "session": null,
    "local_time": null,
    "payment_method": "credit_card",
    "customer": {
        "id": 4642,
        "external_id": "1234f",
        "name": "James Bond",
        "type": "individual",
        "country": "br",
        "email": "james@bond.com",
        "birthday": null,
        "phone_numbers": [
            "+5511987654321"
        ],
        "created_at": "2022-02-02T18:05:37.000000Z",
        "updated_at": "2022-02-02T18:05:37.000000Z",
        "documents": [
            {
                "id": 4563,
                "type": "cpf",
                "number": "47009616000"
            }
        ]
    },
    "billing": {
        "id": 4418,
        "name": "Nome do pagador",
        "created_at": "2022-02-02T18:05:37.000000Z",
        "updated_at": "2022-02-02T18:05:37.000000Z",
        "address": {
            "street": "Alamenda Rio Negro",
            "street_number": "500",
            "zipcode": "06454000",
            "country": "br",
            "state": "sp",
            "city": "barueri",
            "neighborhood": "Alphaville",
            "complementary": null
        }
    },
    "shipping": null,
    "items": [
        {
            "id": 8912,
            "external_id": "123",
            "title": "Nome do Produto 1",
            "unit_price": 1590,
            "quantity": 1,
            "tangible": 1,
            "category": null,
            "venue": null,
            "date": null,
            "created_at": "2022-02-02T18:05:37.000000Z",
            "updated_at": "2022-02-02T18:05:37.000000Z"
        }
    ],
    "metadata": null
}

🟠400Erro integração

Modificado em 2025-03-27 19:53:15

Página anterior

Criar uma Transação Com 3DS

Próxima página

Criar uma Transação Boleto