# payment\_method

From **Stripe API**.

PaymentMethod objects represent your customer's payment instruments.
They can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to
Customer objects to store instrument details for future payments.

Related guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).

- Type: `object`

## Properties

### `acss_debit`

- Required: false
- Type: `object`

### `afterpay_clearpay`

- Required: false
- Type: `object`

### `alipay`

- Required: false
- Type: `object`

### `au_becs_debit`

- Required: false
- Type: `object`

### `bacs_debit`

- Required: false
- Type: `object`

### `bancontact`

- Required: false
- Type: `object`

### `billing_details`

- Required: true
- Type: `object`

### `boleto`

- Required: false
- Type: `object`

### `card`

- Required: false
- Type: `object`

### `card_present`

- Required: false
- Type: `object`

### `created`

- Required: true
- Type: `integer`
- Format: `unix-time`

Time at which the object was created. Measured in seconds since the Unix epoch.

### `customer`

- Required: false
- Nullable: true

The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.

### `eps`

- Required: false
- Type: `object`

### `fpx`

- Required: false
- Type: `object`

### `giropay`

- Required: false
- Type: `object`

### `grabpay`

- Required: false
- Type: `object`

### `id`

- Required: true
- Type: `string`
- maxLength: `5000`

Unique identifier for the object.

### `ideal`

- Required: false
- Type: `object`

### `interac_present`

- Required: false
- Type: `object`

### `klarna`

- Required: false
- Type: `object`

### `livemode`

- Required: true
- Type: `boolean`

Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.

### `metadata`

- Required: false
- Type: `object`
- Nullable: true

Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.

### `object`

- Required: true
- Type: `string`
- Allowed values: `"payment_method"`

String representing the object's type. Objects of the same type share the same value.

### `oxxo`

- Required: false
- Type: `object`

### `p24`

- Required: false
- Type: `object`

### `sepa_debit`

- Required: false
- Type: `object`

### `sofort`

- Required: false
- Type: `object`

### `type`

- Required: true
- Type: `string`
- Allowed values: `"acss_debit"`, `"afterpay_clearpay"`, `"alipay"`, `"au_becs_debit"`, `"bacs_debit"`, `"bancontact"`, `"boleto"`, `"card"`, `"card_present"`, `"eps"`, `"fpx"`, `"giropay"`, `"grabpay"`, `"ideal"`, `"interac_present"`, `"klarna"`, `"oxxo"`, `"p24"`, `"sepa_debit"`, `"sofort"`, `"wechat_pay"`

The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.

### `wechat_pay`

- Required: false
- Type: `object`

## JSON Schema

```json
{"description":"PaymentMethod objects represent your customer's payment instruments.\nThey can be used with [PaymentIntents](https://stripe.com/docs/payments/payment-intents) to collect payments or saved to\nCustomer objects to store instrument details for future payments.\n\nRelated guides: [Payment Methods](https://stripe.com/docs/payments/payment-methods) and [More Payment Scenarios](https://stripe.com/docs/payments/more-payment-scenarios).","properties":{"acss_debit":{"$ref":"#/components/schemas/payment_method_acss_debit"},"afterpay_clearpay":{"$ref":"#/components/schemas/payment_method_afterpay_clearpay"},"alipay":{"$ref":"#/components/schemas/payment_flows_private_payment_methods_alipay"},"au_becs_debit":{"$ref":"#/components/schemas/payment_method_au_becs_debit"},"bacs_debit":{"$ref":"#/components/schemas/payment_method_bacs_debit"},"bancontact":{"$ref":"#/components/schemas/payment_method_bancontact"},"billing_details":{"$ref":"#/components/schemas/billing_details"},"boleto":{"$ref":"#/components/schemas/payment_method_boleto"},"card":{"$ref":"#/components/schemas/payment_method_card"},"card_present":{"$ref":"#/components/schemas/payment_method_card_present"},"created":{"description":"Time at which the object was created. Measured in seconds since the Unix epoch.","format":"unix-time","type":"integer"},"customer":{"anyOf":[{"maxLength":5000,"type":"string"},{"$ref":"#/components/schemas/customer"}],"description":"The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.","nullable":true,"x-expansionResources":{"oneOf":[{"$ref":"#/components/schemas/customer"}]}},"eps":{"$ref":"#/components/schemas/payment_method_eps"},"fpx":{"$ref":"#/components/schemas/payment_method_fpx"},"giropay":{"$ref":"#/components/schemas/payment_method_giropay"},"grabpay":{"$ref":"#/components/schemas/payment_method_grabpay"},"id":{"description":"Unique identifier for the object.","maxLength":5000,"type":"string"},"ideal":{"$ref":"#/components/schemas/payment_method_ideal"},"interac_present":{"$ref":"#/components/schemas/payment_method_interac_present"},"klarna":{"$ref":"#/components/schemas/payment_method_klarna"},"livemode":{"description":"Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.","type":"boolean"},"metadata":{"additionalProperties":{"maxLength":500,"type":"string"},"description":"Set of [key-value pairs](https://stripe.com/docs/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format.","nullable":true,"type":"object"},"object":{"description":"String representing the object's type. Objects of the same type share the same value.","enum":["payment_method"],"type":"string"},"oxxo":{"$ref":"#/components/schemas/payment_method_oxxo"},"p24":{"$ref":"#/components/schemas/payment_method_p24"},"sepa_debit":{"$ref":"#/components/schemas/payment_method_sepa_debit"},"sofort":{"$ref":"#/components/schemas/payment_method_sofort"},"type":{"description":"The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.","enum":["acss_debit","afterpay_clearpay","alipay","au_becs_debit","bacs_debit","bancontact","boleto","card","card_present","eps","fpx","giropay","grabpay","ideal","interac_present","klarna","oxxo","p24","sepa_debit","sofort","wechat_pay"],"type":"string","x-stripeBypassValidation":true},"wechat_pay":{"$ref":"#/components/schemas/payment_method_wechat_pay"}},"required":["billing_details","created","id","livemode","object","type"],"title":"PaymentMethod","type":"object","x-expandableFields":["acss_debit","afterpay_clearpay","alipay","au_becs_debit","bacs_debit","bancontact","billing_details","boleto","card","card_present","customer","eps","fpx","giropay","grabpay","ideal","interac_present","klarna","oxxo","p24","sepa_debit","sofort","wechat_pay"],"x-resourceId":"payment_method"}
```
