Edenred Direct Payment Services

1. Generalities

In Romania, with the Ticket Restaurant Card, a user can spend the amount requested without any limitation (in the limit of the balance available on his account), i.e. balance can’t be negative.

The regulation(s) are handled on the Edenred side. Please note that all amounts in our API are given in cents (example: 9RON = 900).

2. User Security Tokens

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

2.1. Login Process

Edenred Connect v4 Url:

https://sso.sbx.edenred.io/connect/authorize?response_type=code&client_id=e3707e2c2aa34407b54a47d0d993f188&scope=openid%20edg-xp-mealdelivery-api%20offline_access&redirect_uri=http://nowhere.edenred.net/oauth/callback&state=abc123&nonce=456azerty&acr_values=tenant:ro-ben&ui_locales=en

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

  Username: erro-edps03@edenred.com
  Password: Edenred2021*
  PAN: 2937

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)

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

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}/balances 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": 305418,
      "currency": "RON"
    }
  ]
}

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

3.3. User Transactions

Capture Mode: 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-002",
  "mid": "00176631098",
  "amount": 1,
  "currency": "RON",
  "capture_mode": "auto",
  "extra_field": "order-002",
  "tstamp": "2019-05-23T14:02:50Z"
 }

Response:

{
   "meta": {
        "status": "succeeded",
        "messages": []
    }
    "data": {
        "order_ref": "order-002",
        "mid": "00176631098",
        "authorization_id": "455211",
        "authorized_amount": 1,
        "capture_id": "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,
   "currency": "RON",
   "tstamp": "2019-05-23T14:02:50Z"
 }

Refund Response:

 {
   "meta": {
     "status": "succeeded",
     "messages": []
   },
   "data": {
      "refund_id": "786653",
      "refunded_amount": 1,
      "status": "refunded"
    }
 }

3.4. Get transactions

Please refer to this section for more details about this API.

3.5. Get transaction by ID

Please refer to this section for more details about this API.

4. Error Codes