ManagementPayment methods merchant level

Get all payment methods

GET
/merchants/{merchantId}/paymentMethodSettings

Returns details for all payment methods of the merchant account identified in the path.

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

  • Management API—Payment methods read

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

merchantId*string

The unique identifier of the merchant account.

Query Parameters

storeId?string

The unique identifier of the store for which to return the payment methods.

businessLineId?string

The unique identifier of the Business Line for which to return the payment methods.

pageSize?integer

The number of items to have on a page, maximum 100. The default is 10 items on a page.

Formatint32
pageNumber?integer

The number of the page to fetch.

Formatint32

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/merchants/string/paymentMethodSettings"
{  "_links": {    "first": {      "href": "string"    },    "last": {      "href": "string"    },    "next": {      "href": "string"    },    "prev": {      "href": "string"    },    "self": {      "href": "string"    }  },  "data": [    {      "accel": {        "processingType": "billpay",        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "affirm": {        "pricePlan": "BRONZE",        "supportEmail": "string"      },      "afterpayTouch": {        "supportEmail": "string",        "supportUrl": "string"      },      "alipayPlus": {        "settlementCurrencyCode": "string"      },      "allowed": true,      "amex": {        "midNumber": "string",        "reuseMidNumber": false,        "serviceLevel": "noContract"      },      "applePay": {        "domains": [          "string"        ]      },      "bcmc": {        "enableBcmcMobile": true      },      "businessLineId": "string",      "cartesBancaires": {        "siret": "string",        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "clearpay": {        "supportUrl": "string"      },      "countries": [        "string"      ],      "cup": {        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "currencies": [        "string"      ],      "customRoutingFlags": [        "string"      ],      "diners": {        "midNumber": "string",        "reuseMidNumber": false,        "serviceLevel": "noContract",        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "discover": {        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "eft_directdebit_CA": {        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "eftpos_australia": {        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "enabled": true,      "girocard": {        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "givex": {        "currencyCode": "string",        "password": "string",        "paymentFlow": "Ecommerce",        "username": "string"      },      "googlePay": {        "merchantId": "stringstringstri",        "reuseMerchantId": true      },      "id": "string",      "ideal": {        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "interac_card": {        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "jcb": {        "midNumber": "string",        "reuseMidNumber": false,        "serviceLevel": "noContract",        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "klarna": {        "autoCapture": true,        "disputeEmail": "string",        "region": "NA",        "supportEmail": "string"      },      "maestro": {        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "maestro_usa": {        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "mc": {        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "mealVoucher_FR": {        "conecsId": "string",        "siret": "stringstringst",        "subTypes": [          "string"        ]      },      "nyce": {        "processingType": "billpay",        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "paybybank_plaid": {        "logo": "string",        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "payme": {        "displayName": "string",        "logo": "string",        "supportEmail": "string"      },      "paypal": {        "directCapture": true,        "payerId": "stringstrings",        "subject": "string"      },      "payto": {        "merchantName": "string",        "payToPurpose": "string"      },      "pulse": {        "processingType": "billpay",        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "reference": "string",      "sepadirectdebit": {        "creditorId": "string",        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "shopperInteraction": "string",      "sodexo": {        "merchantContactPhone": "string"      },      "sofort": {        "currencyCode": "string",        "logo": "string"      },      "star": {        "processingType": "billpay",        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "storeIds": [        "string"      ],      "svs": {        "authorisationMid": "string",        "currencyCode": "string"      },      "swish": {        "swishNumber": "stringstri"      },      "ticket": {        "requestorId": "string"      },      "twint": {        "logo": "string"      },      "type": "string",      "valuelink": {        "authorisationMid": "string",        "pinSupport": "PIN",        "submitterId": "string",        "terminalId": "string"      },      "verificationStatus": "valid",      "vipps": {        "logo": "string",        "subscriptionCancelUrl": "string"      },      "visa": {        "transactionDescription": {          "doingBusinessAsName": "string",          "type": "append"        }      },      "wechatpay": {        "contactPersonName": "string",        "email": "string"      },      "wechatpay_pos": {        "contactPersonName": "string",        "email": "string"      }    }  ],  "itemsTotal": 0,  "pagesTotal": 0,  "typesWithErrors": [    "abrapetite"  ]}