Simulate a deposit by a paid QrCode (ONLY AVAILABLE FOR DEVELOPMENT ENVIRONMENT)
PUT/api/simulates/deposits/:id
This endpoint is only meant for development environment. Simulate a depoist by a paid QrCode in order to help during the integration process.
Request
Path Parameters
id stringrequired
QrCode uuid
Example: 7da0c9af-215e-4625-b484-b8cfc87aaa09
- application/json
Body
required
payer_name payer_name (string)required
Payer's name
payer_document payer_document (string)required
Payer's document (CPF or CNPJ)
account_number account_number (string)required
Payer account's number
account_branch account_branch (string)required
Payer's bank account branch
bank_ispb bank_ispb (string)required
Customer's bank account ISPB. Unlike the 3-digit bank code, the ISPB is an 8-digit internal code of the brazilian financial system used for transactions between banks and fintechs. Click here to check the ISPB of the institutions participating in Pix.
Responses
- 200
- 400
- 401
- 403
- 404
Deposit simulated
QrCode invalid to be simulated
Unauthenticated
- application/json
- Schema
- Example (from schema)
Schema
message message (integer)
Response 401
{
"message": "Invalid x-api-key"
}
Forbidden
QrCode not found
Loading...