API Standards

Endpoints URL:

All endpoints url starts with:
https://api.cfxpay.io/{{param_environment}}/{{param_company}}

📌

The params are sent by email or support

Authentication

Our API uses HTTP Basic Authentication.

You must include the Authorization header in the HTTP request following the pattern bellow:
Authorization: Basic {base64 encryption of the credentials user:password}

Example:
Authorization: Basic MTIzNDU2Nzg5MDphZmU3aDc0YzgzZjQ3NDJkNDcwN

📌

User and Password credentials are sent by email or support.

Languages:

To receive error messages already translated into the desired language, you can include the Language header with the accepted codes (see Languages), as in the following example.

Example:
Language: english

Backend Responses

All backend responses have a pattern format:

Response

server

string

required

code

integer

required

message

string

required

identifier

string

required

type

string

required

caller

string

required

caller_id

string

required

translation_message

string

required

Example:

{
    "server": "01",
    "code": 0, //0 means success, less than ZERO means an error
    "message": "Success", //A simple message
    "identifier": "1695658215036783030",
    "type": "LOG_INFO",
    "caller": "_gateway_payment_type_list",
    "caller_id": "1695658214986595654",
    "translation_message": "Success" //Translated message
}

Endpoints URL:#

Authentication#

Languages:#

Backend Responses#

Endpoints URL:

Authentication

Languages:

Backend Responses