ManagementPayment methods merchant level

Update a payment method

PATCH
/merchants/{merchantId}/paymentMethodSettings/{paymentMethodId}

Updates payment method details for the merchant account and the payment method identified in the path. Depending the payment method type, you may need to send an additional object required for the payment method.

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

  • Management API—Payment methods read and write

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

merchantId*string

The unique identifier of the merchant account.

paymentMethodId*string

The unique identifier of the payment method.

Request Body

application/json

accel?

Details to provide if type is accel.

bcmc?

Details to provide if type is bcmc (Bancontact).

cartesBancaires?

Details to provide if type is cartebancaire.

countries?array<string>

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

cup?
currencies?array<string>

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

customRoutingFlags?array<string>

Custom routing flags for acquirer routing.

diners?
discover?
eft_directdebit_CA?
eftpos_australia?
enabled?boolean

Indicates whether the payment method is enabled (true) or disabled (false).

girocard?
ideal?
interac_card?
jcb?
maestro?
maestro_usa?
mc?
nyce?

Details to provide if type is nyce.

paybybank_plaid?

Details to provide if type is paybybank_plaid.

pulse?

Details to provide if type is pulse.

sepadirectdebit?

Details to provide if type is sepadirectdebit.

star?

Details to provide if type is star.

storeId?string

The store for this payment method

storeIds?array<string>
Deprecated

The list of stores for this payment method

visa?

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/merchants/string/paymentMethodSettings/string" \  -H "Content-Type: application/json" \  -d '{    "currencies": [      "EUR"    ],    "countries": [      "NL"    ]  }'

Currency and country details updated for the payment method

{  "mc": {    "transactionDescription": {      "doingBusinessAsName": "YOUR_BUSINESS_NAME",      "type": "fixed"    }  },  "id": "PM322DZ243226G5LKBTGM7FBQ",  "type": "mc",  "enabled": true,  "countries": [    "NL"  ],  "currencies": [    "EUR"  ],  "customRoutingFlags": []}