Edenred Direct Payment Services

Generalities

In Italy, vouchers are dematerialised on meal cards but keep their facial value. If someone has 1 voucher of 9€ and 1 voucher of 8€, he can spend 8€, 9€ or 17€ (8€+9€).

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

UI/UX

ETR

ETC

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:

ETR

https://sso.sbx.edenred.io/connect/authorize?response_type=code_id=6e0dbfc6dd534faf8c54f8bc7a13b0d7=openid%20edg-xp-mealdelivery-api%20offline_access_uri=http://nowhere.edenred.net/oauth/callback=abc123=456azerty_values=tenant:it-ben_locales=it

User to test :
Username : testcloud01@mt2015.com
Password : Test1234!

ETC

https://sso.sbx.edenred.io/connect/authorize?response_type=code_id=6e0dbfc6dd534faf8c54f8bc7a13b0d7=openid%20edg-xp-mealdelivery-api%20offline_access_uri=http://nowhere.edenred.net/oauth/callback=abc123=456azerty_values=tenant:it-ben-comp_locales=it

User to test :
Username : 1LNDFU0AL6
Password : LDA2PC

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 :

To test "Ticket Restaurant", update the postman configuration as follow
{{product_class}} = ETR
{{Username}} : testcloud01@mt2015.com

To test "Ticket Compliments", update the postman configuration as follow
{{product_class}} = ETC
{{Username}} : 1LNDFU0AL6

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

'xp-identityserver-URL' or '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

Note : when you use the postman collection below the refresh_token and access_token are automatically placed in the HTTP Authorization header of postman.

Get Balances

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

The "authorization | bearer {{access_token}}" is mandatory in the header for this request.

Request:

ETR

GET /v2/users/{{username}}/balances HTTPS/1.1

Host: directpayment.stg.eu.edenred.io

Authorization: Bearer {{access_token}}

X-Client-Id: {{payment-clientId}}

X-Client-Secret: {{payment-clientSecret}}

ETC

GET /v2/users/{{username}}/balances?mid={{mid}} HTTPS/1.1

Host: directpayment.stg.eu.edenred.io

Authorization: Bearer {{access_token}}

X-Client-Id: {{payment-clientId}}

X-Client-Secret: {{payment-clientSecret}}

Response:

{
  "meta": {
    "status": "succeeded",
    "messages": []
   },
  "data": {
     "available_amount": 90000,
     "vouchers": [
        {
          "value": 900,
          "count": 100
         }
     ],
     "currency": "EUR"
    }
 }

Estimate Charge

Checks if an amount can be spent and answers the needed vouchers.

The "authorization | bearer {{access_token}}" is mandatory in the header for this request.

Request:

 POST /v2/users/{{username}}/actions/estimate-charge?product_class={{product_class}} HTTPS/1.1
 Host: directpayment.stg.eu.edenred.io
 Authorization: Bearer {{access_token}}
 X-Client-Id: {{payment-clientId}}
 X-Client-Secret: {{payment-clientSecret}}
 Content-Type: application/json
 {
   "amount": 2000
 }

Response:

 {
    "meta": {
        "status": "succeeded",
        "messages": []
    },
    "data": {
        "available_amount": 1800,
        "vouchers": [
          {
            "value": 900,
            "count": 2
           }
        ],
     "currency": "EUR"
    }
 }

First Scenario: Payment is done in dual messaging ("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 "saves" the corresponding funds (#vouchers validated in the request) on the user account for a given period

The "authorization | bearer {{access_token}}" is mandatory in the header for this request.

The field tstamp CAN be set. If this information is set in the request we can manage idempotency for the calls sent with the same information including the tstamp.

Request with amount:

 POST /v2/transactions?product_class={{product_class}} HTTPS/1.1
 Host: directpayment.stg.eu.edenred.io
 Authorization: Bearer {{access_token}}
 X-Client-Id: {{payment-clientId}}
 X-Client-Secret: {{payment-clientSecret}}
 Content-Type: application/json
  {
    "mid": "228506",
    "amount": 900,
    "capture_mode": "manual",
    "order_ref": "708521",
    "extra_field": "Delivery_3",
    "tstamp": "2019-05-22T15:00:12Z"
 }

Request with vouchers:

 POST /v2/transactions?product_class={{product_class}} HTTPS/1.1
 Host: directpayment.stg.eu.edenred.io
 Authorization: Bearer {{access_token}}
 X-Client-Id: {{payment-clientId}}
 X-Client-Secret: {{payment-clientSecret}}
 Content-Type: application/json
  {
    "mid": "228506",
    "vouchers": [
        {
          "value":  900,
          "count":  1
        }
     ]
    },
    "capture_mode": "manual",
    "order_ref": "708521",
    "extra_field": "Delivery_3",
    "tstamp": "2019-05-22T15:00:12Z"
 }

