Cancelar Devolución de Efectivo
En esta documentación encontrarás la guía para realizar una cancelación de una Devolución de Efectivo utilizando todos los recursos de nuestra Direct API.
Requisitos para realizar una cancelación de Devolución de Efectivo
Es necesario que la orden de compra tenga los siguientes requisitos:
- El estado de la devolución tiene que ser pendiente.
- El método de pago de la orden tiene que ser oxxo_cash.
Crear cancelación de devolución
La siguiente solicitud es un ejemplo de cómo crear una cancelación de Devolución de Efectivo, también encontrarás la respuesta de la solicitud.
Necesitarás contar con tu llave privada para poder realizar las solicitudes. Si aún no cuentas con ella, puedes obtenerla en tu Panel Conekta.
curl --location --request DELETE 'https://api.conekta.io/orders/ord_XXXXXXXXXXX/refund/id_devolucion' \
--header 'Accept: application/vnd.conekta-v2.0.0+json' \
--header 'Accept-Language: en' \
--header 'Content-type: application/json' \
--header 'Authorization: Basic YOUR_PRIVATE_API_KEY'
{
"livemode": true,
"amount": 50000,
"currency": "MXN",
"payment_status": "paid",
"amount_refunded": 0,
"customer_info": {
"email": "[email protected]",
"phone": "5555555555",
"name": "User",
"object": "customer_info"
},
"object": "order",
"id": "ord_2tV3dPk9GgaNB9xT8",
"metadata": {},
"is_refundable": true,
"created_at": 1678220457,
"updated_at": 1678220631,
"line_items": {
"object": "list",
"has_more": false,
"total": 1,
"data": [
{
"name": "Box of Cohiba S1s",
"unit_price": 50000,
"quantity": 1,
"object": "line_item",
"id": "line_item_2tV3dPk9GgaNB9xT6",
"parent_id": "ord_2tV3dPk9GgaNB9xT8",
"metadata": {},
"antifraud_info": {}
}
]
},
"charges": {
"object": "list",
"has_more": false,
"total": 1,
"data": [
{
"id": "64079ca9d6014f0001bff56c",
"livemode": true,
"created_at": 1678220457,
"currency": "MXN",
"device_fingerprint": "bQ1LRyesr68DTLXqED6PM6R43zzHxu5A",
"payment_method": {
"service_name": "OxxoPay",
"barcode_url": "https://pt-common-s3-stg.s3.amazonaws.com/b82841dcf44ae5065f8cd0085e61269317a6bf02.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA3UN6375MM6EA7VM7%2F20230307%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230307T202057Z&X-Amz-Expires=604800&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEH0aCXVzLWVhc3QtMSJIMEYCIQCv3Fsz63Um%2B0Vn38NocHbSYpEzsX9VNykWzHoK4F1dBwIhAJLVN3Er61cXAnKlq0Y0jfjEw0t3Sr6OjZFt47EeSnJsKocECDUQAhoMNzk5ODAxMDgxNjg4Igwt0ywP6dVtDG3JpD4q5ANPD4vHJt6zBAwgEgHcccJ3rGJtsLWjGQlRjwO0Ay25REL9VY6LGBvOrHYej1ff2yhER2U80uL8IQ4ye6fo%2FG4v2APZDqT%2FEMkztQQvPJGvH%2FG7LG0vGCZ7B%2B9%2Brg8t%2FUsd2nEA4TDW53bkWj8n7szwx3qu0pguVVkT4gUb6NDpsP81LUVQ2JxRTdk%2BRxkXOZ45A77Xlz2RmZYC9BZD2KCAUomVdZT0h4AaDLkbBMvxpn0JmGBeo6BwzKq4xiAn5qX0Ook%2Bda3ZqIgpcXEZAQABuqjgxtiyORCGEm9DyoNIaMu%2FoQ0ypFpAMCbuGRT%2BcLlsomJK4NuZzB35mr405bAxMO4wsLSa8OnWYMOhesw0q2ImStr8CYG8hI9L%2BwlT5D4UhRIAERCwBz1SentQKIGMjinSidYSRgUj8LT9vIM6txYTkvWXjG1zMoPoIB0KGkGjPeLIQRVG7pRwoEUyzvseeSva%2BKfyzNT1dW33c1aZcfNU%2FPDI%2FwRDPWu6Zl7pOAd1GmIVngJVLpxQ%2BW88EnAw974GmMQ4Su7QUX%2Bre4r3BQWqDfMf1Rm1HM2bWZbtoEd6IDTV%2B7GLfz0s4cuodL4Z3j25%2BMAgROTw1JOnCiR1GBpD6wDqxfq7TLMCS%2BG%2FxpD91nS1MNW1nqAGOqQBWzQ49dZhFndmOPBHzy202Tg6GOVBGG%2B%2BCte7JS4SGWRJyJwY88rlFHLWa475emCKovJrFB9afj9HM77Z1XSi4sUgxLsqTzWCYy22Muvc3ezezssNVKGXWWSKvysBlyw90zx3C6m6v%2Fge%2FLi54d63yFIviHbJnGJYc5AmHZdO8%2Fqx9Goci4qiBRyCEbdCKKFyDenaPjs3hzxrD%2F04%2FD%2Fs%2FL0Qbjc%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=aebed155ad9c2abbc44546fc92363d77f8dfb8f79e893db8ced76ae89bf6c2eb",
"store": "10MON50EDI",
"auth_code": 991466079,
"object": "cash_payment",
"type": "oxxo",
"expires_at": 1680825600,
"store_name": "OXXO",
"reference": "93000262280777"
},
"object": "charge",
"description": "Payment from order",
"status": "paid",
"amount": 50000,
"paid_at": 1678220631,
"fee": 1160,
"customer_id": "cus_2tV3frEGmADZsH31P",
"order_id": "ord_2tV3dPk9GgaNB9xT8",
"refunds": {
"object": "list",
"has_more": false,
"total": 1,
"data": [
{
"object": "cash_refund",
"amount": -50000,
"id": "64079d6bd6014f0001bff582",
"created_at": 1678220651,
"reference": "1021466226004832",
"payout_id": "74c81ffd-07f3-47c6-9b0a-ff7a0330afac",
"status": "cancelled",
"expires_at": 1678393450
}
]
}
}
]
}
}
Parámetros
Consulta de order
Es necesario consultar al servicio de ordenes para parámetros requeridos de la solicitud. Para una orden puedes revisar nuestra REST API ORDERS
IMPORTANTE: Dentro del objeto de Refund, tomar en cuenta el id, este lo tendrás que colocar dentro de la solicitud de cancelación
"refunds": {
"object": "list",
"has_more": false,
"total": 1,
"data": [
{
"object": "cash_refund",
"amount": -4000,
"id": "640a30803a96dc0019fdd3d2"
| Parametro | Descripción | Tipo | Requerido |
|---|---|---|---|
| ord_XXXXXXXXXXX | Numero de orden | String | Si |
| id_devolucion | Id de la devolución que se desea realizar, se encuentra en el atributo refunds como id | String | Si |
El estado de la devolución cambiará de estado pending a canceled, este solo afecta al estado de la devolución.
Notificación
Una vez generada la cancelación de la devolución se enviará a través del webhook configurado el evento cash_refund.canceled y se enviará un correo al usuario para que este enterado que su referencia de devolución fue cancelada.
{
"id": "64079e3bf1b793f46c3d12f3",
"object": "cash_refund",
"amount": -50000,
"currency": "MXN",
"status": "canceled",
"reason": "requested_by_client",
"reference": "1027461102004836",
"payout_order_id": "6515fae6-9f5b-4ac8-967f-1c9fa978a5b8",
"created_at": 1678220859
}
Ejemplo de notificación
Cancelacion
Updated over 1 year ago