Sign in

v1

latestOpenAPI 3.1.02026-07-241080412.6 KB

Payment with Adyen

Use /connectors/adyen/initial-payment endpoint to perform payment with Adyen (that means payment with card with 3D Secure support, Apple Pay or Google Pay).

post/connectors/adyen/initial-payment

Request body

orderIdinteger required

ID of Cleeng order. Order should have paymentMethodId that represents Adyen paymentGateway and selected methodName.

returnUrlstring required

The URL to return to in case of a redirection (eg. after completing 3D Secure authentication). The URL should include the protocol http:// or https://. For example, https://your-company.com/checkout/. You can also include your own additional query parameters, for example, customer ID or order ID. Max: 1024 characters.

customerIPstring

IP address of customer current location. If not given, the IP of the request will be used.

browserInfoobject

Required for the 3D Secure. The customer's browser information. The state.data.browserInfo object from the Adyen's Dropin onSubmit event.

originstring

Required for the 3D Secure. Set this parameter to the origin URL of the page that you are loading the 3D Secure Component from.

attemptAuthenticationstring

Accepted only on the sandbox environment. It helps to control when 3DSecure should be triggered. Accepted values: always, never, preferNo. Default: preferNo

enable3DSRedirectFlowstring

Accepted only on the sandbox environment. Default: false. Set to true to force 3DS redirect flow.

captchaValuestring

To integrate Google reCAPTCHA go HERE

Response

200

OR

Example response

{
  "responseData": {
    "payment": {
      "id": 1538290265,
      "orderId": 359630536,
      "status": "authorized",
      "totalAmount": 20.9963,
      "currency": "EUR",
      "customerId": 686909867,
      "paymentGateway": "adyen",
      "paymentMethod": "card",
      "externalPaymentId": "N3MMRD2SDV5X8N82",
      "amount": 16.26,
      "country": "PL",
      "offerType": "subscription",
      "offerId": "S123456789_PL",
      "taxValue": 3.74,
      "paymentMethodFee": 0.81,
      "paymentDetailsId": 208583452,
      "paymentOperation": "initial-payment",
      "gatewaySpecificParams": {
        "merchantAccount": "CleengEUR"
      }
    }
  }
}