Response:

{
 "meta": {
     "status": "succeeded",
     "messages": []
  },
 "data": {
      "authorization_id": "228506-24578",
      "authorized_amount": 900,
      "status": "authorized"
    }
}

Step 2: Capture a payment

An authorized payment has to be captured by the partner via a dedicated call to the authorization platform in order to capture the funds. Please note that there should be at least 5 seconds between Authorize and Capture call.

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

The "authorization | bearer {{access_token}}" is not mandatory in the header for this request.

Capture Request:

 POST /v2/transactions/{{authorization_id}}/actions/capture?product_class={{product_class}} HTTP/1.1
 Host: directpayment.stg.eu.edenred.io
 X-Client-Id: {{payment-clientId}}
 X-Client-Secret: {{payment-clientSecret}}
 Content-Type: application/json
 {
   "amount": 900,
   "tstamp": "2019-05-22T15:20:33Z"
 }

Capture Response:

{
  "meta": {
     "status": "succeeded",
     "messages": []
  },
  "data": {
      "status": "Captured",
      "captured_id": "228506-24578",
      "captured_amount": 900
    }
}

[ALT] Step 2: Cancel a payment

An authorized payment can be cancelled.

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

The "authorization | bearer {{access_token}}" is not mandatory in the header for this request.

Cancel Request:

 POST /v2/transactions/{{authorization_id}}/actions/cancel?product_class={{product_class}} HTTPS/1.1
 Host: directpayment.stg.eu.edenred.io
 X-Client-Id: {{payment-clientId}}
 X-Client-Secret: {{payment-clientSecret}}
 Content-Type: application/json
 {
   "amount": 900,
   "tstamp": "2019-05-22T17:10:32Z"
 }

Cancel Response:

{
  "meta": {
     "status": "succeeded",
     "messages": []
  },
  "data": {
      "status": "cancelled",
      "cancel_id": "228506-98232",
      "canceled_amount": 900
    }
}

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 | bearer {{access_token}}" is not mandatory in the header for this request.

Refund Request:

 POST /v2/transactions/{{authorization_id}}/actions/refund?product_class={{product_class}} HTTPS/1.1
 Host: directpayment.stg.eu.edenred.io
 X-Client-Id: {{payment-clientId}}
 X-Client-Secret: {{payment-clientSecret}}
 Content-Type: application/json
 {
    "amount": 900,
    "capture_mode": "manual"
 }

Refund Response:

 {
   "meta": {
     "status": "succeeded",
     "messages": []
   },
   "data": {
      "status": "refunded",
      "refund_id": "228506-24578",
      "refunded_amount": 900
    }
 }

Second Scenario: Payment is done in single messaging ("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 | bearer {{access_token}}" is mandatory in the header for this request.

Request with amount:

 POST /v2/transactions HTTPS/1.1
 Host: directpayment.stg.eu.edenred.io
 Authorization: Bearer {{access_token}}
 X-Client-Id: {{payment-clientId}}
 X-Client-Secret: {{payment-clientSecret}}
 Content-Type: application/json
  {
    "mid": "228506",
    "amount": 900,
    "capture_mode": "auto",
    "order_ref": "464085",
    "extra_field": "Delivery_4",
    "tstamp": "2019-05-22T16:05:22Z"
 }

Request with vouchers:

 POST /v2/transactions HTTPS/1.1
 Host: directpayment.stg.eu.edenred.io
 Authorization: Bearer {{access_token}}
 X-Client-Id: {{payment-clientId}}
 X-Client-Secret: {{payment-clientSecret}}
 Content-Type: application/json
  {
    "mid": "228506",
    "vouchers": [
        {
          "value":  900,
          "count":  1
        }
     ]
    },
    "capture_mode": "auto",
    "order_ref": "464085",
    "extra_field": "Delivery_4",
    "tstamp": "2019-05-22T16:05:22Z"
 }

Response:

{
 "meta": {
     "status": "succeeded",
     "messages": []
  },
 "data": {
      "capture_id": "228506-2480",
      "captured_amount": 900,
      "status": "captured",
      "authorization_id": "228506-2480",
      "authorized_amount": 900,
      "order_ref": "464085"
    }
}

Step 2: Refund a captured payment

Not supported in Italy as it is not compliant.

EDPS IT - ERROR Management