Autorização
Header de autenticação da chamada do Cashin
Ao receber a chamada de autorização, você receberá o seguinte header:
Header | Descrição |
---|---|
Authorization | Cabeçalho de autorização do tipo basic utilizado para enviar as credenciais previamente cadastradas para a autorização. |
Payloads recebidos
Request de Recebimento
{
"RequestBody": {
"amount": 30,
"debitParty": {
"bank": "13935893",
"taxId": "12345678900",
"accountType": "TRAN",
"name": "Fulano de tal",
"personType": "NATURAL_PERSON",
"branch": "0001",
"account": "12345678"
},
"TransactionType": "PAYMENT",
"vldnAmount": 0,
"taxIdPaymentInitiator": "",
"endToEndId": "E2085587520240626181743549541065",
"paymentType": "IMMEDIATE",
"initiationType": "DYNAMIC_QRCODE",
"transactionType": "TRANSFER",
"Tenant": "**PRIVATE**",
"urgency": "HIGH",
"transactionIdBRCode": 1010557027,
"creditParty": {
"bank": "13935893",
"taxId": "12345678900",
"accountType": "TRAN",
"personType": "LEGAL_PERSON",
"branch": "0001",
"account": "12345678",
"key": "[email protected]"
},
"vlcpAmount": 0,
"entity": "PixPayment",
"transactionIdentification": "kk6g232xel65a0daee4dd13kk12345678"
}
}
Request de Recebimento de Devolução
{
"RequestBody": {
"transactionType": "PixReversal",
"amount": 100,
"ReturnIdentification": "D9999999920240626181354593816158",
"Tenant": "",
"OriginalEndToEndId": "E13935893202406261720wwwwww",
"ClientCode": "teste",
"entity": "PixReversal",
"TransactionId": 123456789
}
}
Exemplo de resposta de autorização
Para que seja identificada a resposta da autorização, deve ser respondida a requisição com o HTTP Code de classe 200, com o corpo da resposta conforme os exemplos abaixo:
Aprovar CashIn
{
"Status": "ACCEPTED",
"ApprovalId": "2f554972-6bbe-446a-91f8-f83fc42b3516"
}
Negar CashIn
{
"Status": "DENIED",
"ApprovalId": "d1cf47c8-ad30-40da-a556-959237fa0e2d",
"ReasonPhrase": "The order was rejected by the bank side (for reasons concerning content)",
"ReasonCode": "DS04",
"Reason": "OrderRejected"
}
Importante: é necessário retornar uma resposta de autorização em até 1,5s (um segundo e meio), caso contrário, o cashin será automaticamente rejeitado.
Campos do response
Campo | Tipo | Exemplo | Obrigatoriedade | Informação adicional |
---|---|---|---|---|
ApprovalId | GUID | - | Campo Obrigatório | |
Status | Enum | ACCEPTED DENIED | Campo Obrigatório | ACCEPTED (aprovar o cashin) DENIED (negar o cashin) |
Reason | String | - | Campo não obrigatório* *será obrigatório somente quando o status for DENIED | |
reasonPhrase | String | Campo não obrigatório* *será obrigatório somente quando o status for DENIED | - | |
reasonCode | String | Campo não obrigatório* *será obrigatório somente quando o status for DENIED |
Tabela de erros (reason code) na negação da (DENIED) Autorização do Pix Cashin
reasonCode | Reason | Descrição |
---|---|---|
AC07 | ClosedCreditorAccountNumber | Creditor account number closed |
AB09 | ErrorCreditorAgent | Transaction stopped due to error at the Creditor Agent. |
AC03 | InvalidCreditorAccountNumber | Creditor account number invalid or missing |
AC06 | BlockedAccount | Account specified is blocked, prohibiting posting of transactions against it. |
AC14 | InvalidCreditorAccountType | Creditor account type missing or invalid |
AG03 | TransactionNotSupported | Transaction type not supported/authorized on this account |
AM09 | WrongAmount | Amount received is not the amount agreed or expected |
BE01 | InconsistenWithEndCustomer | Identification of end customer is not consistent with associated account number. (formerly CreditorConsistency). |
CH11 | CreditorIdentifierIncorrect | Value in Creditor Identifier is incorrect |
DS04 | OrderRejected | The order was rejected by the bank side (for reasons concerning content) |
DT05 | InvalidCutOffDate | Associated message, payment information block or transaction was received after agreed processing cut-off date, i.e., date in the past. |
ED05 | SettlementFailed | Settlement of the transaction has failed |
Updated 2 months ago