Skip to main content

Get Withdrawal Status

Use this endpoint to get only the status of a specific withdrawal by its id.

The response carries only the id and the status, without the rest of the withdrawal data. When you need the complete record, use Get Withdrawal.

Available Environments​

https://api.gateway.com.br/core

Endpoint​

  • Method: GET
  • Endpoint: /withdrawal/{id}/status
  • Authentication: Bearer token

Path Params​

NameTypeRequiredDescriptionValidations
idstring (UUID)YesWithdrawal identifierMust be a valid UUID

Request Example​

curl --request GET \
--url https://api.gateway.com.br/core/withdrawal/553e8400-e29b-41d4-a716-436251480000/status \
--header 'Authorization: Bearer your-jwt-token'

Success Response​

FieldTypeRequiredDescription
idstring (UUID)YesUnique identifier of the withdrawal
statusstring (enum) - PENDING, PROCESSING, PROCESSED, FAILED, CANCELED, REFUNDED, REJECTED, PENDING_COMPLIANCEYes
  • PENDING: withdrawal created, awaiting processing
  • PROCESSING: withdrawal being processed
  • PROCESSED: withdrawal processed successfully
  • FAILED: error during processing
  • CANCELED: withdrawal canceled
  • REFUNDED: withdrawal refunded
  • REJECTED: withdrawal rejected by the gateway
  • PENDING_COMPLIANCE: withdrawal awaiting compliance review

Response Example​

{
"id": "553e8400-e29b-41d4-a716-436251480000",
"status": "PROCESSED"
}

Possible Errors​

CodeDescriptionSolution
401Invalid credentialsCheck your credentials
403No permission/authorizationContact support
404Record not foundCheck the id you sent
422Invalid or missing dataCheck the format of the data
422ValidationsContact support
500Internal errorContact support