Saltar al contenido principal

Consultar Estado del Retiro

Utilice este endpoint para consultar solo el estado de un retiro específico por su id.

La respuesta trae únicamente el id y el status, sin el resto de los datos del retiro. Cuando necesite el registro completo, use Consultar Retiro.

Entornos Disponibles​

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

Endpoint​

  • Método: GET
  • Endpoint: /withdrawal/{id}/status
  • Autenticación: Bearer token

Path Params​

NombreTipoObligatorioDescripciónValidaciones
idstring (UUID)SíIdentificador del retiroDebe ser un UUID válido

Ejemplo de Solicitud​

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

Respuesta Exitosa​

CampoTipoObligatorioDescripción
idstring (UUID)SíIdentificador único del retiro
statusstring (enum) - PENDING, PROCESSING, PROCESSED, FAILED, CANCELED, REFUNDED, REJECTED, PENDING_COMPLIANCESí
  • PENDING: retiro creado, esperando procesamiento
  • PROCESSING: retiro en procesamiento
  • PROCESSED: retiro procesado con éxito
  • FAILED: error en el procesamiento
  • CANCELED: retiro cancelado
  • REFUNDED: retiro reembolsado
  • REJECTED: retiro rechazado por el gateway
  • PENDING_COMPLIANCE: retiro pendiente de análisis de compliance

Ejemplo de Respuesta​

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

Errores Posibles​

CódigoDescripciónSolución
401Credenciales inválidasVerifique sus credenciales
403Sin permiso/autorizaciónContacte al soporte
404Registro no encontradoVerifique el id enviado
422Datos inválidos o faltantesVerifique el formato de los datos
422ValidacionesContacte al soporte
500Error internoContacte al soporte