Guides

Simulador de Pix

Suggest Edits

Disponibilizamos um ambiente de teste abrangente para simular transações de pagamento via Pix. Este simulador é uma ferramenta indispensável para desenvolvedores e testadores, permitindo a exploração e verificação do funcionamento de diferentes tipos de operações de pagamento via Pix em um cenário controlado e seguro.

Tabela de Valores para Teste

Para a simulação de transações via PIX, consideramos dois tipos principais de cenários:

  1. Cenário de Êxito: Neste cenário, a transação é inicialmente configurada com status pending. Logo após, uma simulação automática do pagamento é realizada (normalmente alguns segundos após o pedido ser criado), resultando na mudança do status do pedido para status paid.
  2. Cenário de Falha: Nesta situação, a transação é estabelecida com status failed desde o início.

Para efetivamente testar esses cenários distintos, recomenda-se executar transações com valores diferentes, seguindo as diretrizes abaixo:

🚧

Campos Obrigatórios: Detalhes Importantes

Descubra aqui os campos essenciais necessários para a criação de um pedido.

Valor da Transação PixCenário
Menor ou igual a R$ 500,00Transações até esse montante são processadas com sucesso.
Maior que R$ 500,00Caso de falha. Qualquer operação com esse valor é realizada com falha.

Exemplo de Resposta Simulada

O simulador gerará uma resposta similar que imita o retorno da API em produção. O exemplo a seguir ilustra as informações-chave que você pode esperar ao fazer uma solicitação à API

🚧

Atenção ao comportamento do pedido

Cada cenário resultará em um comportamento específico para o pedido, cobrança e transação.

{  
    "order_id": "order_38CB8096-6259-42FA-A926-16F85F87079A",  
    "external_id": "I7OX98ZP",  
    "closed": true,  
    "items": [  
        {  
            "product_id": "I7OX98ZP_3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "description": "Pesquisa de Débitos - ABC1234",  
            "type": "vehicle_debt",  
            "status": "active"  
        }  
    ],  
    "customer":{
        "name":"Marcos Silveira",
        "phone":"000000000000",
        "email":"[email protected]",
        "document":"0000000000",
        "address":{
            "zip_code":"07241170",
            "line_1":"Rua Santa Elizabeth",
            "line_2":"Apto 1003 Cond. Vicace",
            "state":"SP",
            "city":"Guarulhos"
        }
    },  
    "status": "pending",  
    "created_at": "2023-10-27T16:40:25.361Z",  
    "updated_at": "2023-10-27T16:40:25.361Z",  
    "closed_at": "2023-10-27T16:40:25.361Z",  
    "charges": [  
        {  
            "charge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "code": "ABC1234-I7OX98ZP",  
            "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "status": "pending",  
            "payment_method": "pix",  
            "paid_at": "2023-10-27T16:40:25.361Z",  
            "created_at": "2023-10-27T16:40:25.361Z",  
            "updated_at": "2023-10-27T16:40:25.361Z",  
            "last_transaction": {  
                "transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "transaction_type": "pix",  
                "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "amount": 3000.15,  
                "status": "waiting_payment",  
                "success": true,  
                "pix": {  
                    "qr_code": "00020101021226480019BR.COM.FOOBAR.QRCODE0108A37F...12345678927820 014BR.GOV.BCB.PIX2560sandbox-qrcode.foobar.com.br",
                    "qr_code_url": "<https://api.b2b.usezapay.com.br/v2/payment/transactions/transactions/<transaction_id>/qrcode.png",  
                    "additional_information": [  
                        {  
                            "name": "Quantidade",  
                            "value": "1"  
                        }  
                    ]  
                },  
                "created_at": "2023-10-27T16:40:25.361Z",  
                "updated_at": "2023-10-27T16:40:25.361Z",  
                "gateway_response": null,
                "antifraud_response": null 
            }  
        }  
    ]  
}

