Create a payment method configuration
POST / v1 / payment_method_configurations
Creates a payment method configuration
Parameters
- name string Required unless parent is provided Configuration name. The maximum length is 100 characters.
- parent string Required unless name is provided Configuration’s parent configuration. Specify to create a child configuration. The maximum length is 100 characters.
More parameters
- acss _ debit object
- affirm object
- afterpay _ clearpay object
- alipay object
- alma object
- amazon _ pay object
- apple _ pay object
- apple _ pay _ later object
- au _ becs _ debit object
- bacs _ debit object
- bancontact object
- billie object
- bizum object
- blik object
- boleto object
- card object
- cartes _ bancaires object
- cashapp object
- crypto object
- customer _ balance object
- eps object
- fpx object
- fr _ meal _ voucher _ conecs object
- giropay object
- google _ pay object
- grabpay object
- ideal object
- jcb object
- kakao _ pay object
- klarna object
- konbini object
- kr _ card object
- link object
- mb _ way object
- mobilepay object
- multibanco object
- naver _ pay object
- nz _ bank _ account object
- oxxo object
- p24 object
- pay _ by _ bank object
- payco object
- paynow object
- paypal object
- paypay object
- payto object
- pix object
- promptpay object
- revolut _ pay object
- samsung _ pay object
- satispay object
- scalapay object
- sepa _ debit object
- sofort object
- sunbit object
- swish object
- twint object
- upi object
- us _ bank _ account object
- wechat _ pay object
- zip object
Returns
Returns the payment method configuration object
Response
{ "id": "pmc_abcdef", "object": "payment_method_configuration", "acss_debit": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "active": true, "affirm": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "afterpay_clearpay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "alipay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "apple_pay": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "bancontact": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "card": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "cartes_bancaires": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "eps": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "giropay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "google_pay": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "ideal": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "is_default": true, "klarna": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "link": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "livemode": false, "name": "Default", "p24": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "sepa_debit": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "sofort": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "us_bank_account": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "wechat_pay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }}
Update payment method configuration
POST / v1 / payment_method_configurations /:id
Update payment method configuration
Parameters
- active boolean Whether the configuration can be used for new payments.
- name string Configuration name. The maximum length is 100 characters.
More parameters
- acss _ debit object
- affirm object
- afterpay _ clearpay object
- alipay object
- alma object
- amazon _ pay object
- apple _ pay object
- apple _ pay _ later object
- au _ becs _ debit object
- bacs _ debit object
- bancontact object
- billie object
- bizum object
- blik object
- boleto object
- card object
- cartes _ bancaires object
- cashapp object
- crypto object
- customer _ balance object
- eps object
- fpx object
- fr _ meal _ voucher _ conecs object
- giropay object
- google _ pay object
- grabpay object
- ideal object
- jcb object
- kakao _ pay object
- klarna object
- konbini object
- kr _ card object
- link object
- mb _ way object
- mobilepay object
- multibanco object
- naver _ pay object
- nz _ bank _ account object
- oxxo object
- p24 object
- pay _ by _ bank object
- payco object
- paynow object
- paypal object
- paypay object
- payto object
- pix object
- promptpay object
- revolut _ pay object
- samsung _ pay object
- satispay object
- scalapay object
- sepa _ debit object
- sofort object
- sunbit object
- swish object
- twint object
- upi object
- us _ bank _ account object
- wechat _ pay object
- zip object
Returns
An object with the updated account payment method configuration
Response
{ "id": "pmc_abcdef", "object": "payment_method_configuration", "acss_debit": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "active": true, "affirm": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "afterpay_clearpay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "alipay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "apple_pay": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "bancontact": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "card": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "cartes_bancaires": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "eps": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "giropay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "google_pay": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "ideal": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "is_default": true, "klarna": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "link": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "livemode": false, "name": "Default", "p24": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "sepa_debit": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "sofort": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "us_bank_account": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "wechat_pay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }}
Retrieve payment method configuration
GET / v1 / payment_method_configurations /:id
Retrieve payment method configuration
Parameters
No parameters.
Returns
A payment method configuration object.
Response
{ "id": "pmc_abcdef", "object": "payment_method_configuration", "acss_debit": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "active": true, "affirm": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "afterpay_clearpay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "alipay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "apple_pay": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "bancontact": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "card": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "cartes_bancaires": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "eps": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "giropay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "google_pay": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "ideal": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "is_default": true, "klarna": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "link": { "available": true, "display_preference": { "overridable": null, "preference": "on", "value": "on" } }, "livemode": false, "name": "Default", "p24": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "sepa_debit": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "sofort": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "us_bank_account": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }, "wechat_pay": { "available": false, "display_preference": { "overridable": null, "preference": "off", "value": "off" } }}