Update a transaction status (ONLY AVAILABLE FOR DEVELOPMENT ENVIRONMENT)
PUT/api/transactions
This endpoint is only meant for development environment. Update the status of a transaction to
* trigger the receipt of webhooks for testing purposes.
Request
- application/json
Body
required
Reference of the Transaction
Possible values: [pending
, paid
, awaiting
, on_hold
, failed
]
Transaction status
Responses
- 200
- 400
- 401
- 403
- 404
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
Reference of the QrCode for conciliation
Possible values: [pending
, paid
, canceled
, paid_by_third_party
, failed
, awaiting
, payment rejected
, paid_without_qrcode
, refund_received
]
Transaction status
Possible values: [transaction
, withdraw
, refund
]
Transaction type
Value of the transaction
Document of the person who paid or received (CPF or CNPJ)
Date when the transaction was created
Merchant's ID for conciliation
Costumer's name
Costumer's email
Transaction's pix end_to_end_id
Date when the transaction was last updated
Date when the transaction was confirmed as paid
{
"transaction_uuid": "7da0c9af-215e-4625-b484-b8cfc87aaa09",
"status": "pending",
"transaction_type": "withdraw",
"value": "10.00",
"client_document": "80064671020",
"created_at": "2023-06-13T13:42:31.000000Z",
"merchant_id": "123456",
"costumer_name": "Johnny Georgios",
"costumer_email": "johnny@gmail.com",
"end_to_end_id": "E0000000020230613111111aaaaa1111",
"updated_at": "2023-06-13T13:42:31.000000Z",
"payment_date": "2023-06-13 03:00:00.000"
}
Bad Request
Unauthenticated
- application/json
- Schema
- Example (from schema)
Schema
Response 401
{
"message": "Invalid x-api-key"
}
Forbidden
Not found