Edenred Direct Payment Services

I. Generalities

In France, a user can spend the exact amount requested up to 19€ per day, i.e. he can’t spend more than 19€ in a given day (or 38 euros in some cases).

These regulations are handled on the Edenred side.

Please note that all amounts in our API are given in cents (9€ = 900)

II. 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&client_id=bf79413250f449948ce12b98b08e3fc0&scope=openid%20edg-xp-mealdelivery-api%20offline_access&redirect_uri=http://nowhere.edenred.net/oauth/callback&state=abc123&nonce=456azerty&acr_values=tenant%3Afr-ctrtku&ui_locales=fr

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

Account: lerouxpablo@yopmail.com
Password: Edenred2021*
Masked PAN : 4475

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

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

3) Copy the authorization_code and paste it in the body of the request "Get Token by authorization_code" (in the "code" parameter) in the following collection of API calls (Please note the environment is set up in capture mode auto) :

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 by requesting the user to follow the authentication flow again.

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

'xp-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)

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

III. Direct Payment API

If you use the postman collection, the access_token will automatically be placed in your HTTP Authorization header.

Token Management:

Users Management:

Transaction Management

• Capture Mode auto:

• Capture Mode Manual:

a- Authorize > Cancel

b- Authorize > Capture > Refund

The postman configuration available here is set in auto-clearing mode => cancel and capture routes are not available.

You can request an access to our UAT environment in manual-clearing mode if you choose to implement the payment with Edenred this way.

II.1. Get Balance

Get the available amount to spend available on the user account. This amount is the one available at the given moment to manage a payment

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": 1900,
   "currency": "EUR"
    }
}

II.2. Estimate Charge

Check if an amount can be spent and answer the possible amount that can be spent. If the requested amount is above the available balance, the service will provide the available amount in the response.

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": 1900
 }

Response:

{
   "meta": {
        "status": "succeeded",
        "messages": []
    },
    "data": {
        "available_amount": 1800,
        "currency": "EUR"
    }
}

II.3. Transactions

EDPS manages two kinds of transaction mode, auto and manual. The postman collection is set up in capture mode auto. If you want to test an environment in capture mode manual, please request a dedicated environment.

In the next sections, we will explain the difference between those two modes.

II.3.1. Capture Mode - Auto

In this mode, we can perform only the below operations:

II.3.1.1. Authorize & Capture a payment

An auto capture is requested with an amount in cents of Euros (19€ = 1900 in the request).

The authorization header should be set for this operation.

The field tstamp MUST be set in order to manage idempotency

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": "order-001",
  "mid": "1999224",
  "amount": 1,
  "capture_mode": "auto",
  "extra_field": "order-fr-001",
  "tstamp": "2018-08-31T14:22:00Z"
 }

Response:

{
    "meta": {
        "status": "succeeded"
    },
    "data": {
        "order_ref": "order-fr-002",
        "mid": "1999224",
        "status": "captured",
        "authorization_id": "MTU5MjM3NjcyNzE5OTkyMjQ4MDAwM-642338",
        "authorized_amount": 1,
        "capture_id": "MTU5MjM3NjcyNzE5OTkyMjQ4MDAwM-642338",
        "captured_amount": 1
    }
}

II.3.1.2. Refund a Captured payment

Once captured, a transaction can't be cancelled but have to be refunded.

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

The refund can only be performed for the full amount that has been captured

The field tstamp MUST be set in order to manage idempotency

Refund Request:

 POST /v2/transactions/{authorization_id}/actions/refund 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,
   "capture_mode": "auto",
   "tstamp": "2019-05-21T14:04:00Z"
 }

Refund Response:

{
    "meta": {
        "status": "succeeded"
    },
    "data": {
        "mid": "1999224",
        "status": "refunded",
        "refund_id": "MTU5MjM3NjcyNzE5OTkyMjQ4MDAwM",
        "refunded_amount": 1,
        "order_ref": "order-fr-002",
        "authorization_id": "MTU5MjM3NjcyNzE5OTkyMjQ4MDAwM-642338",
        "authorized_amount": 1,
        "capture_id": "MTU5MjM3NjcyNzE5OTkyMjQ4MDAwM-642338",
        "captured_amount": 1
    }
}

II.3.2. Capture Mode - Manual

In this mode, we can perform the below operations:

II.3.2.1. Authorize a payment

An authorization is requested with an amount in cents of Euros (19€ = 1900 in the request).

The authorization header should be set for this operation.

The field tstamp MUST be set in order to manage idempotency

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": "order-fr-001",
    "mid": "1999224",
    "amount": 1,
    "currency": "EUR"
    "capture_mode": "manual",
    "extra_field": "order-fr-001",
    "tstamp": "2019-05-27T10:02:50Z"
 }

Response:

{
    "meta": {
        "status": "succeeded"
    },
    "data": {
        "order_ref": "order-fr-001",
        "mid": "1999224",
        "status": "authorized",
        "authorization_id": "MTU5MjMyMzI2NzE5OTkyMjQ4MDAwM-199570",
        "authorized_amount": 1
    }
}

II.3.2.2. Cancel OR Capture a payment

An authorized payment can be cancelled or captured.

Cancel and capture are for the full amount authorized

The field tstamp MUST be set in order to manage idempotency

Cancel 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": "2019-05-21T12:10:12Z"
 }

Cancel Response:

{
    "meta": {
        "status": "succeeded"
    },
    "data": {
        "mid": "1999224",
        "status": "cancelled",
        "cancel_id": "MTU4ODY2MzI0NTE5OTkyMjQ4MDAwM",
        "cancelled_amount": 1,
        "order_ref": "order-fr-001",
        "authorization_id": "MTU5MjMyMzI2NzE5OTkyMjQ4MDAwM-199570",
        "authorized_amount": 1
    }
}

Capture Request:

 POST /v2/transactions/{authorization_id}/actions/capture 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": "2019-05-21T12:15:29Z"
 }

Capture Response:

{
  "meta": {
     "status": "succeeded",
     "messages": []
  },
  "data": {
      "order_ref": "order-fr-001",
      "mid": "1999224",
      "capture_id": "MTU5MjM3NTg1MjE5OTkyMjQ4MDAwM-520011",
      "capture_amount": 1,
      "status": "captured",
      "authorization_id": "MTU5MjM3NTg1MjE5OTkyMjQ4MDAwM-520011",
      "authorized_amount": 1
    }
}

II.3.2.3. Refund a captured payment

Once captured, a transaction can't be cancelled but have to be refunded.

The capture_mode is mandatory in the case of dual messaging (Authorize and Capture) and must be set to "manual".

The refund can only be performed for the full amount that has been captured

The field tstamp MUST be set in order to manage idempotency

Refund Request:

 POST /v2/transactions/{authorization_id}/actions/refund 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,
    "capture_mode": "manual",
    "tstamp": "2019-05-21T12:17:53Z"
 }

Refund Response:

{
    "meta": {
        "status": "succeeded"
    },
    "data": {
        "mid": "1999224",
        "status": "refunded",
        "refund_id": "MTU4ODY2MzI0NTE5OTkyMjQ4MDAwM-520011",
        "refunded_amount": 1,
        "order_ref": "order-fr-001",
        "capture_id": "MTU5MjM3NTg1MjE5OTkyMjQ4MDAwM-520011",
        "capture_amount": 1,
        "authorization_id": "MTU5MjM3NTg1MjE5OTkyMjQ4MDAwM-520011",
        "authorized_amount": 1
    }
}

IV Error Codes