API Reference

El primer requisito antes de hacer cualquier llamado en la API Forpay es estar autenticado, ya que cada endpoint requiere de un token de autorización. Para autenticarse, se debe consumir el endpoint /login, al cual hay que enviar como parámetro obligatorio una password en formato JWE (JSON Web Encryption) y luego retorna un JWT necesario para el resto de las solicitudes.

Log in to see full request history
Query Params
string
required

Identificador de cliente entregado por Forpay

string
required

Pasword entregado por Forpay que debe ser encriptada mediante JSON Web Encryption (JWE)

Headers
string
required

Identificador de país donde proviene la solicitud

string
required

Identificador único del comercio asociado definido por forpay

string
required

Tipo de plataforma usada por el comercio para integrarse con Forpay

date-time
required

Fecha y hora de la solicitud

string
required

Identificador único para la trazabilidad de la solicitud

string
required

Identificador único del proceso interno de forpayque realiza la solicitud

string
required

Identificador del ejecutivo que realiza la venta

Responses

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