TRtrytoku
Efectivo

Crear Referencia Pagos Referenciados

Changed on

Genera la Referencia con la que un Customer paga en BBVA.

Devuelve la referencia numérica y el número de convenio CIE que el Customer informa al pagar, junto con el monto y la fecha de expiración cuando la configuración de recaudación de la Organization los usa. Pedirla dos veces con los mismos datos devuelve la Referencia que ya existe en vez de crear otra, así que reintentar es seguro.

Qué campos aplican depende del algoritmo de referencia configurado para la Organization: amount y expiration_date son obligatorios en algunas configuraciones, se ignoran en otras y en otras se rechazan. Los errores 400 indican cuál de esos casos aplica.

post/referenced-payment-mx/public/reference

Request

  • Base URL
    https://api.trytoku.com
  • URL
    https://api.trytoku.com/referenced-payment-mx/public/reference
  • Auth
    API key in header x-api-key

Request body

additional_metadataobject nullable

Metadatos adicionales opcionales que se asocian a la Referencia.

expiration_datestring date nullable

Fecha a partir de la cual la Referencia deja de aceptar pagos. Su uso depende de la configuración de recaudación de la Organization; en algunas configuraciones no está permitida.

id_customerstring required

Identificador del Customer para el que se genera la Referencia.

Example request

{
  "additional_metadata": {
    "id_contrato": "A-4471",
    "sucursal": "Polanco"
  },
  "expiration_date": "2026-12-31",
  "id_customer": "cus_9Fh2kLm0QpXr7Zt3Wv1Nb8Yc4Ad6Ge5J"
}

Response

Successful Response

account_identifierstring required

Número de convenio CIE de BBVA al que queda asociada la Referencia.

expiration_datestring date nullable

Fecha a partir de la cual la Referencia deja de aceptar pagos, si aplica.

referencestring required

Referencia numérica que el Customer informa al pagar.

Example response

{
  "account_identifier": "1418930",
  "expiration_date": "2026-12-31",
  "reference": "0044710000001527"
}

Changes