{  
    "order_id": "order_38CB8096-6259-42FA-A926-16F85F87079A",  
    "external_id": "I7OX98ZP",  
    "closed": true,  
    "items": [  
        {  
            "product_id": "I7OX98ZP_3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "description": "Pesquisa de Débitos - ABC1234",  
            "type": "vehicle_debt",  
            "status": "active"  
        }  
    ],  
    "customer":{
        "name":"Marcos Silveira",
        "phone":"000000000000",
        "email":"[email protected]",
        "document":"0000000000",
        "address":{
            "zip_code":"07241170",
            "line_1":"Rua Santa Elizabeth",
            "line_2":"Apto 1003 Cond. Vicace",
            "state":"SP",
            "city":"Guarulhos"
        }
    },  
    "status": "paid",  
    "created_at": "2023-10-27T16:40:25.361Z",  
    "updated_at": "2023-10-27T16:40:25.361Z",  
    "closed_at": "2023-10-27T16:40:25.361Z",  
    "charges": [  
        {  
            "charge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "code": "ABC1234-I7OX98ZP",  
            "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "status": "paid",  
            "payment_method": "pix",  
            "paid_at": "2023-10-27T16:40:25.361Z",  
            "created_at": "2023-10-27T16:40:25.361Z",  
            "updated_at": "2023-10-27T16:40:25.361Z",  
            "last_transaction": {  
                "transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "transaction_type": "pix",  
                "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "amount": 3000.15,  
                "status": "waiting_payment",  
                "success": true,  
                "pix": {  
                    "qr_code": "00020101021226480019BR.COM.FOOBAR.QRCODE0108A37F...12345678927820 014BR.GOV.BCB.PIX2560sandbox-qrcode.foobar.com.br",
                    "qr_code_url": "<https://api.b2b.usezapay.com.br/v2/payment/transactions/transactions/<transaction_id>/qrcode.png",  
                    "additional_information": [  
                        {  
                            "name": "Quantidade",  
                            "value": "1"  
                        }  
                    ]  
                },  
                "created_at": "2023-10-27T16:40:25.361Z",  
                "updated_at": "2023-10-27T16:40:25.361Z",  
                "gateway_response": null,
                "antifraud_response": null 
            }  
        }  
    ]  
}

Pagamento com PIX: Sucesso Imediato

Este cenário descreve o comportamento esperado no ambiente simulado da Zapay para um Pedido de Pagamento realizado utilizando o método de pagamento PIX. Neste caso, o pagamento é efetuado e confirmado imediatamente.

❗️

Comportamento esperado utilizando um valor de transação específica

Ao utilizar um valor válido para o cenário, o simulador retornará uma resposta indicando que a transação foi efetuada com sucesso. Este cenário simula uma situação ideal onde o pagamento é feito conforme o valor total devido e é corretamente registrado no sistema.

Comportamento das Entidades

Entidade: Pedido (order)

  • Um pedido de pagamento efetuado via PIX registra todas as informações necessárias. O status inicial será pending, mudando instantaneamente para paid, refletindo a rápida confirmação do pagamento.

Entidade: Cobrança (charge)

  • A criação de um pedido gera uma ou mais cobranças vinculadas, refletindo o valor total do pedido. O status inicial da cobrança será pending, mudando para paid após a transação, indicando que a cobrança foi integralmente paga.

Entidade: Transação (transaction)

  • Ao processar um pagamento via PIX, o simulador reflete a realização imediata da transação. O status da transação começará como waiting_payment, mudando instantaneamente para paid, demonstrando a efetuação e a confirmação imediata do pagamento.

Comportamento Esperado

Após a transação, o ambiente simulado apresentará as seguintes mudanças de estado em suas entidades:

{  
    "order_id": "order_38CB8096-6259-42FA-A926-16F85F87079A",  
    "external_id": "I7OX98ZP",  
    "closed": true,  
    "items": [  
        {  
            "product_id": "I7OX98ZP_3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "description": "Pesquisa de Débitos - ABC1234",  
            "type": "vehicle_debt",  
            "status": "active"  
        }  
    ],  
    "customer":{
        "name":"Marcos Silveira",
        "phone":"000000000000",
        "email":"[email protected]",
        "document":"0000000000",
        "address":{
            "zip_code":"07241170",
            "line_1":"Rua Santa Elizabeth",
            "line_2":"Apto 1003 Cond. Vicace",
            "state":"SP",
            "city":"Guarulhos"
        }
    },  
    "status": "pending",  
    "created_at": "2023-10-27T16:40:25.361Z",  
    "updated_at": "2023-10-27T16:40:25.361Z",  
    "closed_at": "2023-10-27T16:40:25.361Z",  
    "charges": [  
        {  
            "charge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "code": "ABC1234-I7OX98ZP",  
            "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "status": "pending",  
            "payment_method": "pix",  
            "paid_at": "2023-10-27T16:40:25.361Z",  
            "created_at": "2023-10-27T16:40:25.361Z",  
            "updated_at": "2023-10-27T16:40:25.361Z",  
            "last_transaction": {  
                "transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "transaction_type": "pix",  
                "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "amount": 3000.15,  
                "status": "waiting_payment",  
                "success": true,  
                "pix": {  
                    "qr_code": "00020101021226480019BR.COM.FOOBAR.QRCODE0108A37F...12345678927820 014BR.GOV.BCB.PIX2560sandbox-qrcode.foobar.com.br",
                    "qr_code_url": "<https://api.b2b.usezapay.com.br/v2/payment/transactions/transactions/<transaction_id>/qrcode.png",  
                    "additional_information": [  
                        {  
                            "name": "Quantidade",  
                            "value": "1"  
                        }  
                    ]  
                },  
                "created_at": "2023-10-27T16:40:25.361Z",  
                "updated_at": "2023-10-27T16:40:25.361Z",  
                "gateway_response": null,
                "antifraud_response": null 
            }  
        }  
    ]  
}

