Receipt
Use this endpoint to get the receipt of a withdrawal by its id.
Available Environments
- Production
https://api.gateway.com.br/core
Endpoint
- Method:
POST - Endpoint:
/withdrawal/{id}/receipt - Authentication: Bearer token
Path Params
| Name | Type | Required | Description | Validations |
|---|---|---|---|---|
id | string (UUID) | Yes | Withdrawal identifier | Must be a valid UUID |
Request Example
- cURL
- JavaScript
curl --request POST \
--url https://api.gateway.com.br/core/withdrawal/553e8400-e29b-41d4-a716-436251480000/receipt \
--header 'Authorization: Bearer your-jwt-token'
const response = await fetch('https://api.gateway.com.br/core/withdrawal/553e8400-e29b-41d4-a716-436251480000/receipt', {
method: 'POST',
headers: {
'Authorization': 'Bearer your-jwt-token'
}
});
const data = await response.json();
Success Response
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Withdrawal identifier |
paymentReceiptUrl | string | Yes | URL to download or view the receipt |
expirationDate | string (ISO) | No | Receipt expiration date |
Response Example
{
"id": "553e8400-e29b-41d4-a716-436251480000",
"paymentReceiptUrl": "https://files.exemplo.com.br/receipts/withdrawal-553e8400-e29b-41d4-a716-436251480000.pdf",
"expirationDate": "2026-04-01T00:00:00.000Z"
}
Possible Errors
| Code | Description | Solution |
|---|---|---|
| 401 | Invalid credentials | Check your credentials |
| 403 | No permission/authorization | Contact support |
| 404 | Withdrawal or receipt not found | Check the id you sent |
| 422 | Invalid or missing data | Check the format of the data |
| 500 | Internal error | Contact support |