Skip to main content

Edenred

Craftgate is integrated with Edenred which is one of the alternative payment methods. With the API and the Common Payment Page, you can easily receive payments from Edenred users.

Things to do first​

In order to use the Edenred integration, you must have completed the following steps.

  1. Alternative Payment Methods must be On on Merchant Panel > Administration > Merchant Settings > Craftgate Features list.

    Alternative Payment Methods in Craftgate Features

  2. Enter the information sent to you by Edenred on Merchant Panel > Administration > APM Management > Add New Apm.

    Edenred integration settings

Payment via Edenred​

You can receive payments from Edenred users via Craftgate API and Common Payment Page. See: Payment with Payment Form

Payment via Edenred From API​

You can integrate with alternative payment methods service via Craftgate API to receive Edenred payments. Payment via Edenred from API has 2 steps.

note

In order to receive payments with Edenred Ticket Compliments Card, apmType should be sent as 'EDENRED_GIFT'.

1. APM Payment Init: You should send additional parameters like below for init Edenred Payment.

apmUserIdentity
string
required

The card number of Edenred card. Size should be 16 and should be numeric.

externalId
string

You can send your order id to Edenred if you want. The system automatically creates one for you if not sent in the request.

If APM Payment Init Response additionalAction field has value OTP_REQUIRED, APM Payment Complete request is needed for completion. If additionalAction has value NONE, payment is completed no additional step needed.

For more information, see Pay With Alternative Payment Methods

2. APM Payment Complete: You should complete Edenred APM payment after init completed. You should send additional parameters like below for complete.

paymentId
number
required

Payment id.

additionalParams
map
required

Edenred verification code should be placed in this parameter like this["otpCode" : "123456"].

For more information, see Complete Alternative Payment Methods

Payment via Edenred From Common Payment Page​

The payment experience and flow can be summarized as follows.

  1. The following notification message will be displayed when the Edenred tab is selected.

    Edenred Common Payment Page Tab

  2. Verification code input will be displayed when Pay button is clicked.

    Edenred Common Payment Page Tab

  3. When the user write own Edenred card number and verificaiton code which by sent Edenred and the Pay button is clicked, payment will be completed and the user is directed to the callbackUrl address which is sent while payment form init request. See: Payment with Payment Form

Receive Payment Only via Edenred​

If you send ["EDENRED"] with the enabledPaymentMethods parameter in the payment form initiation request, the card payment tab will not be displayed to the user. Only the Edenred tab will be accessible.

Only Edenred Tab
note

In order to receive payments with Edenred Ticket Compliments Card, 'EDENRED_GIFT' value should be sent in enabledPaymentMethods field.

Sample Codes for Init Edenred APM​

Java.NETPHPNode.jsGo

Sample Codes for Complete Edenred APM​

Java.NETPHPNode.jsGo