{  
    "order_id": "order_38CB8096-6259-42FA-A926-16F85F87079A",  
    "external_id": "I7OX98ZP",  
    "closed": true,  
    "items": [  
        {  
            "product_id": "I7OX98ZP_3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "description": "Pesquisa de Débitos - ABC1234",  
            "type": "vehicle_debt",  
            "status": "active"  
        }  
    ],  
    "customer":{
        "name":"Marcos Silveira",
        "phone":"000000000000",
        "email":"[email protected]",
        "document":"0000000000",
        "address":{
            "zip_code":"07241170",
            "line_1":"Rua Santa Elizabeth",
            "line_2":"Apto 1003 Cond. Vicace",
            "state":"SP",
            "city":"Guarulhos"
        }
    },  
    "status": "paid",  
    "created_at": "2023-10-27T16:40:25.361Z",  
    "updated_at": "2023-10-27T16:40:25.361Z",  
    "closed_at": "2023-10-27T16:40:25.361Z",  
    "charges": [  
        {  
            "charge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "code": "ABC1234-I7OX98ZP",  
            "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "status": "paid",  
            "payment_method": "pix",  
            "paid_at": "2023-10-27T16:40:25.361Z",  
            "created_at": "2023-10-27T16:40:25.361Z",  
            "updated_at": "2023-10-27T16:40:25.361Z",  
            "last_transaction": {  
                "transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "transaction_type": "pix",  
                "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "amount": 3000.15,  
                "status": "waiting_payment",  
                "success": true,  
                "pix": {  
                    "qr_code": "00020101021226480019BR.COM.FOOBAR.QRCODE0108A37F...12345678927820 014BR.GOV.BCB.PIX2560sandbox-qrcode.foobar.com.br",
                    "qr_code_url": "<https://api.b2b.usezapay.com.br/v2/payment/transactions/transactions/<transaction_id>/qrcode.png",  
                    "additional_information": [  
                        {  
                            "name": "Quantidade",  
                            "value": "1"  
                        }  
                    ]  
                },  
                "created_at": "2023-10-27T16:40:25.361Z",  
                "updated_at": "2023-10-27T16:40:25.361Z",  
                "gateway_response": null,
                "antifraud_response": null 
            }  
        }  
    ]  
}

Pagamento com PIX: Falha na Transação

Este cenário aborda a situação no ambiente simulado da Zapay onde um pedido de pagamento é realizado utilizando o PIX, mas a transação falha.

📌

Comportamento esperado utilizando um valor de transação específica

Ao utilizar um valor válido para o cenário, o simulador retornará uma resposta indicando que a transação foi efetuada com sucesso. Este cenário simula uma situação ideal onde o pagamento é feito conforme o valor total devido e é corretamente registrado no sistema.

Comportamento das Entidades

Entidade: Pedido (order)

  • Um pedido de pagamento efetuado via PIX registra todas as informações necessárias. O status inicial será pending, mudando instantaneamente para failed após a transação.

Entidade: Cobrança (charge)

  • A criação de um pedido gera uma ou mais cobranças vinculadas, refletindo o valor total do pedido. O status inicial da cobrança será pending, mudando para failed após a transação.

Entidade: Transação (transaction)

  • As transações geradas pelo PIX começam com o status waiting_payment. O status muda para failed, refletindo a falha no processo de pagamento.

Comportamento Esperado

Após a transação, o ambiente simulado apresentará as seguintes mudanças de estado em suas entidades:

