expresspayments
Version:
ExpressPayments API wrapper
1,093 lines (908 loc) • 353 kB
TypeScript
// File generated from our OpenAPI spec
declare module 'expresspayments' {
namespace ExpressPayments {
interface PaymentIntentCreateParams {
/**
* Amount intended to be collected by this PaymentIntent. A positive integer representing how much to charge in the [smallest currency unit](https://docs.epayments.network/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.epayments.network/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: number;
/**
* Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase. Must be a [supported currency](https://docs.epayments.network/currencies).
*/
currency: string;
/**
* The amount of the application fee (if any) that will be requested to be applied to the payment and transferred to the application owner's ExpressPayments account. The amount of the application fee collected will be capped at the total payment amount. For more information, see the PaymentIntents [use case for connected accounts](https://docs.epayments.network/payments/connected-accounts).
*/
application_fee_amount?: number;
/**
* When enabled, this PaymentIntent will accept payment methods that you have enabled in the Dashboard and are compatible with this PaymentIntent's other parameters.
*/
automatic_payment_methods?: PaymentIntentCreateParams.AutomaticPaymentMethods;
/**
* Controls when the funds will be captured from the customer's account.
*/
capture_method?: PaymentIntentCreateParams.CaptureMethod;
/**
* Set to `true` to attempt to [confirm](https://docs.epayments.network/api/payment_intents/confirm) this PaymentIntent immediately. This parameter defaults to `false`. When creating and confirming a PaymentIntent at the same time, parameters available in the [confirm](https://docs.epayments.network/api/payment_intents/confirm) API may also be provided.
*/
confirm?: boolean;
confirmation_method?: PaymentIntentCreateParams.ConfirmationMethod;
/**
* ID of the Customer this PaymentIntent belongs to, if one exists.
*
* Payment methods attached to other Customers cannot be used with this PaymentIntent.
*
* If present in combination with [setup_future_usage](https://docs.epayments.network/api#payment_intent_object-setup_future_usage), this PaymentIntent's payment method will be attached to the Customer after the PaymentIntent has been confirmed and any required actions from the user are complete.
*/
customer?: string;
/**
* An arbitrary string attached to the object. Often useful for displaying to users.
*/
description?: string;
/**
* Set to `true` to fail the payment attempt if the PaymentIntent transitions into `requires_action`. This parameter is intended for simpler integrations that do not handle customer actions, like [saving cards without authentication](https://docs.epayments.network/payments/save-card-without-authentication). This parameter can only be used with [`confirm=true`](https://docs.epayments.network/api/payment_intents/create#create_payment_intent-confirm).
*/
error_on_requires_action?: boolean;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* ID of the mandate to be used for this payment. This parameter can only be used with [`confirm=true`](https://docs.epayments.network/api/payment_intents/create#create_payment_intent-confirm).
*/
mandate?: string;
/**
* This hash contains details about the Mandate to create. This parameter can only be used with [`confirm=true`](https://docs.epayments.network/api/payment_intents/create#create_payment_intent-confirm).
*/
mandate_data?: PaymentIntentCreateParams.MandateData;
/**
* Set of [key-value pairs](https://docs.epayments.network/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: ExpressPayments.MetadataParam;
/**
* Set to `true` to indicate that the customer is not in your checkout flow during this payment attempt, and therefore is unable to authenticate. This parameter is intended for scenarios where you collect card details and [charge them later](https://docs.epayments.network/payments/cards/charging-saved-cards). This parameter can only be used with [`confirm=true`](https://docs.epayments.network/api/payment_intents/create#create_payment_intent-confirm).
*/
off_session?: boolean | PaymentIntentCreateParams.OffSession;
/**
* The ExpressPayments account ID for which these funds are intended. For details, see the PaymentIntents [use case for connected accounts](https://docs.epayments.network/payments/connected-accounts).
*/
on_behalf_of?: string;
/**
* ID of the payment method (a PaymentMethod, Card, or [compatible Source](https://docs.epayments.network/payments/payment-methods#compatibility) object) to attach to this PaymentIntent.
*
* If neither the `payment_method` parameter nor the `source` parameter are provided with `confirm=true`, `source` will be automatically populated with `customer.default_source` to improve the migration experience for users of the Charges API. We recommend that you explicitly provide the `payment_method` going forward.
*/
payment_method?: string;
/**
* If provided, this hash will be used to create a PaymentMethod. The new PaymentMethod will appear
* in the [payment_method](https://docs.epayments.network/api/payment_intents/object#payment_intent_object-payment_method)
* property on the PaymentIntent.
*/
payment_method_data?: PaymentIntentCreateParams.PaymentMethodData;
/**
* Payment-method-specific configuration for this PaymentIntent.
*/
payment_method_options?: PaymentIntentCreateParams.PaymentMethodOptions;
/**
* The list of payment method types (e.g. card) that this PaymentIntent is allowed to use. If this is not provided, defaults to ["card"]. Use automatic_payment_methods to manage payment methods from the [ExpressPayments Dashboard](https://dashboard.epayments.network/settings/payment_methods).
*/
payment_method_types?: Array<string>;
/**
* Options to configure Radar. See [Radar Session](https://docs.epayments.network/radar/radar-session) for more information.
*/
radar_options?: PaymentIntentCreateParams.RadarOptions;
/**
* Email address that the receipt for the resulting payment will be sent to. If `receipt_email` is specified for a payment in live mode, a receipt will be sent regardless of your [email settings](https://dashboard.epayments.network/account/emails).
*/
receipt_email?: string;
/**
* The URL to redirect your customer back to after they authenticate or cancel their payment on the payment method's app or site. If you'd prefer to redirect to a mobile application, you can alternatively supply an application URI scheme. This parameter can only be used with [`confirm=true`](https://docs.epayments.network/api/payment_intents/create#create_payment_intent-confirm).
*/
return_url?: string;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
*
* Providing this parameter will [attach the payment method](https://docs.epayments.network/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://docs.epayments.network/api/payment_methods/attach) to a Customer after the transaction completes.
*
* When processing card payments, ExpressPayments also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://docs.epayments.network/strong-customer-authentication).
*/
setup_future_usage?: PaymentIntentCreateParams.SetupFutureUsage;
/**
* Shipping information for this PaymentIntent.
*/
shipping?: PaymentIntentCreateParams.Shipping;
/**
* For non-card charges, you can use this value as the complete description that appears on your customers' statements. Must contain at least one letter, maximum 22 characters.
*/
statement_descriptor?: string;
/**
* Provides information about a card payment that customers see on their statements. Concatenated with the prefix (shortened descriptor) or statement descriptor that's set on the account to form the complete statement descriptor. Maximum 22 characters for the concatenated descriptor.
*/
statement_descriptor_suffix?: string;
/**
* The parameters used to automatically create a Transfer when the payment succeeds.
* For more information, see the PaymentIntents [use case for connected accounts](https://docs.epayments.network/payments/connected-accounts).
*/
transfer_data?: PaymentIntentCreateParams.TransferData;
/**
* A string that identifies the resulting payment as part of a group. See the PaymentIntents [use case for connected accounts](https://docs.epayments.network/payments/connected-accounts) for details.
*/
transfer_group?: string;
/**
* Set to `true` when confirming server-side and using ExpressPayments.js, iOS, or Android client-side SDKs to handle the next actions.
*/
use_expresspayments_sdk?: boolean;
}
namespace PaymentIntentCreateParams {
interface AutomaticPaymentMethods {
/**
* Whether this feature is enabled.
*/
enabled: boolean;
}
type CaptureMethod = 'automatic' | 'automatic_async' | 'manual';
type ConfirmationMethod = 'automatic' | 'manual';
interface MandateData {
/**
* This hash contains details about the customer acceptance of the Mandate.
*/
customer_acceptance: MandateData.CustomerAcceptance;
}
namespace MandateData {
interface CustomerAcceptance {
/**
* The time at which the customer accepted the Mandate.
*/
accepted_at?: number;
/**
* If this is a Mandate accepted offline, this hash contains details about the offline acceptance.
*/
offline?: CustomerAcceptance.Offline;
/**
* If this is a Mandate accepted online, this hash contains details about the online acceptance.
*/
online?: CustomerAcceptance.Online;
/**
* The type of customer acceptance information included with the Mandate. One of `online` or `offline`.
*/
type: CustomerAcceptance.Type;
}
namespace CustomerAcceptance {
interface Offline {}
interface Online {
/**
* The IP address from which the Mandate was accepted by the customer.
*/
ip_address: string;
/**
* The user agent of the browser from which the Mandate was accepted by the customer.
*/
user_agent: string;
}
type Type = 'offline' | 'online';
}
}
type OffSession = 'one_off' | 'recurring';
interface PaymentMethodData {
/**
* If this is an `acss_debit` PaymentMethod, this hash contains details about the ACSS Debit payment method.
*/
acss_debit?: PaymentMethodData.AcssDebit;
/**
* If this is an `affirm` PaymentMethod, this hash contains details about the Affirm payment method.
*/
affirm?: PaymentMethodData.Affirm;
/**
* If this is an `AfterpayClearpay` PaymentMethod, this hash contains details about the AfterpayClearpay payment method.
*/
afterpay_clearpay?: PaymentMethodData.AfterpayClearpay;
/**
* If this is an `Alipay` PaymentMethod, this hash contains details about the Alipay payment method.
*/
alipay?: PaymentMethodData.Alipay;
/**
* If this is an `au_becs_debit` PaymentMethod, this hash contains details about the bank account.
*/
au_becs_debit?: PaymentMethodData.AuBecsDebit;
/**
* If this is a `bacs_debit` PaymentMethod, this hash contains details about the Bacs Direct Debit bank account.
*/
bacs_debit?: PaymentMethodData.BacsDebit;
/**
* If this is a `bancontact` PaymentMethod, this hash contains details about the Bancontact payment method.
*/
bancontact?: PaymentMethodData.Bancontact;
/**
* Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
*/
billing_details?: PaymentMethodData.BillingDetails;
/**
* If this is a `blik` PaymentMethod, this hash contains details about the BLIK payment method.
*/
blik?: PaymentMethodData.Blik;
/**
* If this is a `boleto` PaymentMethod, this hash contains details about the Boleto payment method.
*/
boleto?: PaymentMethodData.Boleto;
/**
* If this is a `cashapp` PaymentMethod, this hash contains details about the Cash App Pay payment method.
*/
cashapp?: PaymentMethodData.Cashapp;
/**
* If this is a `customer_balance` PaymentMethod, this hash contains details about the CustomerBalance payment method.
*/
customer_balance?: PaymentMethodData.CustomerBalance;
/**
* If this is an `eps` PaymentMethod, this hash contains details about the EPS payment method.
*/
eps?: PaymentMethodData.Eps;
/**
* If this is an `fpx` PaymentMethod, this hash contains details about the FPX payment method.
*/
fpx?: PaymentMethodData.Fpx;
/**
* If this is a `giropay` PaymentMethod, this hash contains details about the Giropay payment method.
*/
giropay?: PaymentMethodData.Giropay;
/**
* If this is a `grabpay` PaymentMethod, this hash contains details about the GrabPay payment method.
*/
grabpay?: PaymentMethodData.Grabpay;
/**
* If this is an `ideal` PaymentMethod, this hash contains details about the iDEAL payment method.
*/
ideal?: PaymentMethodData.Ideal;
/**
* If this is an `interac_present` PaymentMethod, this hash contains details about the Interac Present payment method.
*/
interac_present?: PaymentMethodData.InteracPresent;
/**
* If this is a `klarna` PaymentMethod, this hash contains details about the Klarna payment method.
*/
klarna?: PaymentMethodData.Klarna;
/**
* If this is a `konbini` PaymentMethod, this hash contains details about the Konbini payment method.
*/
konbini?: PaymentMethodData.Konbini;
/**
* If this is an `Link` PaymentMethod, this hash contains details about the Link payment method.
*/
link?: PaymentMethodData.Link;
/**
* Set of [key-value pairs](https://docs.epayments.network/api/metadata) that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to `metadata`.
*/
metadata?: ExpressPayments.MetadataParam;
/**
* If this is an `oxxo` PaymentMethod, this hash contains details about the OXXO payment method.
*/
oxxo?: PaymentMethodData.Oxxo;
/**
* If this is a `p24` PaymentMethod, this hash contains details about the P24 payment method.
*/
p24?: PaymentMethodData.P24;
/**
* If this is a `paynow` PaymentMethod, this hash contains details about the PayNow payment method.
*/
paynow?: PaymentMethodData.Paynow;
/**
* If this is a `paypal` PaymentMethod, this hash contains details about the PayPal payment method.
*/
paypal?: PaymentMethodData.Paypal;
/**
* If this is a `pix` PaymentMethod, this hash contains details about the Pix payment method.
*/
pix?: PaymentMethodData.Pix;
/**
* If this is a `promptpay` PaymentMethod, this hash contains details about the PromptPay payment method.
*/
promptpay?: PaymentMethodData.Promptpay;
/**
* Options to configure Radar. See [Radar Session](https://docs.epayments.network/radar/radar-session) for more information.
*/
radar_options?: PaymentMethodData.RadarOptions;
/**
* If this is a `sepa_debit` PaymentMethod, this hash contains details about the SEPA debit bank account.
*/
sepa_debit?: PaymentMethodData.SepaDebit;
/**
* If this is a `sofort` PaymentMethod, this hash contains details about the SOFORT payment method.
*/
sofort?: PaymentMethodData.Sofort;
/**
* The type of the PaymentMethod. An additional hash is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
*/
type: PaymentMethodData.Type;
/**
* If this is an `us_bank_account` PaymentMethod, this hash contains details about the US bank account payment method.
*/
us_bank_account?: PaymentMethodData.UsBankAccount;
/**
* If this is an `wechat_pay` PaymentMethod, this hash contains details about the wechat_pay payment method.
*/
wechat_pay?: PaymentMethodData.WechatPay;
/**
* If this is a `zip` PaymentMethod, this hash contains details about the Zip payment method.
*/
zip?: PaymentMethodData.Zip;
}
namespace PaymentMethodData {
interface AcssDebit {
/**
* Customer's bank account number.
*/
account_number: string;
/**
* Institution number of the customer's bank.
*/
institution_number: string;
/**
* Transit number of the customer's bank.
*/
transit_number: string;
}
interface Affirm {}
interface AfterpayClearpay {}
interface Alipay {}
interface AuBecsDebit {
/**
* The account number for the bank account.
*/
account_number: string;
/**
* Bank-State-Branch number of the bank account.
*/
bsb_number: string;
}
interface BacsDebit {
/**
* Account number of the bank account that the funds will be debited from.
*/
account_number?: string;
/**
* Sort code of the bank account. (e.g., `10-20-30`)
*/
sort_code?: string;
}
interface Bancontact {}
interface BillingDetails {
/**
* Billing address.
*/
address?: ExpressPayments.Emptyable<
ExpressPayments.AddressParam
>;
/**
* Email address.
*/
email?: ExpressPayments.Emptyable<string>;
/**
* Full name.
*/
name?: string;
/**
* Billing phone number (including extension).
*/
phone?: string;
}
interface Blik {}
interface Boleto {
/**
* The tax ID of the customer (CPF for individual consumers or CNPJ for businesses consumers)
*/
tax_id: string;
}
interface Cashapp {}
interface CustomerBalance {}
interface Eps {
/**
* The customer's bank.
*/
bank?: Eps.Bank;
}
namespace Eps {
type Bank =
| 'arzte_und_apotheker_bank'
| 'austrian_anadi_bank_ag'
| 'bank_austria'
| 'bankhaus_carl_spangler'
| 'bankhaus_schelhammer_und_schattera_ag'
| 'bawag_psk_ag'
| 'bks_bank_ag'
| 'brull_kallmus_bank_ag'
| 'btv_vier_lander_bank'
| 'capital_bank_grawe_gruppe_ag'
| 'deutsche_bank_ag'
| 'dolomitenbank'
| 'easybank_ag'
| 'erste_bank_und_sparkassen'
| 'hypo_alpeadriabank_international_ag'
| 'hypo_bank_burgenland_aktiengesellschaft'
| 'hypo_noe_lb_fur_niederosterreich_u_wien'
| 'hypo_oberosterreich_salzburg_steiermark'
| 'hypo_tirol_bank_ag'
| 'hypo_vorarlberg_bank_ag'
| 'marchfelder_bank'
| 'oberbank_ag'
| 'raiffeisen_bankengruppe_osterreich'
| 'schoellerbank_ag'
| 'sparda_bank_wien'
| 'volksbank_gruppe'
| 'volkskreditbank_ag'
| 'vr_bank_braunau';
}
interface Fpx {
/**
* Account holder type for FPX transaction
*/
account_holder_type?: Fpx.AccountHolderType;
/**
* The customer's bank.
*/
bank: Fpx.Bank;
}
namespace Fpx {
type AccountHolderType = 'company' | 'individual';
type Bank =
| 'affin_bank'
| 'agrobank'
| 'alliance_bank'
| 'ambank'
| 'bank_islam'
| 'bank_muamalat'
| 'bank_of_china'
| 'bank_rakyat'
| 'bsn'
| 'cimb'
| 'deutsche_bank'
| 'hong_leong_bank'
| 'hsbc'
| 'kfh'
| 'maybank2e'
| 'maybank2u'
| 'ocbc'
| 'pb_enterprise'
| 'public_bank'
| 'rhb'
| 'standard_chartered'
| 'uob';
}
interface Giropay {}
interface Grabpay {}
interface Ideal {
/**
* The customer's bank.
*/
bank?: Ideal.Bank;
}
namespace Ideal {
type Bank =
| 'abn_amro'
| 'asn_bank'
| 'bunq'
| 'handelsbanken'
| 'ing'
| 'knab'
| 'moneyou'
| 'rabobank'
| 'regiobank'
| 'revolut'
| 'sns_bank'
| 'triodos_bank'
| 'van_lanschot'
| 'yoursafe';
}
interface InteracPresent {}
interface Klarna {
/**
* Customer's date of birth
*/
dob?: Klarna.Dob;
}
namespace Klarna {
interface Dob {
/**
* The day of birth, between 1 and 31.
*/
day: number;
/**
* The month of birth, between 1 and 12.
*/
month: number;
/**
* The four-digit year of birth.
*/
year: number;
}
}
interface Konbini {}
interface Link {}
interface Oxxo {}
interface P24 {
/**
* The customer's bank.
*/
bank?: P24.Bank;
}
namespace P24 {
type Bank =
| 'alior_bank'
| 'bank_millennium'
| 'bank_nowy_bfg_sa'
| 'bank_pekao_sa'
| 'banki_spbdzielcze'
| 'blik'
| 'bnp_paribas'
| 'boz'
| 'citi_handlowy'
| 'credit_agricole'
| 'envelobank'
| 'etransfer_pocztowy24'
| 'getin_bank'
| 'ideabank'
| 'ing'
| 'inteligo'
| 'mbank_mtransfer'
| 'nest_przelew'
| 'noble_pay'
| 'pbac_z_ipko'
| 'plus_bank'
| 'santander_przelew24'
| 'tmobile_usbugi_bankowe'
| 'toyota_bank'
| 'volkswagen_bank';
}
interface Paynow {}
interface Paypal {}
interface Pix {}
interface Promptpay {}
interface RadarOptions {
/**
* A [Radar Session](https://docs.epayments.network/radar/radar-session) is a snapshot of the browser metadata and device details that help Radar make more accurate predictions on your payments.
*/
session?: string;
}
interface SepaDebit {
/**
* IBAN of the bank account.
*/
iban: string;
}
interface Sofort {
/**
* Two-letter ISO code representing the country the bank account is located in.
*/
country: Sofort.Country;
}
namespace Sofort {
type Country = 'AT' | 'BE' | 'DE' | 'ES' | 'IT' | 'NL';
}
type Type =
| 'acss_debit'
| 'affirm'
| 'afterpay_clearpay'
| 'alipay'
| 'au_becs_debit'
| 'bacs_debit'
| 'bancontact'
| 'blik'
| 'boleto'
| 'cashapp'
| 'customer_balance'
| 'eps'
| 'fpx'
| 'giropay'
| 'grabpay'
| 'ideal'
| 'klarna'
| 'konbini'
| 'link'
| 'oxxo'
| 'p24'
| 'paynow'
| 'paypal'
| 'pix'
| 'promptpay'
| 'sepa_debit'
| 'sofort'
| 'us_bank_account'
| 'wechat_pay'
| 'zip';
interface UsBankAccount {
/**
* Account holder type: individual or company.
*/
account_holder_type?: UsBankAccount.AccountHolderType;
/**
* Account number of the bank account.
*/
account_number?: string;
/**
* Account type: checkings or savings. Defaults to checking if omitted.
*/
account_type?: UsBankAccount.AccountType;
/**
* The ID of a Financial Connections Account to use as a payment method.
*/
financial_connections_account?: string;
/**
* Routing number of the bank account.
*/
routing_number?: string;
}
namespace UsBankAccount {
type AccountHolderType = 'company' | 'individual';
type AccountType = 'checking' | 'savings';
}
interface WechatPay {}
interface Zip {}
}
interface PaymentMethodOptions {
/**
* If this is a `acss_debit` PaymentMethod, this sub-hash contains details about the ACSS Debit payment method options.
*/
acss_debit?: ExpressPayments.Emptyable<
PaymentMethodOptions.AcssDebit
>;
/**
* If this is an `affirm` PaymentMethod, this sub-hash contains details about the Affirm payment method options.
*/
affirm?: ExpressPayments.Emptyable<PaymentMethodOptions.Affirm>;
/**
* If this is a `afterpay_clearpay` PaymentMethod, this sub-hash contains details about the Afterpay Clearpay payment method options.
*/
afterpay_clearpay?: ExpressPayments.Emptyable<
PaymentMethodOptions.AfterpayClearpay
>;
/**
* If this is a `alipay` PaymentMethod, this sub-hash contains details about the Alipay payment method options.
*/
alipay?: ExpressPayments.Emptyable<PaymentMethodOptions.Alipay>;
/**
* If this is a `au_becs_debit` PaymentMethod, this sub-hash contains details about the AU BECS Direct Debit payment method options.
*/
au_becs_debit?: ExpressPayments.Emptyable<
PaymentMethodOptions.AuBecsDebit
>;
/**
* If this is a `bacs_debit` PaymentMethod, this sub-hash contains details about the BACS Debit payment method options.
*/
bacs_debit?: ExpressPayments.Emptyable<
PaymentMethodOptions.BacsDebit
>;
/**
* If this is a `bancontact` PaymentMethod, this sub-hash contains details about the Bancontact payment method options.
*/
bancontact?: ExpressPayments.Emptyable<
PaymentMethodOptions.Bancontact
>;
/**
* If this is a `blik` PaymentMethod, this sub-hash contains details about the BLIK payment method options.
*/
blik?: ExpressPayments.Emptyable<PaymentMethodOptions.Blik>;
/**
* If this is a `boleto` PaymentMethod, this sub-hash contains details about the Boleto payment method options.
*/
boleto?: ExpressPayments.Emptyable<PaymentMethodOptions.Boleto>;
/**
* Configuration for any card payments attempted on this PaymentIntent.
*/
card?: ExpressPayments.Emptyable<PaymentMethodOptions.Card>;
/**
* If this is a `card_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
*/
card_present?: ExpressPayments.Emptyable<
PaymentMethodOptions.CardPresent
>;
/**
* If this is a `cashapp` PaymentMethod, this sub-hash contains details about the Cash App Pay payment method options.
*/
cashapp?: ExpressPayments.Emptyable<
PaymentMethodOptions.Cashapp
>;
/**
* If this is a `customer balance` PaymentMethod, this sub-hash contains details about the customer balance payment method options.
*/
customer_balance?: ExpressPayments.Emptyable<
PaymentMethodOptions.CustomerBalance
>;
/**
* If this is a `eps` PaymentMethod, this sub-hash contains details about the EPS payment method options.
*/
eps?: ExpressPayments.Emptyable<PaymentMethodOptions.Eps>;
/**
* If this is a `fpx` PaymentMethod, this sub-hash contains details about the FPX payment method options.
*/
fpx?: ExpressPayments.Emptyable<PaymentMethodOptions.Fpx>;
/**
* If this is a `giropay` PaymentMethod, this sub-hash contains details about the Giropay payment method options.
*/
giropay?: ExpressPayments.Emptyable<
PaymentMethodOptions.Giropay
>;
/**
* If this is a `grabpay` PaymentMethod, this sub-hash contains details about the Grabpay payment method options.
*/
grabpay?: ExpressPayments.Emptyable<
PaymentMethodOptions.Grabpay
>;
/**
* If this is a `ideal` PaymentMethod, this sub-hash contains details about the Ideal payment method options.
*/
ideal?: ExpressPayments.Emptyable<PaymentMethodOptions.Ideal>;
/**
* If this is a `interac_present` PaymentMethod, this sub-hash contains details about the Card Present payment method options.
*/
interac_present?: ExpressPayments.Emptyable<
PaymentMethodOptions.InteracPresent
>;
/**
* If this is a `klarna` PaymentMethod, this sub-hash contains details about the Klarna payment method options.
*/
klarna?: ExpressPayments.Emptyable<PaymentMethodOptions.Klarna>;
/**
* If this is a `konbini` PaymentMethod, this sub-hash contains details about the Konbini payment method options.
*/
konbini?: ExpressPayments.Emptyable<
PaymentMethodOptions.Konbini
>;
/**
* If this is a `link` PaymentMethod, this sub-hash contains details about the Link payment method options.
*/
link?: ExpressPayments.Emptyable<PaymentMethodOptions.Link>;
/**
* If this is a `oxxo` PaymentMethod, this sub-hash contains details about the OXXO payment method options.
*/
oxxo?: ExpressPayments.Emptyable<PaymentMethodOptions.Oxxo>;
/**
* If this is a `p24` PaymentMethod, this sub-hash contains details about the Przelewy24 payment method options.
*/
p24?: ExpressPayments.Emptyable<PaymentMethodOptions.P24>;
/**
* If this is a `paynow` PaymentMethod, this sub-hash contains details about the PayNow payment method options.
*/
paynow?: ExpressPayments.Emptyable<PaymentMethodOptions.Paynow>;
/**
* If this is a `paypal` PaymentMethod, this sub-hash contains details about the PayPal payment method options.
*/
paypal?: ExpressPayments.Emptyable<PaymentMethodOptions.Paypal>;
/**
* If this is a `pix` PaymentMethod, this sub-hash contains details about the Pix payment method options.
*/
pix?: ExpressPayments.Emptyable<PaymentMethodOptions.Pix>;
/**
* If this is a `promptpay` PaymentMethod, this sub-hash contains details about the PromptPay payment method options.
*/
promptpay?: ExpressPayments.Emptyable<
PaymentMethodOptions.Promptpay
>;
/**
* If this is a `sepa_debit` PaymentIntent, this sub-hash contains details about the SEPA Debit payment method options.
*/
sepa_debit?: ExpressPayments.Emptyable<
PaymentMethodOptions.SepaDebit
>;
/**
* If this is a `sofort` PaymentMethod, this sub-hash contains details about the SOFORT payment method options.
*/
sofort?: ExpressPayments.Emptyable<PaymentMethodOptions.Sofort>;
/**
* If this is a `us_bank_account` PaymentMethod, this sub-hash contains details about the US bank account payment method options.
*/
us_bank_account?: ExpressPayments.Emptyable<
PaymentMethodOptions.UsBankAccount
>;
/**
* If this is a `wechat_pay` PaymentMethod, this sub-hash contains details about the WeChat Pay payment method options.
*/
wechat_pay?: ExpressPayments.Emptyable<
PaymentMethodOptions.WechatPay
>;
/**
* If this is a `zip` PaymentMethod, this sub-hash contains details about the Zip payment method options.
*/
zip?: ExpressPayments.Emptyable<PaymentMethodOptions.Zip>;
}
namespace PaymentMethodOptions {
interface AcssDebit {
/**
* Additional fields for Mandate creation
*/
mandate_options?: AcssDebit.MandateOptions;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
*
* Providing this parameter will [attach the payment method](https://docs.epayments.network/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://docs.epayments.network/api/payment_methods/attach) to a Customer after the transaction completes.
*
* When processing card payments, ExpressPayments also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://docs.epayments.network/strong-customer-authentication).
*
* If `setup_future_usage` is already set, and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
*/
setup_future_usage?: ExpressPayments.Emptyable<
AcssDebit.SetupFutureUsage
>;
/**
* Verification method for the intent
*/
verification_method?: AcssDebit.VerificationMethod;
}
namespace AcssDebit {
interface MandateOptions {
/**
* A URL for custom mandate text to render during confirmation step.
* The URL will be rendered with additional GET parameters `payment_intent` and `payment_intent_client_secret` when confirming a Payment Intent,
* or `setup_intent` and `setup_intent_client_secret` when confirming a Setup Intent.
*/
custom_mandate_url?: ExpressPayments.Emptyable<string>;
/**
* Description of the mandate interval. Only required if 'payment_schedule' parameter is 'interval' or 'combined'.
*/
interval_description?: string;
/**
* Payment schedule for the mandate.
*/
payment_schedule?: MandateOptions.PaymentSchedule;
/**
* Transaction type of the mandate.
*/
transaction_type?: MandateOptions.TransactionType;
}
namespace MandateOptions {
type PaymentSchedule =
| 'combined'
| 'interval'
| 'sporadic';
type TransactionType = 'business' | 'personal';
}
type SetupFutureUsage =
| 'none'
| 'off_session'
| 'on_session';
type VerificationMethod =
| 'automatic'
| 'instant'
| 'microdeposits';
}
interface Affirm {
/**
* Controls when the funds will be captured from the customer's account.
*
* If provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.
*
* If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.
*/
capture_method?: ExpressPayments.Emptyable<'manual'>;
/**
* Preferred language of the Affirm authorization page that the customer is redirected to.
*/
preferred_locale?: string;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
*
* Providing this parameter will [attach the payment method](https://docs.epayments.network/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://docs.epayments.network/api/payment_methods/attach) to a Customer after the transaction completes.
*
* When processing card payments, ExpressPayments also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules, such as [SCA](https://docs.epayments.network/strong-customer-authentication).
*
* If `setup_future_usage` is already set, and you are performing a request using a publishable key, you may only update the value from `on_session` to `off_session`.
*/
setup_future_usage?: 'none';
}
interface AfterpayClearpay {
/**
* Controls when the funds will be captured from the customer's account.
*
* If provided, this parameter will override the top-level `capture_method` when finalizing the payment with this payment method type.
*
* If `capture_method` is already set on the PaymentIntent, providing an empty value for this parameter will unset the stored value for this payment method type.
*/
capture_method?: ExpressPayments.Emptyable<'manual'>;
/**
* Order identifier shown to the customer in Afterpay's online portal. We recommend using a value that helps you answer any questions a customer might have about
* the payment. The identifier is limited to 128 characters and may contain only letters, digits, underscores, backslashes and dashes.
*/
reference?: string;
/**
* Indicates that you intend to make future payments with this PaymentIntent's payment method.
*
* Providing this parameter will [attach the payment method](https://docs.epayments.network/payments/save-during-payment) to the PaymentIntent's Customer, if present, after the PaymentIntent is confirmed and any required actions from the user are complete. If no Customer was provided, the payment method can still be [attached](https://docs.epayments.network/api/payment_methods/attach) to a Customer after the transaction completes.
*
* When processing card payments, ExpressPayments also uses `setup_future_usage` to dynamically optimize your payment flow and comply with regional legislation and network rules