Edenred Direct Payment Services

Generalities

In Spain, a user can spend the exact amount requested without any limitation (apart from the balance available on his account), i.e. balance can’t be negative.

These regulations are handled on the Edenred side. Please note that all amounts in our API are given in cents (example: 9€ = 900).

User Security Tokens

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

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:es-ben&ui_locales=es

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

    Account: trc_user_edps
    Password: Qw123456
    Mail OTP to retrieve with: trc_user_edps@yopmail.com

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 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.

Logout

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)

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

Direct Payment API

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

Get Balance

Gets 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": 12000
   }
 }

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

First Scenario: Capture Mode is set to Manual

Step 1: Authorize a payment

An authorization can be requested with an amount and/or a voucher array.

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": "336826441",
    "amount": 1,
    "capture_mode": "manual",
    "tstamp": "2019-05-21T11:57:52Z",
    "currency": "{{currency}}"
 }

Response:

{
 "meta": {
     "status": "succeeded",
     "messages": []
  },
 "data": {
      "order_ref": "order-001",
      "mid": "336826441",
      "authorization_id": "MTU1ODQzOTg3MjMzNjgyNjQ0MTQwM-382424",
      "authorized_amount": 1,
      "status": "authorized"
    }
}

Step 2: Cancel OR Capture a payment

An authorized payment can be cancelled or captured.

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

The authorization header should not be set for the two operations cancel and capture.

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",
     "messages": []
  },
  "data": {
      "order_ref": "order-001",
      "mid": "336826441",
      "cancel_id": "MTU1ODQ1MDM3MjE5OTkyMjQ0MDEwM",
      "cancelled_amount": 1,
      "status": "cancelled",
      "authorization_id": "MTU1ODQ1MDM3MjE5OTkyMjQ0MDEwM-559604",
      "authorized_amount": 1
    }
}

OR

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
 {
   "mid": "336826441",
   "amount": 1,
   "tstamp": "2019-05-21T12:15:29Z"
 }

Capture Response:

{
  "meta": {
     "status": "succeeded",
     "messages": []
  },
  "data": {
      "order_ref": "order-001",
      "mid": "336826441",
      "capture_id": "MTU1ODQzOTg3MjMzNjgyNjQ0MTQwM-382424",
      "capture_amount": 1,
      "status": "captured",
      "authorization_id": "MTU1ODQzOTg3MjMzNjgyNjQ0MTQwM-382424",
      "authorized_amount": 1
    }
}

Step 3: 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 authorization header should not be set for this operation.

The capture_mode is mandatory in the case of dual messaging (Authorize + Capture).

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",
    "currency": "EUR",
    "tstamp": "2019-05-21T12:17:53Z"
 }

Refund Response:

 {
   "meta": {
     "status": "succeeded",
     "messages": []
   },
   "data": {
      "order_ref": "order-001",
      "mid": "336826441",
      "refund_id": "MTU1ODQ2MjYyMDE5OTkyMjQ0MDEwM",
      "refunded_amount": 1,
      "status": "refunded",
      "authorization_id": "MTU1ODQ2MjYyMDE5OTkyMjQ0MDEwM-535907",
      "authorized_amount": 1
    }
 }

Second Scenario: Capture Mode is set to Auto

Step 1: Auto Capture a payment

An auto capture can be requested with an amount and/or a voucher array.

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": "336826441",
    "amount": 1,
    "tstamp": "2019-05-21T11:57:52Z",
    "currency": "EUR"
 }

Response:

{
   "meta": {
        "status": "succeeded",
        "messages": []
    }
    "data": {
        "order_ref": "order-001",
        "mid": "336826441",
        "authorization_id": "MTU1ODQ0NzM3MDMzNjgyNjQ0MTQwM-455211",
        "authorized_amount": 1,
        "capture_id": "MTU1ODQ0NzM3MDMzNjgyNjQ0MTQwM-455211",
        "capture_amount": 1,
        "status": "captured"
    }
}

Step 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 authorization header should not be set for this operation.

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,
   "tstamp": "2019-05-21T14:04:00Z"
 }

Refund Response:

 {
   "meta": {
     "status": "succeeded",
     "messages": []
   },
   "data": {
      "order_ref": "order-001",
      "mid": "336826441",
      "refund_id": "MTU1ODQ0NzQ0MDE5OTkyMjQ0MDEwM",
      "refunded_amount": 1,
      "status": "refunded"
    }
 }

Error Codes