Cancelación y consulta de retiros
Cancelación de la referencia
La cancelación de la referencia la puedes realizar en cualquier momento.
IMPORTANTE:
Una vez realizada la solicitud el cliente no podrá realizar ningún retiro con la referencia entregada.
-H "Accept: application/vnd.conekta-v2.1.0+json" \
-H "Content-type: application/json" \
-u key_YOUR_PRIVATE_API_KEY: \
-X PUT https://api.conekta.io/payout_orders/4468474a-48ed-4732-9f8a-666238eaa0ac/cancel
{
"id": "4468474a-48ed-4732-9f8a-666238eaa0ac",
"amount": 3000,
"currency": "MXN",
"allowed_payout_methods": ["cash"],
"reason": "Referencia de devolución",
"object": "payout_order",
"expires_at": 1624032864,
"metadata": {
"custom_client_id": "12345"
},
"status": "cancelled",
"payouts": [{
"id": "payout_2pwMgf9irhCLzMfCZ",
"amount": 3000,
"currency": "MXN",
"payout_method": {
"object": "payout_method",
"type": "cash"
},
"object": "payout",
"expires_at": 1624032864
}]
}
Parámetros de la cancelación
| Parámetro | Descripción | Tipo |
|---|---|---|
| id | ID de transacción | Guid |
Consulta de una orden de pago
Puedes consultar en cualquier momento el estatus de la transacción, esto se realiza a través de la siguiente consulta:
-H "Accept: application/vnd.conekta-v2.1.0+json" \
-H "Content-type: application/json" \
-u key_YOUR_PRIVATE_API_KEY: \
-X GET https://api.conekta.io/payout_orders/4468474a-48ed-4732-9f8a-666238eaa0ac
{
"id": "",
"amount": 3000,
"currency": "MXN",
"allowed_payout_methods": ["cash"],
"reason": "Referencia de devolución",
"object": "payout_order",
"expires_at": 1624032864,
"metadata": {
"custom_client_id": "12345"
},
"status": "cancelled",
"payouts": [{
"id": "payout_2pwMgf9irhCLzMfCZ",
"amount": 3000,
"currency": "MXN",
"payout_method": {
"object": "payout_method",
"type": "cash"
},
"object": "payout",
"expires_at": 1624032864
}]
}
*Parámetros de la consulta
| Parámetro | Descripción | Tipo |
|---|---|---|
| id | ID de transacción | Guid |
Estatus de transacción
Los siguientes estatus son los disponibles para una transacción:
| Nombre | Descripción |
|---|---|
| open | Estado inicial, cambia inmediatamente a pending apenas se crea la transacción. Si la misma queda en este estado es porque no se pudo crear correctamente y pasar al estado pending, por lo que la referencia no está disponible para ser cobrada. Este estado no admite operaciones sobre la transacción. |
| pending | Transacción creada y pendiente de cobrar. |
| cancelled | Transacción cancelada por el comercio. |
| expired | Transacción expirada. |
| pending_confirmation | Transacción en proceso de confirmar retiro. |
| withdrawn | Transacción exitosa. |
| reversed | Transacción reversada, durante la espera de confirmación de retiro (3 minutos) se recibió una solicitud de reversa. |
Updated 5 months ago