HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Crear Referencia Pagos Referenciados

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Datos para generar una Referencia de pago referenciado de un Customer.

additional_metadata
object

Metadatos adicionales opcionales que se asocian a la Referencia.

number
≥ 0

Monto exacto a pagar. Según la configuración de recaudación de la Organization puede ser obligatorio o no aplicar; cuando no aplica, el valor enviado se ignora.

date

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.

string
required

Identificador del Customer para el que se genera la Referencia.

Responses

400

El algoritmo configurado para la Organization no admite los campos enviados: Amount is required for reference creation cuando falta el monto y el algoritmo lo exige, o Expiration date is not allowed for reference creation cuando se envía una fecha de expiración y el algoritmo no la usa.

403

La Organization no tiene configurada la recaudación por convenio CIE. Requiere que el equipo de operaciones la habilite.

404

El id_customer enviado no corresponde a ningún Customer de una Organization.

500

No se pudo generar una Referencia utilizable para esos datos. Es reintentable y, si persiste, requiere revisión de Toku.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json