Edenred Direct Payment Services

Context

This API enables you to retrieve a set of transactions.

All transactions type can be retrieved : transactions processed with success or in error on Edenred side

How to reach this API ?

This API is only accessible via our new URL :

• UAT/sandbox : https://directpayment.stg.eu.edenred.io/v2
• PRODUCTION : Not yet available - URL will be communicated when service is enabled

How to use this API ?

In this section, we will explain how to use the new APIs.

Get Transactions

This API exposes a set of search criteria used to retrieve a set of transactions.

HTTP Request Headers

• Security:

The security of this API is managed by the HTTP request header X-Client-Id and X-Client-Secret

Please use the Payment-Client-Id and Payment-Client-Secret you use to call other APIs (Get Balance...)

Exemple:

  X-Client-Id: c3786ed428174b5cb43faca0b4bde857
  X-Client-Secret: b3631663092443f7A547332871468B09

• Pagination:

The pagination is managed by the http request header Range

Due to performance concern, we recommend to search 20 items per page

The HTTP request header "Range" indicates the part of a document that the server should return. Several parts can be requested with one Range header at once, and the server may send back these ranges in a multipart document.

Exemple:

  Range: item=0-19

HTTP Response Headers

• Accept-Range

The Accept-Ranges response-header field allows the server to indicate its acceptance of range requests for a resource.

Accept-Ranges: <range-unit>

Accept-Ranges: none

<range-unit> : Defines the range unit the server supports. At Edenred we use the unit item when it comes to collection resources.

item 50

• Content-Range

The Content-Range response HTTP header indicates where in a full body message a partial message belongs.

Content-Range: -/<unit> : The unit in which ranges are specified. This is usually bytes.

<range-start> : An integer in the given unit indicating the beginning of the request range.

<range-end> : An integer in the given unit indicating the end of the requested range.

<size> : The total size of the document (or '*' if unknown).

item 0-47/50

Examples of Response

{
  "meta": {
    "status": "succeeded",
    "messages": []
  },
  "data": [
    {
      "ref": "MTYxMjQ2OTE4MTEwMzUxNTM4MDAwM-427032",
      "username": "myedenred@gmail.com",
      "date": "2021-01-22T13:55:12+01:00",
      "total_amount": 1900,
      "partner_name": "MyOrder",
      "product_class": "ETR",
      "session_id": "b2e77d47a0479900504cb3ab4a1f626d174d2d",
      "transaction_details": [
        {
          "type": "edenred",
          "id": "MTYxMjQ2OTE4MTEwMzUxNTM4MDAwM-427032",
          "merchant": {
            "id": "123456",
            "details": {
              "name": "BOUCHERIE LES 4 CHEMINS",
              "address": {
                "address_line_1": "AVENUE DES FARIGOULES",
                "zip_code": "04130",
                "city_name": "VOLX"
              }
            }
          },
          "order_ref": "Order-123",
          "extra_field": "MyOrder|123",
          "amount": 1900,
          "status": {
            "code": "captured"
          }
        }
      ]
    },
    {
      "ref": "MTYxMjS5OTE4MTEwLzKxNTM4MDAwM-652019",
      "username": "edpstest@edenred.com",
      "date": "2021-01-21T12:55:12+01:00",
      "total_amount": 1250,
      "partner_name": "MyOrder",
      "product_class": "ETR",
      "session_id": "1f626d17aab4796d504b13ab4a1f626d173ab4",
      "transaction_details": [
        {
          "type": "edenred",
          "id": "MTYxMjS5OTE4MTEwLzKxNTM4MDAwM-652019",
          "merchant": {
            "id": "123456",
            "details": {
              "name": "BOUCHERIE LES 4 CHEMINS",
              "address": {
                "address_line_1": "AVENUE DES FARIGOULES",
                "zip_code": "04130",
                "city_name": "VOLX"
              }
            }
          },
          "order_ref": "Order-234",
          "extra_field": "MyOrder|234",
          "amount": 1250,
          "status": {
            "code": "refunded"
          }
        }
      ]
    },
    {
      "ref": "d11a4c64-8004-437a-8b40-9d1574165d86",
      "username": "edpstest@edenred.com",
      "date": "2021-01-18T08:15:12+01:00",
      "total_amount": 1800,
      "partner_name": "MyOrder",
      "product_class": "ETR",
      "session_id": "b4a1f6267a0479900504cb3ab4a1f626d14050",
      "transaction_details": [
        {
          "type": "edenred",
          "id": "d11a4c64-8004-437a-8b40-9d1574165d86",
          "merchant": {
            "id": "4352345",
            "details": {
              "name": "COLRUYT",
              "address": {
                "address_line_1": "4 PLACE DE LA GARE",
                "zip_code": "04130",
                "city_name": "VOLX"
              }
            }
          },
          "order_ref": "Order-5425",
          "extra_field": "MyOrder|52562",
          "amount": 1800,
          "status": {
            "code": "refused",
            "details": "INSUFFICIENT_FUNDS|Insufficient funds"
          }
        }
      ]
    }
  ]
}