Edenred Direct Payment Services

I. Generalities

In Chile, a user can spend the exact amount requested, with a minimum of 1000 CLP for each order. These regulations are handled on the Edenred side. Please note the amount is managed in cents (example 1000 CLP = 100000).

Ticket Restaurant local regulation

In Chile, for the Ticket Restaurant product, a user can:

• Perform a transaction with a minimum of 1000 CLP (which meaning that a transaction of 999 CLP will be declined). Reminder: 1000 CLP corresponds to amount = 100000.

Note this check is performed by the local authorization platform itself. Error code related to those limits are described in the specification of the transaction processing.

Junaeb local regulation

In Chile, for the Ticket Junaeb product, a user can:

• Perform a transaction with a minimum of 200 CLP and a maximum of 320000 CLP (which meaning that a transaction of 199 or 320001 CLP will be declined). Reminder: 200 CLP corresponds to amount = 20000.
• Perform maximum 99 transactions per day.

Note this check is performed by the local authorization platform itself. Error code related to those limits are described in the specification of the transaction processing.

II. User Security Tokens

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

Login

1) To test the API in sandbox, you can get an authorization_code by clicking on the link bellow:

Ticket Restaurant:

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

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

• Username: 17938390K
• Password: Edenred2020
• PAN: 5305

Junaeb:

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

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

• Username: 262695484
• Password: Edenred2021
• PAN: 4850

Authentication flow for both

1. Login Page
2. Card selection
3. Confirm 2nd factor (Masked PAN code)
4. Accept Term and Conditions

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

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

3) Retrieve the authorization_code in the callback URL and paste it in the body of the request "Get access_token from authorization_code".

You can test our APIs in the following collection of API calls :

Ticket Restaurant:

Junaeb:

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

Enable to Logout the user and his Edenred account from your platform.

All tokens (refresh, accesss....) are then invalid

GET /connect/endsession?id_token_hint==HTTP/1.1

Host: {{authentication-URL}}

Where

• 'authentication-URL' = {{authentication-URL}} (check Home page to get the URL per environment)
• 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.

####

Get Balances

Get the balance which is available on the user's account.

The authorization header is mandatory for this request.

Request:

GET /v2/users/{username} HTTP/1.1

Host: {{payment-URL}} (https://directpayment.stg.eu.edenred.io/v2)

Authorization: Bearer {{token}}

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

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

Response:

{

    "meta": {

        "status": "succeeded",

        "messages": []

    },

    "data": [

        {

            "available_amount": 224300,

            "currency": "CLP"

        }

    ]

}

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": 300000

}

Response:

{

    "meta": {

        "status": "succeeded",

        "messages": []

    },

    "data": {

        "available_amount": 224300,

        "currency": "CLP"

    }

}

####

Payment

There is only one capture method supported on the authorization platform : automatic capture of the payment (Capture Mode is set to Auto).

An auto capture can only be requested with an amount in CLP.

The authorization header should be set for this operation.

The idempotency/duplicate check is applied based on the "username / amount / MID" check. Timestamp is not mandatory to trigger the idempotency/duplicate check on the authorization platform.

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

{

  "mid": "{{mid}}",

  "order_ref": "Test290121",

  "amount": 100000,

  "capture_mode": "auto",

  "security_level": "standard",

  "currency": "CLP",

  "tstamp": "2021-01-29T10:31:09Z"

}

Response:

{

    "meta": {

        "status": "succeeded",

        "messages": []

    },

    "data": {

        "order_ref": "Test290121",

        "mid": "1",

        "authorization_id": "b9064d12-93f9-46bf-921b-11f24e58e5b2",

        "authorized_amount": 100000,

        "capture_id": "752947",

        "captured_amount": 100000,

        "status": "captured"

    }

}

Please keep in mind that the minimum amount is 1000 CLP (which represents amount=100000).

Order_ref must be updated for every transaction.

####

Refund a captured payment

Once captured, a transaction can be refunded.

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

the exact "capture_amount" must be provided in the amount field. No partial refund supported

The Authorization {{bearer}} don't have to be provided in the header for this operation.

The authorization_id is used by the platform to retrieve the existing authorization and process the enrichment of the request with the information of this transaction.

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": 100000,

"currency": "CLP",

"tstamp": "2021-01-29T14:02:50Z"

}

Response

{

    "meta": {

       "status": "succeeded",

        "messages": []

    },

    "data": {

        "mid": "1",

        "refund_id": "b124de1c-df0f-4f26-aefd-0b98b7e96b29",

        "refunded_amount": 100000,

        "status": "refunded"

    }

}

Mapped status codes