Intégrate con nuestra API | Proveedor de pagos electrónicos

Servicios de Pagos en Efectivo en Todo México

Proveedor de Pagos Electrónicos (PPE) pone a tu disposición dos servicios creados para nuestros clientes:

Genera un token;
Crea una referencia de pago;
Notificar pago recibido;
Obtener un reporte de los pagos realizados por tus clientes;
Obtener el saldo de los pagos realizados por tus clientes;
Conoce los códigos de respuesta de PPE.

Solicitar Referencia de pago en efectivo en las Tiendas Oxxo

Autenticación basada en token (JWT Bearer). Genera un Token

Conoce el método para crear una referencia de pago para que tus clientes puedan realizar sus pago en cualquier tienda Oxxo de México.

POST {URL}/payments/reference

Petición

Respuesta exitosa

Respuesta no exitosa Http code 400

Ejemplo

Petición

{

"loanNumber": "2",

"paymentAmount":5000,

"paymentNumber": 1,

"totalPayments": 6

}

Respuesta exitosa

{

"success": true,

"reference": "410000020000605000002024072910"

}

Respuesta no exitosa Http code 400

{

"success": false,

"message": "Ya existe una referencia para los datos ingresados."

}

Obtener los pagos realizados por tus clientes

Autenticación basada en token (JWT Bearer). Generar Token

Conoce el método para obtener los pagos realizados por tus clientes en un rango de fechas.

GET {URL}/sofomes/get-operations?from={Fecha inicial}&to={Fecha final}

Petición

Respuesta exitosa

ACCEPTED: Orden pagada en Oxxo

NOTIFIED: Orden pagada en Oxxo y notificada a Webhook

REVERSED: Orden cancelada

Respuesta no exitosa Http code 500

Array vacio

Ejemplo

Petición

/sofomes/get-operations?from=2025-01-01&to=2025-02-28

Respuesta exitosa

{

"paymentReport": [

{

"client": "780300000000020100000202410233",

"tranDate": "2024-10-23T12:40:55",

"cashMachine": 2,

"entryMode": "021",

"cashierId": "COBEJO9109015",

"ticket": 712630,

"amount": 1000.00,

"adminDate": "2024-10-23",

"store": "10GUD50CUD",

"status": "ACCEPTED"

}

],

"paymentsTotal": 22500.00

}

Respuesta no exitosa Http code 500

[ ]

Obtener balance de los pagos realizados por tus clientes de forma exitosa en Oxxo

Autenticación basada en token (JWT Bearer). Generar Token

Conoce el método para para que puedas obtener el balance actual de los pagos realizados por tus clientes de forma exitosa en cualquier tienda Oxxo de México.

GET {URL}/sofomes/get-balance

Petición

Respuesta exitosa

Respuesta no exitosa Http code 500

Objeto vacio

Ejemplo

Petición

/sofomes/get-balance

Respuesta exitosa

{

"totalBalance": 54000,

"totalRefounds": 2600.00,

"totalCommissions": 560

}

Respuesta no exitosa Http code 500

[ ]

Notificar pago recibido

Webhook para notificar que oxxo ha recibido pago de una referencia asociado a la sofom.

Datos de Entrada

Ejemplo

url/{token}

Petición

{

"eventType ": "PAYMENT_SUCCEEDED",

"transaction": {

"amount ": "5000",

"reference ": "410000020000605000002024072910",

"date ": "29/07/2024 14:11:01"

},

"message": null

}

Respuesta 204 No Content

Generar Token

Método para generar token a partir de un usuario y contraseña que se genera cuando se da alta la sofom.

POST {URL}/login

Datos de entrada

Datos de salida

Ejemplo

Petición

{

"username" : "myUser",

"password" :"myPass"

}

Respuesta

{

"access_token": "eyJhbGciOiJIUzI1OiJ1.eyJzdWIiOiJ1c2VyU21mb20wMSIsIm5iZiI6MTcyMjUzMTUyMiwicm1sZXMiOltdLCJpc3MiOiJwcGUtc21mb20tcGF5bWVudHMtYXBpIiwiZXhwIjoxNzIyNTM1MTIyLCJpYXQiOjE3MjI1MzE1MjJ9.BmRWruyfcBhaBMAlNTyeRopOIE8rmj1LTSOJn1q-i90",

"token_type": "Bearer",

"expires_in": 3600,

"username": "myUser"

}

Matriz de certificación para recibir pagos en Oxxo

Para que tu empresa pueda pasar a producción deberá realizar las siguientes pruebas de forma exitosa:

Enviar una referencia de pago sin número de crédito.
Enviar una referencia de pago sin monto de pago.
Enviar una referencia de pago con un monto de $1,200.00
Enviar una referencia de pago con un monto de $2,501.00
Enviar URL webhook y token de acceso: https://codefusionmx.gitlab.io/fam-consulting/sofom-api-doc/notificar-pago.html