Request a payment method

post/merchants/{merchantId}/paymentMethodSettings

Sends a request to add a new payment method to the merchant account identified in the path.

To make this request, your API credential must have the following role:

  • Management API—Payment methods read and write
Endpoint destination URL
https://management-test.adyen.com/v3/merchants/{merchantId}/paymentMethodSettings
Click to copy

Path Parameters

merchantIdstringRequired

The unique identifier of the merchant account.

Request Parameters

afterpayTouchobject

Afterpay Touch details.

applePayobject

Apple Pay details.

bcmcobject

Bancontact details.

businessLineIdstring

The unique identifier of the business line. Required if you have a platform setup.

cartesBancairesobject

Cartes Bancaires details.

clearpayobject

Clearpay details.

countriesarray[string]

The list of countries where a payment method is available. By default, all countries supported by the payment method.

cupobject

China Union Pay details.

currenciesarray[string]

The list of currencies that a payment method supports. By default, all currencies supported by the payment method.

customRoutingFlagsarray[string]

The list of custom routing flags to route payment to the intended acquirer.

dinersobject

Diners details.

discoverobject

Discover details.

eftpos_australiaobject

Eftpos Australia details.

giroPayobject

giropay details.

girocardobject

Girocard details.

googlePayobject

Google Pay details.

idealobject

iDeal details.

interac_cardobject

Interac Card details.

jcbobject

JCB details.

klarnaobject

Klarna details.

maestroobject

Maestro details.

mcobject

MasterCard details.

mealVoucher_FRobject

Meal Voucher FR details.

paypalobject

PayPal details.

referencestring
Max length: 150

Your reference for the payment method. Supported characters a-z, A-Z, 0-9.

shopperInteractionstring

The sales channel. Required if the merchant account does not have a sales channel. When you provide this field, it overrides the default sales channel set on the merchant account.

Possible values: eCommerce, pos, contAuth, and moto.

sofortobject

Sofort details.

storeIdsarray[string]

The unique identifier of the store for which to configure the payment method, if any.

swishobject

Swish details.

twintobject

Twint details.

typestringRequired

Payment method variant.

vippsobject

Vipps details.

visaobject

Visa details.

Response parameters

After submitting a call, you receive a response message to inform you that your request was received and processed.

Depending on the HTTP status code of the response message, it is helpful to build some logic to handle any errors that a request or the system may return.

HTTP Responses

  • 200 - OK

    The request has succeeded.

    Show moreShow less
  • 204 - No Content

    The request has been successfully processed, but there is no additional content.

  • 400 - Bad Request

    A problem reading or understanding the request.

    Show moreShow less
  • 401 - Unauthorized

    Authentication required.

    Show moreShow less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show moreShow less
  • 422 - Unprocessable Entity

    A request validation error.

    Show moreShow less
  • 500 - Internal Server Error

    The server could not process the request.

    Show moreShow less