POST /v1/test_helpers/confirmation_tokens

Creates a test mode Confirmation Token server side for your integration tests.

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/x-www-form-urlencoded"

Request body fields

Name Type Required Description
setup_future_usage String No

Indicates that you intend to make future payments with this ConfirmationToken's payment method.

The presence of this property will attach the payment method to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete.

Possible values:

  • "off_session"
  • "on_session"
payment_method_data Object No

If provided, this hash will be used to create a PaymentMethod.

payment_method_data.swish Object No
payment_method_data.metadata Object No
payment_method_data.multibanco Object No
payment_method_data.affirm Object No
payment_method_data.mobilepay Object No
payment_method_data.paynow Object No
payment_method_data.billing_details Object No
payment_method_data.billing_details.email No
payment_method_data.billing_details.name No
payment_method_data.billing_details.tax_id String No
payment_method_data.billing_details.phone No
payment_method_data.billing_details.address No
payment_method_data.customer_balance Object No
payment_method_data.pix Object No
payment_method_data.sofort Object No
payment_method_data.sofort.country String Yes

Possible values:

  • "ES"
  • "NL"
  • "IT"
  • "AT"
  • "BE"
  • "DE"
payment_method_data.alipay Object No
payment_method_data.interac_present Object No
payment_method_data.cashapp Object No
payment_method_data.zip Object No
payment_method_data.type String Yes

Possible values:

  • "p24"
  • "pay_by_bank"
  • "blik"
  • "crypto"
  • "amazon_pay"
  • "boleto"
  • "bacs_debit"
  • "giropay"
  • "eps"
  • "paynow"
  • "pix"
  • "fpx"
  • "promptpay"
  • "zip"
  • "alipay"
  • "naver_pay"
  • "revolut_pay"
  • "billie"
  • "klarna"
  • "bancontact"
  • "kr_card"
  • "swish"
  • "paypal"
  • "samsung_pay"
  • "sofort"
  • "nz_bank_account"
  • "au_becs_debit"
  • "kakao_pay"
  • "konbini"
  • "acss_debit"
  • "link"
  • "alma"
  • "satispay"
  • "payco"
  • "sepa_debit"
  • "us_bank_account"
  • "oxxo"
  • "cashapp"
  • "affirm"
  • "twint"
  • "afterpay_clearpay"
  • "customer_balance"
  • "grabpay"
  • "multibanco"
  • "ideal"
  • "wechat_pay"
  • "mobilepay"
payment_method_data.afterpay_clearpay Object No
payment_method_data.twint Object No
payment_method_data.eps Object No
payment_method_data.eps.bank String No

Possible values:

  • "vr_bank_braunau"
  • "hypo_bank_burgenland_aktiengesellschaft"
  • "bank_austria"
  • "austrian_anadi_bank_ag"
  • "volkskreditbank_ag"
  • "bankhaus_carl_spangler"
  • "bawag_psk_ag"
  • "bankhaus_schelhammer_und_schattera_ag"
  • "capital_bank_grawe_gruppe_ag"
  • "raiffeisen_bankengruppe_osterreich"
  • "btv_vier_lander_bank"
  • "dolomitenbank"
  • "erste_bank_und_sparkassen"
  • "hypo_alpeadriabank_international_ag"
  • "schoellerbank_ag"
  • "marchfelder_bank"
  • "volksbank_gruppe"
  • "hypo_vorarlberg_bank_ag"
  • "bks_bank_ag"
  • "hypo_oberosterreich_salzburg_steiermark"
  • "easybank_ag"
  • "deutsche_bank_ag"
  • "sparda_bank_wien"
  • "hypo_tirol_bank_ag"
  • "arzte_und_apotheker_bank"
  • "brull_kallmus_bank_ag"
  • "oberbank_ag"
  • "hypo_noe_lb_fur_niederosterreich_u_wien"
payment_method_data.us_bank_account Object No
payment_method_data.us_bank_account.routing_number String No
payment_method_data.us_bank_account.account_number String No
payment_method_data.us_bank_account.financial_connections_account String No
payment_method_data.us_bank_account.account_holder_type String No

Possible values:

  • "company"
  • "individual"
payment_method_data.us_bank_account.account_type String No

Possible values:

  • "checking"
  • "savings"
payment_method_data.au_becs_debit Object No
payment_method_data.au_becs_debit.account_number String Yes
payment_method_data.au_becs_debit.bsb_number String Yes
payment_method_data.konbini Object No
payment_method_data.oxxo Object No
payment_method_data.bancontact Object No
payment_method_data.p24 Object No
payment_method_data.p24.bank String No

