Depois de criar um caixa na transação do OpenFinance, é possível simular sua transição para os estados finais usando a interface do usuário fornecida, como visto no Guia sobre PIX e OpenFinance. Porém, também é possível simular esses estados usando chamadas de API.
Essas transições acionam chamadas de webhook e permitem que você teste adequadamente as chamadas de eventos assíncronos.
Se você não estiver familiarizado com nossa abordagem de webhook para atualizações assíncronas, consulte a seção Eventos Assíncronos.
A seguir, apresentamos um conjunto de exemplos de solicitações úteis para ajudá-lo a conseguir isso.
Conclusão da transação
Endpoint de referência
POST /sandbox/payment-initiation/complete/{transactionId}
Este endpoint permite simular o pagamento bem-sucedido de uma transação PIX, fornecendo o transactionId criado. Para os exemplos abaixo, considere o ID da transação 3fd0770b-6796-40ea-9820-d98b786bf1e5.
- Resposta da Request (
200 - OK)
{
"statusCode": "Done",
"data": {
"transactionId": "3fd0770b-6796-40ea-9820-d98b786bf1e5",
"transactionState": "Completed"
}
}
- Payload de Evento Webhook
{
"id": "3fd0770b-6796-40ea-9820-d98b786bf1e",
"transactionState": "Completed",
"transactionDate": "2023-08-04T14:45:34.150Z",
"transactionOrderId": "in-1414870875-158709817091784",
"transactionOrderDescription": "This is a test order.",
"transactionReceipt": "https://api.sandbox.pagfast.com/v1/system/e-receipt/4494a26c-4f21-400a-bbe7-cbef6ea7c3c3/receipt.pdf",
"transactionReceiptDate": "2023-08-04T14:45:39.047Z",
"transactionReceiptVoucher": "D6BE9C802C7846029269C485FE23060C",
"transactionAmount": "50.000000",
"transactionType": "Credit",
"transactionPaymentType": "PIX",
"stateRegisteredDate": "2023-08-04T14:45:34.332Z",
"stateCompletedDate": "2023-08-04T14:45:39.150Z",
"stateCancelledDate": null,
"stateRefundDate": null,
"stateReversedDate": null,
"stateErrorDate": null,
"stateErrorCause": null,
"webhookUrl": "https://postman-echo.com/post?test=1",
"payer": {
"name": "CRISTINA INACIO OLIVEIRA DA CONCEICAO",
"taxNumber": "14435549603",
"bankCode": "999",
"bankName": null,
"accountAgency": "99999",
"accountNumber": "99999",
"accountDigit": "9"
},
"recipient": {
"name": "Pagfast Cobrança e Serviço em Tecnologia Ltda",
"taxNumber": "46261360000148",
"bankCode": "999",
"bankName": "SANDBOX",
"accountAgency": "99999",
"accountNumber": "99999",
"accountDigit": "9"
}
}
Erro de Transação
Endpoint de referência
POST /sandbox/payment-initiation/error/{transactionId}
Este endpoint permite simular um erro no pagamento de uma transação PIX, fornecendo o transactionId criado. Para os exemplos abaixo, considere o id da transação fabb7587-523e-43b8-9b6a-ac4a5679f9bd.
- The Request Response (
200 - OK)
{
"statusCode": "Done",
"data": {
"transactionId": "fabb7587-523e-43b8-9b6a-ac4a5679f9bd",
"transactionState": "Error",
"stateErrorCause": "PaymentProcessingError"
}
}
- The Webhook Event Payload
{
"id": "4494a26c-4f21-400a-bbe7-cbef6ea7c3c3",
"transactionState": "Error",
"transactionDate": "2023-08-04T14:45:39.150Z",
"transactionOrderId": "in-1414870875-158709817091784",
"transactionOrderDescription": "This is a test order.",
"transactionReceipt": null,
"transactionReceiptDate": null,
"transactionReceiptVoucher": null,
"transactionAmount": "50.000000",
"transactionType": "Credit",
"transactionPaymentType": "PIX",
"stateRegisteredDate": "2023-08-04T14:45:34.332Z",
"stateCompletedDate": null,
"stateCancelledDate": null,
"stateRefundDate": null,
"stateReversedDate": null,
"stateErrorDate": "2023-08-04T14:45:39.150Z",
"stateErrorCause": "PaymentProcessingError",
"webhookUrl": "https://postman-echo.com/post?test=1",
"payer": null,
"recipient": null,
}