Checkout Webhook

馃毀

Importante

  • El Checkout Webhook puede ser utilizado 煤nicamente para las llamadas POST de la API de Checkout.
  • Para recibir notificaciones de transacciones realizadas con otros productos Clip, utiliza nuestro Postback Webhook.

驴C贸mo configurar las notificaciones del Checkout Webhook?

Con el Checkout Webhook puedes recibir notificaciones en tiempo real de las transacciones solicitadas a trav茅s de la API de Checkout. Para configurar el webhook, a帽ade la URL del endpoint en donde deseas ser notificado al par谩metro webhook_url en la solicitud crear un link de pago a la API de Checkout. Por ejemplo:

{
"webhook_url": "https://hook.us1.make.com/k5f98kqxuuxgn4td6hgejrnu6lsi362p"
}

Objeto JSON de la notificaci贸n

El objeto JSON de la respuesta de notificaci贸n webhook de la API de Checkout es el siguiente:

{
  "id": "bc631b13-bda7-4473-9181-bc43e04dfa28",
  "api_version": "1.0",
  "payment_request_id": "e1961597-eccd-4bf5-94f3-c343d529caaa",
  "transaction_id": "d9fc7f11-bcf4-44ea-af49-dbb946911fa8",
  "resource": "CHECKOUT",
  "resource_status": "CREATED",
  "detail_type": "Payment Request Created",
  "attempts": 1,
  "sent_date": "2023-02-22T20:28:27Z",
  "created_at": "2023-02-22T20:28:25Z",
  "completed_at": null,
  "expires_at": "2023-02-25T20:28:25Z",
  "canceled_at": null,
  "expired_at": null,
  "declined_at": null,
  "payment_date": null,
  "me_reference_id": "TDP03",
  "receipt_no": null,
  "payment_type": null,
  "barcode": null,
  "customer_email": null
}

Existen dos tipos de resources (recursos):

  • Checkout: Cuando se crea un pago.
  • Refund: Cuando se reembolsa un pago.

Los tipos de status para el recurso checkout son los siguientes:

  • CREATED: Se recibe cuando se crea un link de pago con la API de Checkout.
  • CANCELED: Se recibe despu茅s de 5 intentos de pago no exitosos.
  • EXPIRED: Se recibe cuando el enlace de pago creado con la API de Checkout expira.
  • PENDING: Se recibe despu茅s de que el primer intento de pago es declinado.
  • COMPLETED: Se recibe cuando una transacci贸n es exitosa.

Los tipos de status para el recurso refund (reembolso) son los siguientes:

  • CREATED: Se recibe cuando un cliente disputa un cargo.
  • APPROVED: Se recibe si el reembolso es aprobado.
  • DECLINED: Se recibe si el reembolso es declinado.

Esquema de la notificaci贸n

La siguiente tabla describe los elementos de la notificaci贸n del Checkout Webhook en el orden en el que aparecen en el objeto JSON.

Atributo

Descripci贸n

Tipo

1

id

ID de la notificaci贸n

UUID

2

api_version

Versi贸n de la estructura de la notificaci贸n

String

3

payment_request_id

ID de la solicitud de pago

UUID

4

transaction_id

ID de la transacci贸n

UUID

5

resource

CHECKOUT | REFUND

String

6

resource_status

Para Checkout:

  • CREATED

  • CANCELED

  • EXPIRED

  • PENDING

  • COMPLETED

Para Refund:

  • CREATED

  • APPROVED

  • DECLINED

String

7

detail_type

Descripci贸n de la notificaci贸n

String

8

attempts

N煤mero de intentos para entregar el webhook

Integer

9

sent_date

Fecha de env铆o de la notificaci贸n (1)

String

10

created_at

Fecha de creaci贸n del recurso (1)

String

11

completed_at

Fecha en que el recurso fu茅 completado (1)

String

12

expires_at (2)

Fecha en que expirar谩 el recurso (1)

String

13

cancelled_at (2)

Fecha en que el recurso fue cancelado (1)

String

14

expired_at (2)

Fecha en que exir贸 el recurso (1)

String

15

declined_at

Fecha en que el recurso fue declinado

String

16

payment_date (3)

Fecha de pago (1)

String

17

me_reference_id (4)

Referencia proporcionada por el merchant

String

18

receipt_no (5)

N煤mero de recibo

String

19

payment_type (5)

CARD | CASH

String

20

barcode (6)

Referencia contenida en el c贸digo de barras

 

21

customer_email (6)

Correo del cliente

 


NOTAS

  1. El formato usado para fechas es: 鈥淵YYY-MM-DDTHH:MM:SSZ鈥
  2. 脷nicamente aplica al recurso checkout.
  3. 脷nicamente aplica al recurso reembolso.
  4. El campo mereference_id del objeto metadata s贸lo se regresa si es diferente a _null _o _empty.
  5. 脷nicamente aplica cuando el recurso es CHECKOUT y el campo resource_status es PENDING o COMPLETED.
  6. 脷nicamente aplica cuando el recurso es CHECKOUT y el campo resource_status es PENDING y payment_type es CASH.

馃摌

驴Necesitas Ayuda?

Consulta las preguntas frecuentes y gu铆as de soluci贸n de problemas de nuestro centro de soporte a desarrolladores.
Si tu problema no est谩 documentado, cont谩ctanos por alguno de los siguientes medios:

  • Activa el bot贸n de Ayuda y llena el formulario. No olvides proporcionar un correo electr贸nico y tus dudas para que podamos responder a la solicitud de manera eficiente.
  • Publica tu pregunta en nuestro Foro. Publicar en el foro puede ayudar a otros desarrolladores que est谩n experimentando el mismo problema.
  • Env铆a un correo electr贸nico a la direcci贸n [email protected].

O comun铆cate con nuestra 谩rea de Customer Happiness:

  • Ll谩manos al 55 6393-2323, Clip es el 煤nico con atenci贸n personalizada 24/7 los 365 d铆as del a帽o.
  • Env铆anos un mensaje por WhatsApp al 55 6393-2323.
  • Escr铆benos al correo [email protected].