Possible values:

  • "banki_spbdzielcze"
  • "credit_agricole"
  • "bank_millennium"
  • "inteligo"
  • "plus_bank"
  • "bank_nowy_bfg_sa"
  • "citi_handlowy"
  • "blik"
  • "getin_bank"
  • "velobank"
  • "bank_pekao_sa"
  • "boz"
  • "ideabank"
  • "volkswagen_bank"
  • "alior_bank"
  • "bnp_paribas"
  • "tmobile_usbugi_bankowe"
  • "toyota_bank"
  • "mbank_mtransfer"
  • "santander_przelew24"
  • "etransfer_pocztowy24"
  • "envelobank"
  • "nest_przelew"
  • "ing"
  • "noble_pay"
  • "pbac_z_ipko"
payment_method_data.allow_redisplay String No

Possible values:

  • "limited"
  • "unspecified"
  • "always"
payment_method_data.radar_options Object No
payment_method_data.radar_options.session String No
payment_method_data.ideal Object No
payment_method_data.ideal.bank String No

Possible values:

  • "knab"
  • "n26"
  • "rabobank"
  • "sns_bank"
  • "triodos_bank"
  • "bunq"
  • "buut"
  • "van_lanschot"
  • "nn"
  • "ing"
  • "abn_amro"
  • "asn_bank"
  • "handelsbanken"
  • "revolut"
  • "moneyou"
  • "regiobank"
  • "yoursafe"
payment_method_data.amazon_pay Object No
payment_method_data.paypal Object No
payment_method_data.bacs_debit Object No
payment_method_data.bacs_debit.sort_code String No
payment_method_data.bacs_debit.account_number String No
payment_method_data.naver_pay Object No
payment_method_data.naver_pay.funding String No

Possible values:

  • "card"
  • "points"
payment_method_data.klarna Object No
payment_method_data.klarna.dob Object No
payment_method_data.klarna.dob.day Integer Yes
payment_method_data.klarna.dob.month Integer Yes
payment_method_data.klarna.dob.year Integer Yes
payment_method_data.acss_debit Object No
payment_method_data.acss_debit.institution_number String Yes
payment_method_data.acss_debit.transit_number String Yes
payment_method_data.acss_debit.account_number String Yes
payment_method_data.blik Object No
payment_method_data.payco Object No
payment_method_data.wechat_pay Object No
payment_method_data.pay_by_bank Object No
payment_method_data.promptpay Object No
payment_method_data.giropay Object No
payment_method_data.kakao_pay Object No
payment_method_data.crypto Object No
payment_method_data.alma Object No
payment_method_data.link Object No
payment_method_data.satispay Object No
payment_method_data.fpx Object No
payment_method_data.fpx.bank String Yes

Possible values:

  • "bank_rakyat"
  • "hsbc"
  • "hong_leong_bank"
  • "ocbc"
  • "kfh"
  • "public_bank"
  • "alliance_bank"
  • "maybank2u"
  • "uob"
  • "agrobank"
  • "bsn"
  • "deutsche_bank"
  • "cimb"
  • "rhb"
  • "ambank"
  • "standard_chartered"
  • "affin_bank"
  • "bank_islam"
  • "pb_enterprise"
  • "maybank2e"
  • "bank_of_china"
  • "bank_muamalat"
payment_method_data.revolut_pay Object No
payment_method_data.billie Object No
payment_method_data.sepa_debit Object No
payment_method_data.sepa_debit.iban String Yes
payment_method_data.kr_card Object No
payment_method_data.samsung_pay Object No
payment_method_data.nz_bank_account Object No
payment_method_data.nz_bank_account.bank_code String Yes
payment_method_data.nz_bank_account.branch_code String Yes
payment_method_data.nz_bank_account.account_number String Yes
payment_method_data.nz_bank_account.account_holder_name String No
payment_method_data.nz_bank_account.reference String No
payment_method_data.nz_bank_account.suffix String Yes
payment_method_data.grabpay Object No
payment_method_data.boleto Object No
payment_method_data.boleto.tax_id String Yes
expand[] Array No

Specifies which fields in the response should be expanded.

shipping Object No

Shipping information for this ConfirmationToken.

shipping.name String Yes
shipping.phone No
shipping.address Object Yes
shipping.address.line2 String No
shipping.address.line1 String No
shipping.address.postal_code String No
shipping.address.country String No
shipping.address.state String No
shipping.address.city String No
payment_method String No

ID of an existing PaymentMethod.

payment_method_options Object No

Payment-method-specific configuration for this ConfirmationToken.

payment_method_options.card Object No
payment_method_options.card.installments Object No
payment_method_options.card.installments.plan Object Yes
payment_method_options.card.installments.plan.count Integer No
payment_method_options.card.installments.plan.interval String No

Possible values:

  • "month"
payment_method_options.card.installments.plan.type String Yes

Possible values:

  • "fixed_count"
  • "revolving"
  • "bonus"
return_url String No

Return URL used to confirm the Intent.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.