HomeGuíasAPI ReferenceChangelog
Log In
API Reference

Crear Referencia

Crea una Referencia de pago en efectivo para que un Customer la pague en tienda.

Se usa para cobrar en efectivo en México: devuelve la Referencia que el Customer presenta en la caja de la cadena de tiendas y, cuando el proveedor lo entrega, la URL de su código de barras. El pago no queda registrado al crear la Referencia, sino cuando el proveedor notifica que se pagó en tienda.

El gateway es opcional: si no se envía, se usa el que la Organization tenga configurado por defecto. Si la configuración de ese gateway es de Referencias de un solo uso, invoices es obligatorio y la Referencia queda por el total de esos Invoices.

Solo se puede crear una Referencia a la vez por Customer: si hay otra creación en curso para el mismo Customer, la solicitud se rechaza con HTTP 423 y se puede reintentar.

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

Datos para crear una Referencia de pago en efectivo en México.

string

Identificador de la Account a la que se asocia la Referencia.

string
required

Identificador del Customer que pagará la Referencia en tienda.

string
enum

Cadena de tiendas con la que se crea la Referencia: oxxo y tapi para cash MX PST, paycash y dapp para cash MX PSP. Si se omite, se usa la que la Organization tenga configurada por defecto.

Allowed:
invoices
array of strings
Defaults to []

Identificadores de los Invoices que la Referencia salda. Obligatorio cuando la configuración del gateway usa Referencias de un solo uso.

Invoices
Responses

400

El Customer no existe, alguno de los Invoices no es pagable o no corresponde a ese Customer, o la configuración usa Referencias de un solo uso y no se enviaron Invoices.

401

La Organization no tiene habilitados los cobros en efectivo en México para el gateway pedido, o no se envió gateway y no hay uno por defecto configurado.

423

Ya hay otra creación de Referencia en curso para el mismo Customer. Reintenta cuando haya terminado.

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