Composable Frontend 2.0 Learn more 

  • Payments/
    Payment Gateways API/
    Configure Adyen

    Configure Adyen

    PUT Update Adyen settings

    https://useast.api.elasticpath.com/v2/gateways/adyen
    

    Use this endpoint to configure Adyen.

    Parameters

    Headers

    NameRequiredTypeDescription
    AuthorizationRequiredstringThe Bearer token required to get access to the API.

    Body

    NameRequiredTypeDescription
    merchant_accountRequiredstringRepresents your Adyen merchant account code. For example, MyCompanyECOM.
    usernameRequiredstringIndicates your web service username. For example, ws@Company.MyCompany.
    passwordRequiredstringSpecifies your web service user Basic Auth password.
    testOptionalbooleanSpecifies whether the test account is enabled or disabled. Set true to enable the test account and false to disable the test account. Default is false.
    enabledOptionalbooleanSpecifies whether the gateway is enabled or disabled. Set true to enable the gateway and false to disable the gateway. Default is false.

    Request Example

    curl -X PUT https://useast.api.elasticpath.com/v2/gateways/adyen \
         -H "Content-Type: application/json" \
         -H "Authorization: Bearer XXX" \
         -d $ {
            "data": {
               "enabled": true,
               "merchant_account": "MyCompanyECOM",
               "username": "ws@Company.MyCompany",
               "password": "xxx",
               "test": false
            }
         }
    

    Response Example

    200 OK

    {
      "data": {
        "merchant_account": "MyCompanyECOM",
        "username": "ws@Company.MyCompany",
        "password": "xxx",
        "test": false,
        "enabled": true,
        "name": "Adyen",
        "slug": "adyen",
        "type": "gateway"
      }
    }
    
    Previous
    Configure Manual Gateway