Search withdrawal transaction by merchant ID
GET/api/withdraws/:merchantId/status
Returns the found withdrawal transaction data.
Request
Path Parameters
merchantId stringrequired
Transaction's merchant id
Responses
- 200
- 400
- 401
- 403
- 404
Successful operation
- application/json
- Schema
- Example (from schema)
Schema
transaction_uuid transaction_uuid (string)
Reference of the QrCode for conciliation
status status (string)
Possible values: [pending
, paid
, canceled
, paid_by_third_party
, failed
, awaiting
, payment rejected
, paid_without_qrcode
, refund_received
]
Transaction status
transaction_type transaction_type (string)
Possible values: [transaction
, withdraw
, refund
]
Transaction type
value value (string)
Value of the transaction
client_document cpf_cnpj (string)
Document of the person who paid or received (CPF or CNPJ)
created_at created_at (string)
Date when the transaction was created
merchant_id merchant_id (string)
Merchant's ID for conciliation
costumer_name costumer_name (string)
Costumer's name
costumer_email costumer_email (string)
Costumer's email
end_to_end_id end_to_end_id (string)
Transaction's pix end_to_end_id
updated_at updated_at (string)
Date when the transaction was last updated
payment_date payment_date (string)
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
message message (integer)
Response 401
{
"message": "Invalid x-api-key"
}
Forbidden
Not Found
Loading...