Stripe: Charges schemas (part 1)
25 Stripe schemas with complete fields and constraints.
← Charges operations · All schemas
Create a charge — request body — body / card / object: card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address_city | string | Optional | Maximum length: 5000 |
address_country | string | Optional | Maximum length: 5000 |
address_line1 | string | Optional | Maximum length: 5000 |
address_line2 | string | Optional | Maximum length: 5000 |
address_state | string | Optional | Maximum length: 5000 |
address_zip | string | Optional | Maximum length: 5000 |
cvc | string | Optional | Maximum length: 5000 |
encrypted | string | Optional | Maximum length: 5000 |
exp_month | integer | Required within parent | |
exp_year | integer | Required within parent | |
metadata | object | Optional | Additional keys: see wildcard field |
metadata.* | string | Additional keys | |
name | string | Optional | Maximum length: 5000 |
network_token | object | Optional | |
network_token.number | string | Optional | Maximum length: 5000 |
number | string | Required within parent | Maximum length: 5000 |
object | string | Optional | One of: card Maximum length: 5000 |
swipe_data | string | Optional | Maximum length: 5000 |
Create a charge — request body — body shipping
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Shipping information for the charge. Helps prevent fraud on charges for physical goods. |
address | object | Required within parent | |
address.city | string | Optional | Maximum length: 5000 |
address.country | string | Optional | Maximum length: 5000 |
address.line1 | string | Optional | Maximum length: 5000 |
address.line2 | string | Optional | Maximum length: 5000 |
address.postal_code | string | Optional | Maximum length: 5000 |
address.state | string | Optional | Maximum length: 5000 |
carrier | string | Optional | Maximum length: 5000 |
name | string | Required within parent | Maximum length: 5000 |
phone | string | Optional | Maximum length: 5000 |
tracking_number | string | Optional | Maximum length: 5000 |
Create a charge — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | The `Charge` object represents a single attempt to move money into your Stripe account. PaymentIntent confirmation is the most common way to create Charges, but [Account Debits](https://docs.stripe.com/connect/account-debits) may also create Charges. The create and capture methods are deprecated and will be deleted soon. If your integration uses either of them, you need to update it to use a different payment flow, such as [the Payment Intents API](https://docs.stripe.com/payments/payment-intents). |
amount | JSON | Required within parent | |
amount (anyOf 1) | integer | Alternative | Amount intended to be collected by this payment. A positive integer representing how much to charge in the [smallest currency unit](https://docs.stripe.com/currencies#zero-decimal) (e.g., 100 cents to charge $1.00 or 100 to charge ¥100, a zero-decimal currency). The minimum amount is $0.50 US or [equivalent in charge currency](https://docs.stripe.com/currencies#minimum-and-maximum-charge-amounts). The amount value supports up to eight digits (e.g., a value of 99999999 for a USD charge of $999,999.99). |
amount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_captured | JSON | Required within parent | |
amount_captured (anyOf 1) | integer | Alternative | Amount in cents (or local equivalent) captured (can be less than the amount attribute on the charge if a partial capture was made). |
amount_captured (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
amount_refunded | JSON | Required within parent | |
amount_refunded (anyOf 1) | integer | Alternative | Amount in cents (or local equivalent) refunded (can be less than the amount attribute on the charge if a partial refund was issued). |
amount_refunded (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
application | JSON | Optional | |
application (anyOf 1) | JSON | Alternative | ID of the Connect application that created the charge. |
application (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
application (anyOf 1) (anyOf 2) | Model | Alternative | Expand PostApplicationFeesIdRefund — response body — application / object: application |
application (anyOf 2) | null | Alternative | |
application_fee | JSON | Optional | |
application_fee (anyOf 1) | JSON | Alternative | The application fee (if any) for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. |
application_fee (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
application_fee (anyOf 1) (anyOf 2) | Model | Alternative | Expand Post Application Fees Id Refund — response body |
application_fee (anyOf 2) | null | Alternative | |
application_fee_amount | JSON | Optional | |
application_fee_amount (anyOf 1) | JSON | Alternative | |
application_fee_amount (anyOf 1) (anyOf 1) | integer | Alternative | The amount of the application fee (if any) requested for the charge. [See the Connect documentation](https://docs.stripe.com/connect/direct-charges#collect-fees) for details. |
application_fee_amount (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
application_fee_amount (anyOf 2) | null | Alternative | |
balance_transaction | JSON | Optional | |
balance_transaction (anyOf 1) | JSON | Alternative | ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). |
balance_transaction (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
balance_transaction (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a balance transaction — balance get Balance History Id — response body |
balance_transaction (anyOf 2) | null | Alternative | |
billing_details | Model | Required within parent | Expand Create a charge — response body — billing details |
calculated_statement_descriptor | JSON | Optional | |
calculated_statement_descriptor (anyOf 1) | string | Alternative | The full statement descriptor that is passed to card networks, and that is displayed on your customers' credit card and bank statements. Allows you to see what the statement descriptor looks like after the static and dynamic portions are combined. This value only exists for card payments. Maximum length: 5000 |
calculated_statement_descriptor (anyOf 2) | null | Alternative | |
captured | boolean | Required within parent | If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. |
created | JSON | Required within parent | |
created (anyOf 1) | integer | Alternative | Time at which the object was created. Measured in seconds since the Unix epoch. Format: unix-time |
created (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
currency | string | Required within parent | Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://stripe.com/docs/currencies). Format: currency |
customer | JSON | Optional | |
customer (anyOf 1) | JSON | Alternative | ID of the customer this charge is for if one exists. |
customer (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
customer (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a customer — response body |
customer (anyOf 1) (anyOf 3) | Model | Alternative | Expand Delete a customer — response body |
customer (anyOf 2) | null | Alternative | |
description | JSON | Optional | |
description (anyOf 1) | string | Alternative | An arbitrary string attached to the object. Often useful for displaying to users. Maximum length: 40000 |
description (anyOf 2) | null | Alternative | |
disputed | boolean | Required within parent | Whether the charge has been disputed. |
failure_balance_transaction | JSON | Optional | |
failure_balance_transaction (anyOf 1) | JSON | Alternative | ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. |
failure_balance_transaction (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
failure_balance_transaction (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a balance transaction — balance get Balance History Id — response body |
failure_balance_transaction (anyOf 2) | null | Alternative | |
failure_code | JSON | Optional | |
failure_code (anyOf 1) | string | Alternative | Error code explaining reason for charge failure if available (see [the errors section](https://docs.stripe.com/error-codes) for a list of codes). Maximum length: 5000 |
failure_code (anyOf 2) | null | Alternative | |
failure_message | JSON | Optional | |
failure_message (anyOf 1) | string | Alternative | Message to user further explaining reason for charge failure if available. Maximum length: 5000 |
failure_message (anyOf 2) | null | Alternative | |
fraud_details | JSON | Optional | |
fraud_details (anyOf 1) | JSON | Alternative | Information on fraud assessments for the charge. |
fraud_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a charge — response body — fraud details Information on fraud assessments for the charge stripe report, user report |
fraud_details (anyOf 2) | null | Alternative | |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
livemode | boolean | Required within parent | If the object exists in live mode, the value is `true`. If the object exists in test mode, the value is `false`. |
metadata | object | Required within parent | Set of [key-value pairs](https://docs.stripe.com/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Additional keys: see wildcard field |
metadata.* | string | Additional keys | Maximum length: 500 |
object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Known values: charge |
on_behalf_of | JSON | Optional | |
on_behalf_of (anyOf 1) | JSON | Alternative | The account (if any) the charge was made on behalf of without triggering an automatic transfer. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers) for details. |
on_behalf_of (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
on_behalf_of (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create an account — response body |
on_behalf_of (anyOf 2) | null | Alternative | |
outcome | JSON | Optional | |
outcome (anyOf 1) | JSON | Alternative | Details about whether the payment was accepted, and why. See [understanding declines](https://docs.stripe.com/declines) for details. |
outcome (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a charge — response body — outcome value advice code, network advice code, network decline code, network status, reason, risk level, risk score, rule, seller message, type |
outcome (anyOf 2) | null | Alternative | |
paid | boolean | Required within parent | `true` if the charge succeeded, or was successfully authorized for later capture. |
payment_intent | JSON | Optional | |
payment_intent (anyOf 1) | JSON | Alternative | ID of the PaymentIntent associated with this charge, if one exists. |
payment_intent (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
payment_intent (anyOf 1) (anyOf 2) | Model | Alternative | Expand Cancel a Payment Intent — response body |
payment_intent (anyOf 2) | null | Alternative | |
payment_method | JSON | Optional | |
payment_method (anyOf 1) | string | Alternative | ID of the payment method used in this charge. Maximum length: 5000 |
payment_method (anyOf 2) | null | Alternative | |
payment_method_details | JSON | Optional | |
payment_method_details (anyOf 1) | JSON | Alternative | Details about the payment method at the time of the transaction. |
payment_method_details (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip |
payment_method_details (anyOf 2) | null | Alternative | |
presentment_details | Model | Optional | Expand Cancel a refund — response body — presentment details |
radar_options | Model | Optional | Expand Create a charge — response body — radar options |
receipt_email | JSON | Optional | |
receipt_email (anyOf 1) | string | Alternative | This is the email address that the receipt for this charge was sent to. Maximum length: 5000 |
receipt_email (anyOf 2) | null | Alternative | |
receipt_number | JSON | Optional | |
receipt_number (anyOf 1) | string | Alternative | This is the transaction number that appears on email receipts sent for this charge. This attribute will be `null` until a receipt has been sent. Maximum length: 5000 |
receipt_number (anyOf 2) | null | Alternative | |
receipt_url | JSON | Optional | |
receipt_url (anyOf 1) | string | Alternative | This is the URL to view the receipt for this charge. The receipt is kept up-to-date to the latest state of the charge, including any refunds. If the charge is for an Invoice, the receipt will be stylized as an Invoice receipt. Maximum length: 5000 |
receipt_url (anyOf 2) | null | Alternative | |
refunded | boolean | Required within parent | Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. |
refunds | JSON | Optional | |
refunds (anyOf 1) | object | Alternative | A list of refunds that have been applied to the charge. |
refunds (anyOf 1).data | array | Required within parent | Details about each object. |
refunds (anyOf 1).data[] | Model | Each item | Expand Cancel a refund — response body |
refunds (anyOf 1).has_more | boolean | Required within parent | True if this list has another page of items after this one that can be fetched. |
refunds (anyOf 1).object | string | Required within parent | String representing the object's type. Objects of the same type share the same value. Always has the value `list`. Known values: list |
refunds (anyOf 1).url | string | Required within parent | The URL where this list can be accessed. Maximum length: 5000 |
refunds (anyOf 2) | null | Alternative | |
review | JSON | Optional | |
review (anyOf 1) | JSON | Alternative | ID of the review associated with this charge if one exists. |
review (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
review (anyOf 1) (anyOf 2) | Model | Alternative | Expand Approve a review — response body |
review (anyOf 2) | null | Alternative | |
shipping | JSON | Optional | |
shipping (anyOf 1) | JSON | Alternative | Shipping information for the charge. |
shipping (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a source — response body — source order shipping |
shipping (anyOf 2) | null | Alternative | |
source_transfer | JSON | Optional | |
source_transfer (anyOf 1) | JSON | Alternative | The transfer ID which created this charge. Only present if the charge came from another Stripe account. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. |
source_transfer (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
source_transfer (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a transfer — response body |
source_transfer (anyOf 2) | null | Alternative | |
statement_descriptor | JSON | Optional | |
statement_descriptor (anyOf 1) | string | Alternative | For a non-card charge, text that appears on the customer's statement as the statement descriptor. This value overrides the account's default statement descriptor. For information about requirements, including the 22-character limit, see [the Statement Descriptor docs](https://docs.stripe.com/get-started/account/statement-descriptors). For a card charge, this value is ignored unless you don't specify a `statement_descriptor_suffix`, in which case this value is used as the suffix. Maximum length: 5000 |
statement_descriptor (anyOf 2) | null | Alternative | |
statement_descriptor_suffix | JSON | Optional | |
statement_descriptor_suffix (anyOf 1) | string | Alternative | Provides information about a card charge. Concatenated to the account's [statement descriptor prefix](https://docs.stripe.com/get-started/account/statement-descriptors#static) to form the complete statement descriptor that appears on the customer's statement. If the account has no prefix value, the suffix is concatenated to the account's statement descriptor. Maximum length: 5000 |
statement_descriptor_suffix (anyOf 2) | null | Alternative | |
status | string | Required within parent | The status of the payment is either `succeeded`, `pending`, or `failed`. Known values: failed, pending, succeeded |
transfer | JSON | Optional | ID of the transfer to the `destination` account (only applicable if the charge was created using the `destination` parameter). |
transfer (anyOf 1) | string | Alternative | Maximum length: 5000 |
transfer (anyOf 2) | Model | Alternative | Expand Create a transfer — response body |
transfer_data | JSON | Optional | |
transfer_data (anyOf 1) | JSON | Alternative | An optional dictionary including the account to automatically transfer to as part of a destination charge. [See the Connect documentation](https://docs.stripe.com/connect/destination-charges) for details. |
transfer_data (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a charge — response body — transfer data value amount, destination |
transfer_data (anyOf 2) | null | Alternative | |
transfer_group | JSON | Optional | |
transfer_group (anyOf 1) | string | Alternative | A string that identifies this transaction as part of a group. See the [Connect documentation](https://docs.stripe.com/connect/separate-charges-and-transfers#transfer-options) for details. Maximum length: 5000 |
transfer_group (anyOf 2) | null | Alternative |
Referenced models: Create an account — response body, PostApplicationFeesIdRefund — response body — application / object: application, Post Application Fees Id Refund — response body, Retrieve a balance transaction — balance get Balance History Id — response body, Create a charge — response body — billing details, Create a charge — response body — fraud details Information on fraud assessments for the charge stripe report, user report, Create a charge — response body — outcome value advice code, network advice code, network decline code, network status, reason, risk level, risk score, rule, seller message, type, Create a charge — response body — transfer data value amount, destination, Create a customer — response body, Delete a customer — response body, Cancel a refund — response body — presentment details, Cancel a Payment Intent — response body, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip, Create a charge — response body — radar options, Cancel a refund — response body, Approve a review — response body, Create a source — response body — source order shipping, Create a transfer — response body
Create a charge — response body — billing details
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
address | JSON | Optional | |
address (anyOf 1) | JSON | Alternative | Billing address. |
address (anyOf 1) (anyOf 1) | Model | Alternative | Expand Create a Location — response body — address |
address (anyOf 2) | null | Alternative | |
email | JSON | Optional | |
email (anyOf 1) | string | Alternative | Email address. Maximum length: 5000 |
email (anyOf 2) | null | Alternative | |
name | JSON | Optional | |
name (anyOf 1) | string | Alternative | Full name. Maximum length: 5000 |
name (anyOf 2) | null | Alternative | |
phone | JSON | Optional | |
phone (anyOf 1) | string | Alternative | Billing phone number (including extension). Maximum length: 5000 |
phone (anyOf 2) | null | Alternative | |
tax_id | JSON | Optional | |
tax_id (anyOf 1) | string | Alternative | Taxpayer identification number. Used only for transactions between LATAM buyers and non-LATAM sellers. Maximum length: 5000 |
tax_id (anyOf 2) | null | Alternative |
Referenced models: Create a Location — response body — address
Create a charge — response body — fraud details Information on fraud assessments for the charge stripe report, user report
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
stripe_report | string | Optional | Assessments from Stripe. If set, the value is `fraudulent`. Maximum length: 5000 |
user_report | string | Optional | Assessments reported by you. If set, possible values of are `safe` and `fraudulent`. Maximum length: 5000 |
Create a charge — response body — outcome value advice code, network advice code, network decline code, network status, reason, risk level, risk score, rule, seller message, type
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
advice_code | JSON | Optional | |
advice_code (anyOf 1) | string | Alternative | An enumerated value providing a more detailed explanation on [how to proceed with an error](https://docs.stripe.com/declines#retrying-issuer-declines). Known values: confirm_card_data, do_not_try_again, try_again_later |
advice_code (anyOf 2) | null | Alternative | |
network_advice_code | JSON | Optional | |
network_advice_code (anyOf 1) | string | Alternative | For charges declined by the network, a 2 digit code which indicates the advice returned by the network on how to proceed with an error. Maximum length: 5000 |
network_advice_code (anyOf 2) | null | Alternative | |
network_decline_code | JSON | Optional | |
network_decline_code (anyOf 1) | string | Alternative | For charges declined by the network, an alphanumeric code which indicates the reason the charge failed. Maximum length: 5000 |
network_decline_code (anyOf 2) | null | Alternative | |
network_status | JSON | Optional | |
network_status (anyOf 1) | string | Alternative | Possible values are `approved_by_network`, `declined_by_network`, `not_sent_to_network`, and `reversed_after_approval`. The value `reversed_after_approval` indicates the payment was [blocked by Stripe](https://docs.stripe.com/declines#blocked-payments) after bank authorization, and may temporarily appear as "pending" on a cardholder's statement. Maximum length: 5000 |
network_status (anyOf 2) | null | Alternative | |
reason | JSON | Optional | |
reason (anyOf 1) | string | Alternative | An enumerated value providing a more detailed explanation of the outcome's `type`. Charges blocked by Radar's default block rule have the value `highest_risk_level`. Charges placed in review by Radar's default review rule have the value `elevated_risk_level`. Charges blocked because the payment is unlikely to be authorized have the value `low_probability_of_authorization`. Charges authorized, blocked, or placed in review by custom rules have the value `rule`. See [understanding declines](https://docs.stripe.com/declines) for more details. Maximum length: 5000 |
reason (anyOf 2) | null | Alternative | |
risk_level | string | Optional | Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are `normal`, `elevated`, `highest`. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value `not_assessed`. In the event of an error in the evaluation, this field will have the value `unknown`. This field is only available with Radar. Maximum length: 5000 |
risk_score | JSON | Optional | |
risk_score (anyOf 1) | integer | Alternative | Stripe Radar's evaluation of the riskiness of the payment. Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present. This field is only available with Radar for Fraud Teams. |
risk_score (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
rule | JSON | Optional | The ID of the Radar rule that matched the payment, if applicable. |
rule (anyOf 1) | string | Alternative | Maximum length: 5000 |
rule (anyOf 2) | Model | Alternative | Expand Create a charge — response body — outcome value advice code, network advice code, network decline code, network status, reason, risk level, risk score, rule, seller message, type rule action, id, predicate |
seller_message | JSON | Optional | |
seller_message (anyOf 1) | string | Alternative | A human-readable description of the outcome type and reason, designed for you (the recipient of the payment), not your customer. Maximum length: 5000 |
seller_message (anyOf 2) | null | Alternative | |
type | string | Required within parent | Possible values are `authorized`, `manual_review`, `issuer_declined`, `blocked`, and `invalid`. See [understanding declines](https://docs.stripe.com/declines) and [Radar reviews](https://docs.stripe.com/radar/reviews) for details. Maximum length: 5000 |
Create a charge — response body — outcome value advice code, network advice code, network decline code, network status, reason, risk level, risk score, rule, seller message, type rule action, id, predicate
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
action | string | Required within parent | The action taken on the payment. Maximum length: 5000 |
id | string | Required within parent | Unique identifier for the object. Maximum length: 5000 |
predicate | string | Required within parent | The predicate to evaluate the payment against. Maximum length: 5000 |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip
Referenced models: Create a Payment Method — response body — zip, Create a Payment Method — response body — blik, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip ach credit transfer, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip ach debit, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip acss debit, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip affirm, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip afterpay clearpay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip alipay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip alma, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip amazon pay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip au becs debit, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip bacs debit, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip bancontact, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip billie, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip bizum, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip boleto, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip card, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip card present, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip cashapp, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip crypto, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip eps, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip fpx, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip giropay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip grabpay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip ideal, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip interac present, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip kakao pay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip klarna, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip konbini, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip kr card, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip link, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip mobilepay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip multibanco, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip naver pay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip nz bank account, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip oxxo, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip p24, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip payco, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip paynow, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip payto, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip promptpay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip samsung pay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip satispay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip scalapay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip sepa debit, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip sequra, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip sunbit, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip swish, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip twint, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip upi, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip wechat pay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip paypal, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip pix, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip revolut pay, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip sofort, Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip us bank account
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip ach credit transfer
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_number | JSON | Optional | |
account_number (anyOf 1) | string | Alternative | Account number to transfer funds to. Maximum length: 5000 |
account_number (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Name of the bank associated with the routing number. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
routing_number | JSON | Optional | |
routing_number (anyOf 1) | string | Alternative | Routing transit number for the bank account to transfer funds to. Maximum length: 5000 |
routing_number (anyOf 2) | null | Alternative | |
swift_code | JSON | Optional | |
swift_code (anyOf 1) | string | Alternative | SWIFT code of the bank associated with the routing number. Maximum length: 5000 |
swift_code (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip ach debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
account_holder_type | JSON | Optional | |
account_holder_type (anyOf 1) | string | Alternative | Type of entity that holds the account. This can be either `individual` or `company`. Known values: company, individual |
account_holder_type (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Name of the bank associated with the bank account. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter ISO code representing the country the bank account is located in. Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
routing_number | JSON | Optional | |
routing_number (anyOf 1) | string | Alternative | Routing transit number of the bank account. Maximum length: 5000 |
routing_number (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip acss debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Name of the bank associated with the bank account. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
expected_debit_date | string | Optional | Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. Maximum length: 5000 |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
institution_number | JSON | Optional | |
institution_number (anyOf 1) | string | Alternative | Institution number of the bank account Maximum length: 5000 |
institution_number (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
mandate | string | Optional | ID of the mandate used to make this payment. Maximum length: 5000 |
transit_number | JSON | Optional | |
transit_number (anyOf 1) | string | Alternative | Transit number of the bank account. Maximum length: 5000 |
transit_number (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip affirm
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
location | string | Optional | ID of the location that this reader is assigned to. Maximum length: 5000 |
reader | string | Optional | ID of the reader this transaction was made on. Maximum length: 5000 |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Affirm transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip afterpay clearpay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
order_id | JSON | Optional | |
order_id (anyOf 1) | string | Alternative | The Afterpay order ID associated with this payment intent. Maximum length: 5000 |
order_id (anyOf 2) | null | Alternative | |
reference | JSON | Optional | |
reference (anyOf 1) | string | Alternative | Order identifier shown to the merchant in Afterpay's online portal. Maximum length: 5000 |
reference (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip alipay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
buyer_id | string | Optional | Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. Maximum length: 5000 |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular Alipay account. You can use this attribute to check whether two Alipay accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | Transaction ID of this particular Alipay transaction. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip alma
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
installments | Model | Optional | Expand Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip alma installments |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Alma transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip alma installments
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
count | JSON | Required within parent | |
count (anyOf 1) | integer | Alternative | The number of installments. |
count (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip amazon pay
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
funding | Model | Optional | Expand Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip amazon pay funding |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Amazon Pay transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip amazon pay funding
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
card | Model | Optional | Expand Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip amazon pay funding card |
type | JSON | Optional | |
type (anyOf 1) | string | Alternative | funding type of the underlying payment method. Known values: card |
type (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip amazon pay funding card
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
brand | JSON | Optional | |
brand (anyOf 1) | string | Alternative | Card brand. Can be `American Express`, `Cartes Bancaires`, `Diners Club`, `Discover`, `Eftpos Australia`, `Girocard`, `JCB`, `MasterCard`, `UnionPay`, `Visa`, or `Unknown`. Maximum length: 5000 |
brand (anyOf 2) | null | Alternative | |
country | JSON | Optional | |
country (anyOf 1) | string | Alternative | Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected. Maximum length: 5000 |
country (anyOf 2) | null | Alternative | |
exp_month | JSON | Optional | |
exp_month (anyOf 1) | JSON | Alternative | |
exp_month (anyOf 1) (anyOf 1) | integer | Alternative | Two-digit number representing the card's expiration month. |
exp_month (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_month (anyOf 2) | null | Alternative | |
exp_year | JSON | Optional | |
exp_year (anyOf 1) | JSON | Alternative | |
exp_year (anyOf 1) (anyOf 1) | integer | Alternative | Four-digit number representing the card's expiration year. |
exp_year (anyOf 1) (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
exp_year (anyOf 2) | null | Alternative | |
funding | JSON | Optional | |
funding (anyOf 1) | string | Alternative | Card funding type. Can be `credit`, `debit`, `prepaid`, or `unknown`. Maximum length: 5000 |
funding (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | The last four digits of the card. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip au becs debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bsb_number | JSON | Optional | |
bsb_number (anyOf 1) | string | Alternative | Bank-State-Branch number of the bank account. Maximum length: 5000 |
bsb_number (anyOf 2) | null | Alternative | |
expected_debit_date | string | Optional | Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. Maximum length: 5000 |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
mandate | string | Optional | ID of the mandate used to make this payment. Maximum length: 5000 |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip bacs debit
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
expected_debit_date | string | Optional | Estimated date to debit the customer's bank account. A date string in YYYY-MM-DD format. Maximum length: 5000 |
fingerprint | JSON | Optional | |
fingerprint (anyOf 1) | string | Alternative | Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same. Maximum length: 5000 |
fingerprint (anyOf 2) | null | Alternative | |
last4 | JSON | Optional | |
last4 (anyOf 1) | string | Alternative | Last four digits of the bank account number. Maximum length: 5000 |
last4 (anyOf 2) | null | Alternative | |
mandate | JSON | Optional | |
mandate (anyOf 1) | string | Alternative | ID of the mandate used to make this payment. Maximum length: 5000 |
mandate (anyOf 2) | null | Alternative | |
sort_code | JSON | Optional | |
sort_code (anyOf 1) | string | Alternative | Sort code of the bank account. (e.g., `10-20-30`) Maximum length: 5000 |
sort_code (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip bancontact
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
bank_code | JSON | Optional | |
bank_code (anyOf 1) | string | Alternative | Bank code of bank associated with the bank account. Maximum length: 5000 |
bank_code (anyOf 2) | null | Alternative | |
bank_name | JSON | Optional | |
bank_name (anyOf 1) | string | Alternative | Name of the bank associated with the bank account. Maximum length: 5000 |
bank_name (anyOf 2) | null | Alternative | |
bic | JSON | Optional | |
bic (anyOf 1) | string | Alternative | Bank Identifier Code of the bank associated with the bank account. Maximum length: 5000 |
bic (anyOf 2) | null | Alternative | |
generated_sepa_debit | JSON | Optional | |
generated_sepa_debit (anyOf 1) | JSON | Alternative | The ID of the SEPA Direct Debit PaymentMethod which was generated by this Charge. |
generated_sepa_debit (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit (anyOf 1) (anyOf 2) | Model | Alternative | Expand Create a Payment Method — response body |
generated_sepa_debit (anyOf 2) | null | Alternative | |
generated_sepa_debit_mandate | JSON | Optional | |
generated_sepa_debit_mandate (anyOf 1) | JSON | Alternative | The mandate for the SEPA Direct Debit PaymentMethod which was generated by this Charge. |
generated_sepa_debit_mandate (anyOf 1) (anyOf 1) | string | Alternative | Maximum length: 5000 |
generated_sepa_debit_mandate (anyOf 1) (anyOf 2) | Model | Alternative | Expand Retrieve a Mandate — response body |
generated_sepa_debit_mandate (anyOf 2) | null | Alternative | |
iban_last4 | JSON | Optional | |
iban_last4 (anyOf 1) | string | Alternative | Last four characters of the IBAN. Maximum length: 5000 |
iban_last4 (anyOf 2) | null | Alternative | |
preferred_language | JSON | Optional | |
preferred_language (anyOf 1) | string | Alternative | Preferred language of the Bancontact authorization page that the customer is redirected to. Can be one of `en`, `de`, `fr`, or `nl` Known values: de, en, fr, nl |
preferred_language (anyOf 2) | null | Alternative | |
verified_name | JSON | Optional | |
verified_name (anyOf 1) | string | Alternative | Owner's verified full name. Values are verified or provided by Bancontact directly (if supported) at the time of authorization or settlement. They cannot be set or mutated. Maximum length: 5000 |
verified_name (anyOf 2) | null | Alternative |
Referenced models: Retrieve a Mandate — response body, Create a Payment Method — response body
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip billie
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Billie transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip bizum
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
buyer_id | JSON | Optional | |
buyer_id (anyOf 1) | string | Alternative | A unique identifier for the buyer as determined by the local payment processor. Maximum length: 5000 |
buyer_id (anyOf 2) | null | Alternative | |
transaction_id | JSON | Optional | |
transaction_id (anyOf 1) | string | Alternative | The Bizum transaction ID associated with this payment. Maximum length: 5000 |
transaction_id (anyOf 2) | null | Alternative |
Create a charge — response body — payment method details value ach credit transfer, ach debit, acss debit, affirm, afterpay clearpay, alipay, alma, amazon pay, au becs debit, bacs debit, bancontact, billie, bizum, blik, boleto, card, card present, cashapp, crypto, customer balance, eps, fpx, giropay, grabpay, ideal, interac present, kakao pay, klarna, konbini, kr card, link, mb way, mobilepay, multibanco, naver pay, nz bank account, oxxo, p24, pay by bank, payco, paynow, paypal, paypay, payto, pix, promptpay, revolut pay, samsung pay, satispay, scalapay, sepa debit, sequra, sofort, stripe account, sunbit, swish, twint, type, upi, us bank account, wechat, wechat pay, zip boleto
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
tax_id | string | Required within parent | The tax ID of the customer (CPF for individuals consumers or CNPJ for businesses consumers) Maximum length: 5000 |