Core Resources
Payment Methods
Products
Checkout
Payment Links
Billing
Capital
Connect
Reserves
Fraud
Issuing
Terminal
Treasury
Entitlements
Sigma
Reporting
Financial Connections
Tax
Identity
Crypto
Climate
Forwarding
Privacy
Webhooks

Create a payment method configuration 

Creates a payment method configuration

Parameters

  • namestringRequired unless parent is provided

    Configuration name.

  • parentstringRequired unless name is provided

    Configuration’s parent configuration. Specify to create a child configuration.

More parameters

  • acss_debitdictionary

  • affirmdictionary

  • afterpay_clearpaydictionary

  • alipaydictionary

  • almadictionary

  • amazon_paydictionary

  • apple_paydictionary

  • apple_pay_laterdictionary

  • au_becs_debitdictionary

  • bacs_debitdictionary

  • bancontactdictionary

  • billiedictionary

  • blikdictionary

  • boletodictionary

  • carddictionary

  • cartes_bancairesdictionary

  • cashappdictionary

  • customer_balancedictionary

  • epsdictionary

  • fpxdictionary

  • giropaydictionary

  • google_paydictionary

  • grabpaydictionary

  • idealdictionary

  • jcbdictionary

  • kakao_paydictionary

  • klarnadictionary

  • konbinidictionary

  • kr_carddictionary

  • linkdictionary

  • mobilepaydictionary

  • multibancodictionary

  • naver_paydictionary

  • nz_bank_accountdictionary

  • oxxodictionary

  • p24dictionary

  • pay_by_bankdictionary

  • paycodictionary

  • paynowdictionary

  • paypaldictionary

  • pixdictionary

  • promptpaydictionary

  • revolut_paydictionary

  • samsung_paydictionary

  • satispaydictionary

  • sepa_debitdictionary

  • sofortdictionary

  • swishdictionary

  • twintdictionary

  • us_bank_accountdictionary

  • wechat_paydictionary

  • zipdictionary

Returns

Returns the payment method configuration object

POST /v1/payment_method_configurations
curl https://api.stripe.com/v1/payment_method_configurations \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d name="Buy Now Pay Laters"
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 

Update payment method configuration

Parameters

  • activeboolean

    Whether the configuration can be used for new payments.

  • namestring

    Configuration name.

More parameters

  • acss_debitdictionary

  • affirmdictionary

  • afterpay_clearpaydictionary

  • alipaydictionary

  • almadictionary

  • amazon_paydictionary

  • apple_paydictionary

  • apple_pay_laterdictionary

  • au_becs_debitdictionary

  • bacs_debitdictionary

  • bancontactdictionary

  • billiedictionary

  • blikdictionary

  • boletodictionary

  • carddictionary

  • cartes_bancairesdictionary

  • cashappdictionary

  • customer_balancedictionary

  • epsdictionary

  • fpxdictionary

  • giropaydictionary

  • google_paydictionary

  • grabpaydictionary

  • idealdictionary

  • jcbdictionary

  • kakao_paydictionary

  • klarnadictionary

  • konbinidictionary

  • kr_carddictionary

  • linkdictionary

  • mobilepaydictionary

  • multibancodictionary

  • naver_paydictionary

  • nz_bank_accountdictionary

  • oxxodictionary

  • p24dictionary

  • pay_by_bankdictionary

  • paycodictionary

  • paynowdictionary

  • paypaldictionary

  • pixdictionary

  • promptpaydictionary

  • revolut_paydictionary

  • samsung_paydictionary

  • satispaydictionary

  • sepa_debitdictionary

  • sofortdictionary

  • swishdictionary

  • twintdictionary

  • us_bank_accountdictionary

  • wechat_paydictionary

  • zipdictionary

Returns

An object with the updated account payment method configuration

POST /v1/payment_method_configurations/:id
curl https://api.stripe.com/v1/payment_method_configurations/pmc_abcdef \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:" \
  -d "acss_debit[display_preference][preference]"=on
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 

Retrieve payment method configuration

Parameters

No parameters.

Returns

A payment method configuration object.

GET /v1/payment_method_configurations/:id
curl https://api.stripe.com/v1/payment_method_configurations/pmc_abcdef \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
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"
    }
  }
}

List payment method configurations 

List payment method configurations

Parameters

No parameters.

More parameters

  • applicationstring

  • ending_beforestring

  • limitinteger

  • starting_afterstring

Returns

A list of all payment method configuration objects

GET /v1/payment_method_configurations
curl https://api.stripe.com/v1/payment_method_configurations \
  -u "sk_test_BQokikJ...2HlWgH4olfQ2sk_test_BQokikJOvBiI2HlWgH4olfQ2:"
Response
{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "id": "pmc_1JwXwt2eZvKYlo2CHV7mUH3p",
      "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"
        }
      }
    }
  ]
}

Payment Method Domains 

A payment method domain represents a web domain that you have registered with Stripe. Stripe Elements use registered payment method domains to control where certain payment methods are shown.

Related guide: Payment method domains.

Endpoints