GET
/v1/payment_method_configurations/{configuration}Retrieve a payment method configuration
Retrieves a payment method configuration by its identifier. Use expand to include selected related fields directly in the response. The response contains the configuration's active state, default state, associated application, and payment method settings.
- RetriesRetries up to 2×, 500ms backoff, 30s timeout.
configurationstringrequired
The identifier of the payment method configuration to retrieve. Maximum 5000 characters.
expandarray<string>optional
Fields to expand in the returned configuration; each expansion name can be no longer than 5000 characters.
200Returns the Payment Method Configuration object, including its identifier, active state, default state, name, associated application, and per-method availability and display settings.
acss_debitobjectoptional
activebooleanrequired
Whether the configuration can be used for new payments.
affirmobjectoptional
afterpay_clearpayobjectoptional
alipayobjectoptional
almaobjectoptional
amazon_payobjectoptional
apple_payobjectoptional
applicationstringoptional
For child configs, the Connect application associated with the configuration.
au_becs_debitobjectoptional
bacs_debitobjectoptional
bancontactobjectoptional
billieobjectoptional
bizumobjectoptional
blikobjectoptional
boletoobjectoptional
cardobjectoptional
cartes_bancairesobjectoptional
cashappobjectoptional
cryptoobjectoptional
customer_balanceobjectoptional
epsobjectoptional
fpxobjectoptional
giropayobjectoptional
google_payobjectoptional
grabpayobjectoptional
idstringrequired
Unique identifier for the object.
idealobjectoptional
is_defaultbooleanrequired
The default configuration is used whenever a payment method configuration is not specified.
jcbobjectoptional
kakao_payobjectoptional
klarnaobjectoptional
konbiniobjectoptional
kr_cardobjectoptional
linkobjectoptional
livemodebooleanrequired
If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`.
mb_wayobjectoptional
mobilepayobjectoptional
multibancoobjectoptional
namestringrequired
The configuration's name.
naver_payobjectoptional
nz_bank_accountobjectoptional
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
oxxoobjectoptional
p24objectoptional
parentstringoptional
For child configs, the configuration's parent configuration.
pay_by_bankobjectoptional
paycoobjectoptional
paynowobjectoptional
paypalobjectoptional
paytoobjectoptional
pixobjectoptional
promptpayobjectoptional
revolut_payobjectoptional
samsung_payobjectoptional
satispayobjectoptional
scalapayobjectoptional
sepa_debitobjectoptional
sofortobjectoptional
sunbitobjectoptional
swishobjectoptional
twintobjectoptional
upiobjectoptional
us_bank_accountobjectoptional
wechat_payobjectoptional
zipobjectoptional
defaultError response.
errorobjectrequired
Error handling
configuration must identify the payment method configuration to retrieve and must be no longer than 5000 characters. Each expand value must also be no longer than 5000 characters.