{  
    "order_id": "order_38CB8096-6259-42FA-A926-16F85F87079A",  
    "external_id": "I7OX98ZP",  
    "closed": true,  
    "items": [  
        {  
            "product_id": "I7OX98ZP_3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "description": "Pesquisa de Débitos - ABC1234",  
            "type": "vehicle_debt",  
            "status": "active"  
        }  
    ],  
    "customer":{
        "name":"Marcos Silveira",
        "phone":"000000000000",
        "email":"[email protected]",
        "document":"0000000000",
        "address":{
            "zip_code":"07241170",
            "line_1":"Rua Santa Elizabeth",
            "line_2":"Apto 1003 Cond. Vicace",
            "state":"SP",
            "city":"Guarulhos"
        }
    },  
    "status": "pending",  
    "created_at": "2023-10-27T16:40:25.361Z",  
    "updated_at": "2023-10-27T16:40:25.361Z",  
    "closed_at": "2023-10-27T16:40:25.361Z",  
    "charges": [  
        {  
            "charge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "code": "ABC1234-I7OX98ZP",  
            "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "status": "pending",  
            "payment_method": "pix",  
            "paid_at": "2023-10-27T16:40:25.361Z",  
            "created_at": "2023-10-27T16:40:25.361Z",  
            "updated_at": "2023-10-27T16:40:25.361Z",  
            "last_transaction": {  
                "transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "transaction_type": "pix",  
                "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "amount": 3000.15,  
                "status": "waiting_payment",  
                "success": true,  
                "pix": {  
                    "qr_code": "00020101021226480019BR.COM.FOOBAR.QRCODE0108A37F...12345678927820 014BR.GOV.BCB.PIX2560sandbox-qrcode.foobar.com.br",
                    "qr_code_url": "<https://api.b2b.usezapay.com.br/v2/payment/transactions/transactions/<transaction_id>/qrcode.png",  
                    "additional_information": [  
                        {  
                            "name": "Quantidade",  
                            "value": "1"  
                        }  
                    ]  
                },  
                "created_at": "2023-10-27T16:40:25.361Z",  
                "updated_at": "2023-10-27T16:40:25.361Z",  
                "gateway_response": null,
                "antifraud_response": null 
            }  
        }  
    ]  
}

{  
    "order_id": "order_38CB8096-6259-42FA-A926-16F85F87079A",  
    "external_id": "I7OX98ZP",  
    "closed": true,  
    "items": [  
        {  
            "product_id": "I7OX98ZP_3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "description": "Pesquisa de Débitos - ABC1234",  
            "type": "vehicle_debt",  
            "status": "active"  
        }  
    ],  
    "customer":{
        "name":"Marcos Silveira",
        "phone":"000000000000",
        "email":"[email protected]",
        "document":"0000000000",
        "address":{
            "zip_code":"07241170",
            "line_1":"Rua Santa Elizabeth",
            "line_2":"Apto 1003 Cond. Vicace",
            "state":"SP",
            "city":"Guarulhos"
        }
    },  
    "status": "failed",  
    "created_at": "2023-10-27T16:40:25.361Z",  
    "updated_at": "2023-10-27T16:40:25.361Z",  
    "closed_at": "2023-10-27T16:40:25.361Z",  
    "charges": [  
        {  
            "charge_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "code": "ABC1234-I7OX98ZP",  
            "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
            "amount": 3000.15,  
            "status": "failed",  
            "payment_method": "pix",  
            "paid_at": "2023-10-27T16:40:25.361Z",  
            "created_at": "2023-10-27T16:40:25.361Z",  
            "updated_at": "2023-10-27T16:40:25.361Z",  
            "last_transaction": {  
                "transaction_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "transaction_type": "pix",  
                "gateway_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",  
                "amount": 3000.15,  
                "status": "failed",  
                "success": true,  
                "pix": {  
                    "qr_code": "00020101021226480019BR.COM.FOOBAR.QRCODE0108A37F...12345678927820 014BR.GOV.BCB.PIX2560sandbox-qrcode.foobar.com.br",
                    "qr_code_url": "<https://api.b2b.usezapay.com.br/v2/payment/transactions/transactions/<transaction_id>/qrcode.png",  
                    "additional_information": [  
                        {  
                            "name": "Quantidade",  
                            "value": "1"  
                        }  
                    ]  
                },  
                "created_at": "2023-10-27T16:40:25.361Z",  
                "updated_at": "2023-10-27T16:40:25.361Z",  
                "gateway_response": null,
                "antifraud_response": null 
            }  
        }  
    ]  
}

Updated 9 months ago