API – Developers Docs API – Developers Docs
  • Cyberpac
  • Addon Payments
  • POS integrated Payments
  • SpanishSwitch to Spanish
API – Developers Docs API – Developers Docs
API – Developers Docs
  • Cyberpac
  • Addon Payments
  • POS integrated Payments
  • SpanishSwitch to Spanish

PAY BY LINK

  • Icono de carpeta cerrada Icono de apertura de carpetaAPI Authentication
  • Icono de carpeta cerrada Icono de apertura de carpetaAccess By API
  • Icono de carpeta cerrada Icono de apertura de carpetaAccess By Web
  • Icono de carpeta cerrada Icono de apertura de carpetaAPI Explorer
  • Icono de carpeta cerrada Icono de apertura de carpetaFeatures
    • Auto-generated Customer Id
    • Backoffice tutorial
    • Code Format
    • Status Flow
    • Error Codes
    • Date Time &
    • Countries
    • Currencies

API Authentication

Authentication Flow

The integrator makes a call to get an authentication token.

The integrator makes calls to any of the AddonPayments API endpoint until their login token has expired.

API Authentication by oAuth2

Client Authentication

Registered OAuth applications are assigned a unique Client ID (client_id) and unique Client Secret (client_secret).

By sending the client_id and the client_secret, you are letting Sell API know which application is accessing the API. Only requests to the Authorization Server require client credentials.

To authenticate an application with the Authorization Server, use the standard Authorization header with the basic authentication scheme, where the username is the client_id and the password is the client_secret. Every request to the OAuth token endpoint requires client authentication.

Authorization: Basic Base64($CLIENT_ID:$CLIENT_SECRET)

The way to do this using a tool like curl is to use the -h or --header flag, which is used for passing authentication information in the form of client_id:client_secret. For example, the API authentication flow requires the client credentials in order to obtain an access token. The example below shows how to make the request

$ curl -v -X POST https://api.easypaymentgateway.com/epgpay-auth/login \
      --header 'Authorization: Basic Base64($CLIENT_ID:$CLIENT_SECRET)' \
      --header 'Content-Type: application/x-www-form-urlencoded' \
      --data "grant_type=client_credentials"

Response

Path Type Description
jti String A unique identifier for the authentication token.
access_token String The token that is used for further authentication calls to AddonPayments systems. This needs to be appended to further requests as a request header with the “Bearer” word prepended
expires_in Number The amount of time in secons the given access toke is valid for. For using the client_credentails flow like this, after this amount of time has passed, you must reauthenticate
token_type String always bearer when using client_credentials
{
  "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJhdWQiOlsib2F1dGgyLXJlc291cmNlIl0sInNjb3BlIjpbInRyYW5zYWN0aW9uLWFwaSJdLCJtZXJjaGFudF9pZCI6IjEwNDUwIiwiZXhwIjoxNjI0OTgyMjkyLCJhdXRob3JpdGllcyI6WyJJTlZfTUFOQUdFTUVOVCIsIklOVl9FTUFJTF9DT05GSUciLCJJTlZfVEVNUExBVEUiLCJJTlZfQkFUQ0giXSwianRpIjoiMTA5ZjYwZTgtZjUyMy00NDFlLTg3NzEtYjFmODVmNTk4ZTk0IiwiY2xpZW50X2lkIjoiMTA0NTAtYXF4Z0pOUWQifQ.cQQFvtbcawtVj4KiTxQnc1sHM-akltyNMb0Ghq7gOSEOyfitIF6SlMT7RoGNsU4V-hE_0h6MesgeYW6bfu2PtuM5b4ODF31TAWGU7BFp9FfsLKJev7Gswhp2zZN80kHFcGCtIQkW-sC_yb4pBiaIfdiQWqK-VDPFrvyUERxqEqF4hy6DufIf6-yWF2WuWIAqf1y5_jbSzZbh2i05UllVdEtxux1_-MXULS73YQangG6P8y6dr2jauH-raxExP733Az723juIddRfRl9cvIeFBWECF4uWHR3EyHvLTH3PqmtCTmEJvhp9h_IAbEBectBEcKIII_5DBr1gjvBvxZjeqw",
  "token_type": "bearer",
  "expires_in": 1799,
  "scope": "transaction-api",
  "merchant_id": "10450",
  "authorities": [
    "INV_MANAGEMENT",
    "INV_EMAIL_CONFIG",
    "INV_TEMPLATE",
    "INV_BATCH"
  ],
  "jti": "109f60e8-f523-441e-8771-b1f85f598e94"
}

visto recientemente

  • Error Codes
  • Leer Más
Comparte este documento

API Authentication

Copiar el enlace

Icono del portapapeles
Tabla de Contenidos

Products

  • Cyberpac
  • Addon Payments
  • POS integrated Payments
  • Universal Pay

Sales

Tell us about your business so we can offer you the best solution.

Contact an expert
Contact an expert
Contact an expert
Contact an expert
Contact an expert

Technical Support

Already a client and need help? Contact us, we’re here for you.

Help

Partners

We work with the best partners for in-store and ecommerce solutions. Want to join us?

Join us

© Comercia Global Payments

Privacy policy
Exercising rights
Client information
Whistleblowing channel
Legal disclaimer
Cookies policy
Ask AI
Write your question. For example: How do I create a payment link?
SmartWiki may skip data. Verify the information or contact support.

SmartWiki, Powered by AI

API - Developers Docs
Manage cookie consent

To offer the best experiences, we use technologies such as cookies to store and/or access device information. Consent to these technologies will allow us to process data such as browsing behavior or unique IDs on this site. Failure to consent, or withdrawal of consent, may adversely affect certain features and functions.

Functional Always active
Storage or technical access is strictly necessary for the legitimate purpose of allowing the use of a specific service explicitly requested by the subscriber or user, or for the sole purpose of carrying out the transmission of a communication over an electronic communications network.
Preferences
Technical storage or access is necessary for the legitimate purpose of storing preferences not requested by the subscriber or user.
Statistics
El almacenamiento o acceso técnico que es utilizado exclusivamente con fines estadísticos. Storage or technical access that is used exclusively for anonymous statistical purposes. Without a requirement, voluntary compliance by your Internet service provider, or additional records from a third party, information stored or retrieved solely for this purpose cannot be used to identify you.
Marketing
Storage or technical access is necessary to create user profiles to send advertising, or to track the user on a website or several websites for similar marketing purposes.
Manage options Manage services Manage {vendor_count} vendors Read more about these purposes
See preferences
{title} {title} {title}

Consulta la documentación de las distintas secciones de integraciones:

Comienza a integrar

undraw_add_to_cart_re_wrdo 1 (1) (1)

Plugins para CMS

Complementa la integración

SDKs

Métodos de pago

Herramientas

Addon Payments

Consulta la documentación de Addon Payments. Aquí tienes las distintas secciones:

Integraciones

Consultas frecuentes

Portal Backoffice

Cyberpac

We are currently working on the English version of the Cyberpac documentation. You can view the Spanish version using the buttons below:

Canales BackOffice Portal

Plugins integration

Custom integrations

POS integrated Payments

Create a solution that will help you automate processes. You can even add payment processes on physical terminals.

Payment Integrated with Android POS

Payment Integrated with Smartphone POS

POS Data sheets

Addon Payments

Comercia Global Payments has several integration options so you can choose the most efficient one for you.

Integrations

Frequently Asked Questions

BackOffice Portal

Consult the documentation of the different integrations sections:​

Start integration

undraw_add_to_cart_re_wrdo 1 (1) (1)

CMS Plugins

Complement your integration

SDKs

Payment Methods

Tools