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{merchantId}/paymentMethodSettings
Click to copy

Path parameters

merchantId string Required

The unique identifier of the merchant account.

Request parameters

afterpayTouch object

Afterpay Touch details.

applePay object

Apple Pay details.

bcmc object

Bancontact details.

businessLineId string

The unique identifier of the business line.

cartesBancaires object

Cartes Bancaires details.

clearpay object

Clearpay details.

countries array [string]

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

cup object

China Union Pay details.

currencies array [string]

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

customRoutingFlags array [string]

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

diners object

Diners details.

discover object

Discover details.

eftpos_australia object

Eftpos Australia details.

giroPay object

giropay details.

girocard object

Girocard details.

googlePay object

Google Pay details.

ideal object

iDeal details.

interac_card object

Interac Card details.

jcb object

JCB details.

klarna object

Klarna details.

maestro object

Maestro details.

mc object

MasterCard details.

mealVoucher_FR object

Meal Voucher FR details.

paypal object

PayPal details.

reference string
Max length: 150

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

shopperInteraction string

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.

sofort object

Sofort details.

storeId string

The ID of the store, if any.

swish object

Swish details.

twint object

Twint details.

type string

Payment method variant.

vipps object

Vipps details.

visa object

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 more Show 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 more Show less
  • 401 - Unauthorized

    Authentication required.

    Show more Show less
  • 403 - Forbidden

    Insufficient permissions to process the request.

    Show more Show less
  • 422 - Unprocessable Entity

    A request validation error.

    Show more Show less
  • 500 - Internal Server Error

    The server could not process the request.

    Show more Show less
  • Request
  • Click to copy
  • Response
  • Click to copy