Edenred Direct Payment Services

1. Generalities

In Mexico, with the Ticket Despensas Card, the daily limit for card usage is 10 times per day, with no days restrictions, no minimum purchase and with maximum purchase limit for the card being MXN $1500. These regulations for daily limit to maximum purchase are handled on the Edenred side.

Food restrictions (Alcohol and Tabacco) will apply for users of Ticket Despensas card and will be handled by the partner.

Please note that all amounts in our API are given in cents (example: 9MXN$ = 900).

2. User Security Tokens

Please refer to this section for more details about security tokens.

2.1. Login Process

1) To test the API in sandbox, you can get an authorization_code by clicking on the link bellow:

https://sso.sbx.edenred.io/connect/authorize?response_type=code=0ef66819f992451c8399fb7209dc011c=openid%20edg-xp-mealdelivery-api%20offline_access=http://nowhere.edenred.net/oauth/callback=abc123=456azerty=tenant:mx-ben=es

Example of account that can be used to test the API:

  Username: tapia@mailinator.com
  Password: Pablo0206
  Tarjta: ***********24533
  CVC: 438

2) After login and agreement acceptance, you'll be redirected to a url like :

http://nowhere.edenred.net/oauth/callback?code={authorizationcode}&...

3) Copy the authorization_code and use the request "Get access_token from authorization_code" in the following collection of API calls :

Please note that an authorization_code is burned every time you try to use it. If your API call fails, you must get a new authorization_code.

2.2. Logout Process

Logout the Edenred account from your platform. All tokens are then invalid

GET /connect/endsession?id_token_hint=<idToken>=<postLogoutRedirectUri> HTTP/1.1
Host: {{authentication-URL}}

Where

'authentication-URL' = sso.sbx.edenred.io

And idToken is retrieved from the refreshing token response

And postLogoutRedirectUri is a callback URL whitelisted on our side (to be provided in the configuration request to your local project manager)

eg: postLogoutRedirectUri = http://nowhere.edenred.net/oauth/callback

3. Direct Payment API

3.1. Postman Collection

Postman Collection Link:

3.2. User Balance

Get Balances

Get all the available user vouchers including the full sum of their values.

The authorization header is mandatory for this request.

Request:

 GET /v2/users/{username} HTTP/1.1
 Host: directpayment.stg.eu.edenred.io
 Authorization: Bearer {token}
 X-Client-Id: {payment-clientId}
 X-Client-Secret: {payment-clientSecret}

Response:

{
  "meta": {
    "status": "succeeded",
    "messages": []
  },
  "data": {
    "available_amount": 85000,
    "currency": "MXN"
  }
}

Estimate Charge

Checks if an amount can be spent and answer the exact amount that could be spent (if the balance is below the requested amount).

The authorization header is mandatory for this request.

Request:

 POST /v2/users/{username}/actions/estimate-charge HTTP/1.1
 Host: directpayment.stg.eu.edenred.io
 Authorization: Bearer {token}
 X-Client-Id: {payment-clientId}
 X-Client-Secret: {payment-clientSecret}
 Content-Type: application/json
 {
   "amount": 1
 }

Response:

{
  "meta": {
    "status": "succeeded",
    "messages": []
  },
  "data": {
    "available_amount": 1,
    "currency": "MXN"
  }
}

3.3. User Transactions

Capture Mode: Auto

Step 1: Auto Capture a payment

An auto capture can be requested with an amount ""in cents"".

The "manual" capture is not supported on the Mexican authorization platform: "Capture" and "cancel" APIs are not implemented / supported

The authorization header should be set for this operation.

Request:

 POST /v2/transactions HTTP/1.1
 Host: directpayment.stg.eu.edenred.io
 Authorization: Bearer {token}
 X-Client-Id: {payment-clientId}
 X-Client-Secret: {payment-clientSecret}
 Content-Type: application/json
 {
  "order_ref": "889579",
  "mid": "00100128008",
  "amount": 1,
  "security_level": "standard",
  "capture_mode": "auto",
  "tstamp": "2021-10-03T15:20:22Z",
  "currency": "MXN"
 }

Response:

{
    "meta": {
        "status": "succeeded",
        "messages": []
    },
    "data": {
        "mid": "00100128008",
        "authorization_id": "919683",
        "authorized_amount": 1,
        "capture_id": "919683",
        "captured_amount": 1,
        "status": "captured",
        "order_ref": "889579"
    }
}

Step 2: Refund a captured payment

Once captured, a transaction can be refunded.

The authorization_id provided during the payment process must be provided in this request.

The authorization header should not be set for this operation.

The field tstamp MUST be the one used in the authorization to manage the refund

Refund Request:

 POST /v2/transactions/{authorization_id}/actions/cancel HTTP/1.1
 Host: directpayment.stg.eu.edenred.io
 X-Client-Id: {payment-clientId}
 X-Client-Secret: {payment-clientSecret}
 Content-Type: application/json
 {
   "amount": 1,
   "tstamp": "2021-10-03T15:20:22Z",
   "currency": "MXN"
 }

Refund Response:

{
   "meta": {
      "status": "succeeded",
      "messages": []
   },
   "data": {
      "mid": "00100128008",
      "refund_id": "919683",
      "refunded_amount": 1,
      "status": "refunded",
      "order_ref": "889579"
    }
}

4. Error Codes