expresspayments
Version:
ExpressPayments API wrapper
1,032 lines (886 loc) • 59.9 kB
TypeScript
// File generated from our OpenAPI spec
declare module 'expresspayments' {
namespace ExpressPayments {
/**
* Invoices are statements of amounts owed by a customer, and are either
* generated one-off, or generated periodically from a subscription.
*
* They contain [invoice items](https://docs.epayments.network/api#invoiceitems), and proration adjustments
* that may be caused by subscription upgrades/downgrades (if necessary).
*
* If your invoice is configured to be billed through automatic charges,
* ExpressPayments automatically finalizes your invoice and attempts payment. Note
* that finalizing the invoice,
* [when automatic](https://docs.epayments.network/invoicing/integration/automatic-advancement-collection), does
* not happen immediately as the invoice is created. ExpressPayments waits
* until one hour after the last webhook was successfully sent (or the last
* webhook timed out after failing). If you (and the platforms you may have
* connected to) have no webhooks configured, ExpressPayments waits one hour after
* creation to finalize the invoice.
*
* If your invoice is configured to be billed by sending an email, then based on your
* [email settings](https://dashboard.epayments.network/account/billing/automatic),
* ExpressPayments will email the invoice to your customer and await payment. These
* emails can contain a link to a hosted page to pay the invoice.
*
* ExpressPayments applies any customer credit on the account before determining the
* amount due for the invoice (i.e., the amount that will be actually
* charged). If the amount due for the invoice is less than ExpressPayments' [minimum allowed charge
* per currency](https://docs.epayments.network/currencies#minimum-and-maximum-charge-amounts), the
* invoice is automatically marked paid, and we add the amount due to the
* customer's credit balance which is applied to the next invoice.
*
* More details on the customer's credit balance are
* [here](https://docs.epayments.network/billing/customer/balance).
*
* Related guide: [Send invoices to customers](https://docs.epayments.network/billing/invoices/sending)
*/
interface Invoice {
/**
* Unique identifier for the object. This property is always present unless the invoice is an upcoming invoice. See [Retrieve an upcoming invoice](https://docs.epayments.network/api/invoices/upcoming) for more details.
*/
id: string;
/**
* String representing the object's type. Objects of the same type share the same value.
*/
object: 'invoice';
/**
* The country of the business associated with this invoice, most often the business creating the invoice.
*/
account_country: string | null;
/**
* The public name of the business associated with this invoice, most often the business creating the invoice.
*/
account_name: string | null;
/**
* The account tax IDs associated with the invoice. Only editable when the invoice is a draft.
*/
account_tax_ids: Array<
string | ExpressPayments.TaxId | ExpressPayments.DeletedTaxId
> | null;
/**
* Final amount due at this time for this invoice. If the invoice's total is smaller than the minimum charge amount, for example, or if there is account credit that can be applied to the invoice, the `amount_due` may be 0. If there is a positive `starting_balance` for the invoice (the customer owes money), the `amount_due` will also take that into account. The charge that gets generated for the invoice will be for the amount specified in `amount_due`.
*/
amount_due: number;
/**
* The amount, in %s, that was paid.
*/
amount_paid: number;
/**
* The difference between amount_due and amount_paid, in %s.
*/
amount_remaining: number;
/**
* This is the sum of all the shipping amounts.
*/
amount_shipping: number;
/**
* ID of the Connect Application that created the invoice.
*/
application:
| string
| ExpressPayments.Application
| ExpressPayments.DeletedApplication
| null;
/**
* The fee in %s that will be applied to the invoice and transferred to the application owner's ExpressPayments account when the invoice is paid.
*/
application_fee_amount: number | null;
/**
* Number of payment attempts made for this invoice, from the perspective of the payment retry schedule. Any payment attempt counts as the first attempt, and subsequently only automatic retries increment the attempt count. In other words, manual payment attempts after the first attempt do not affect the retry schedule.
*/
attempt_count: number;
/**
* Whether an attempt has been made to pay the invoice. An invoice is not attempted until 1 hour after the `invoice.created` webhook, for example, so you might not want to display that invoice as unpaid to your users.
*/
attempted: boolean;
/**
* Controls whether ExpressPayments performs [automatic collection](https://docs.epayments.network/invoicing/integration/automatic-advancement-collection) of the invoice. If `false`, the invoice's state doesn't automatically advance without an explicit action.
*/
auto_advance?: boolean;
automatic_tax: Invoice.AutomaticTax;
/**
* Indicates the reason why the invoice was created. `subscription_cycle` indicates an invoice created by a subscription advancing into a new period. `subscription_create` indicates an invoice created due to creating a subscription. `subscription_update` indicates an invoice created due to updating a subscription. `subscription` is set for all old invoices to indicate either a change to a subscription or a period advancement. `manual` is set for all invoices unrelated to a subscription (for example: created via the invoice editor). The `upcoming` value is reserved for simulated invoices per the upcoming invoice endpoint. `subscription_threshold` indicates an invoice created due to a billing threshold being reached.
*/
billing_reason: Invoice.BillingReason | null;
/**
* ID of the latest charge generated for this invoice, if any.
*/
charge: string | ExpressPayments.Charge | null;
/**
* Either `charge_automatically`, or `send_invoice`. When charging automatically, ExpressPayments will attempt to pay this invoice using the default source attached to the customer. When sending an invoice, ExpressPayments will email this invoice to the customer with payment instructions.
*/
collection_method: Invoice.CollectionMethod;
/**
* Time at which the object was created. Measured in seconds since the Unix epoch.
*/
created: 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;
/**
* Custom fields displayed on the invoice.
*/
custom_fields: Array<Invoice.CustomField> | null;
/**
* The ID of the customer who will be billed.
*/
customer:
| string
| ExpressPayments.Customer
| ExpressPayments.DeletedCustomer
| null;
/**
* The customer's address. Until the invoice is finalized, this field will equal `customer.address`. Once the invoice is finalized, this field will no longer be updated.
*/
customer_address: ExpressPayments.Address | null;
/**
* The customer's email. Until the invoice is finalized, this field will equal `customer.email`. Once the invoice is finalized, this field will no longer be updated.
*/
customer_email: string | null;
/**
* The customer's name. Until the invoice is finalized, this field will equal `customer.name`. Once the invoice is finalized, this field will no longer be updated.
*/
customer_name: string | null;
/**
* The customer's phone number. Until the invoice is finalized, this field will equal `customer.phone`. Once the invoice is finalized, this field will no longer be updated.
*/
customer_phone: string | null;
/**
* The customer's shipping information. Until the invoice is finalized, this field will equal `customer.shipping`. Once the invoice is finalized, this field will no longer be updated.
*/
customer_shipping: Invoice.CustomerShipping | null;
/**
* The customer's tax-exempt status. Until the invoice is finalized, this field will equal `customer.tax_exempt`. Once the invoice is finalized, this field will no longer be updated.
*/
customer_tax_exempt: Invoice.CustomerTaxExempt | null;
/**
* The customer's tax IDs. Until the invoice is finalized, this field will contain the same tax IDs as `customer.tax_ids`. Once the invoice is finalized, this field will no longer be updated.
*/
customer_tax_ids?: Array<Invoice.CustomerTaxId> | null;
/**
* ID of the default payment method for the invoice. It must belong to the customer associated with the invoice. If not set, defaults to the subscription's default payment method, if any, or to the default payment method in the customer's invoice settings.
*/
default_payment_method: string | ExpressPayments.PaymentMethod | null;
/**
* ID of the default payment source for the invoice. It must belong to the customer associated with the invoice and be in a chargeable state. If not set, defaults to the subscription's default source, if any, or to the customer's default source.
*/
default_source: string | ExpressPayments.CustomerSource | null;
/**
* The tax rates applied to this invoice, if any.
*/
default_tax_rates: Array<ExpressPayments.TaxRate>;
deleted?: void;
/**
* An arbitrary string attached to the object. Often useful for displaying to users. Referenced as 'memo' in the Dashboard.
*/
description: string | null;
/**
* Describes the current discount applied to this invoice, if there is one. Not populated if there are multiple discounts.
*/
discount: ExpressPayments.Discount | null;
/**
* The discounts applied to the invoice. Line item discounts are applied before invoice discounts. Use `expand[]=discounts` to expand each discount.
*/
discounts: Array<
string | ExpressPayments.Discount | ExpressPayments.DeletedDiscount
> | null;
/**
* The date on which payment for this invoice is due. This value will be `null` for invoices where `collection_method=charge_automatically`.
*/
due_date: number | null;
/**
* Ending customer balance after the invoice is finalized. Invoices are finalized approximately an hour after successful webhook delivery or when payment collection is attempted for the invoice. If the invoice has not been finalized yet, this will be null.
*/
ending_balance: number | null;
/**
* Footer displayed on the invoice.
*/
footer: string | null;
/**
* Details of the invoice that was cloned. See the [revision documentation](https://docs.epayments.network/invoicing/invoice-revisions) for more details.
*/
from_invoice: Invoice.FromInvoice | null;
/**
* The URL for the hosted invoice page, which allows customers to view and pay an invoice. If the invoice has not been finalized yet, this will be null.
*/
hosted_invoice_url?: string | null;
/**
* The link to download the PDF for the invoice. If the invoice has not been finalized yet, this will be null.
*/
invoice_pdf?: string | null;
/**
* The error encountered during the previous attempt to finalize the invoice. This field is cleared when the invoice is successfully finalized.
*/
last_finalization_error: Invoice.LastFinalizationError | null;
/**
* The ID of the most recent non-draft revision of this invoice
*/
latest_revision: string | ExpressPayments.Invoice | null;
/**
* The individual line items that make up the invoice. `lines` is sorted as follows: (1) pending invoice items (including prorations) in reverse chronological order, (2) subscription items in reverse chronological order, and (3) invoice items added after invoice creation in chronological order.
*/
lines: ApiList<ExpressPayments.InvoiceLineItem>;
/**
* Has the value `true` if the object exists in live mode or the value `false` if the object exists in test mode.
*/
livemode: boolean;
/**
* 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.
*/
metadata: ExpressPayments.Metadata | null;
/**
* The time at which payment will next be attempted. This value will be `null` for invoices where `collection_method=send_invoice`.
*/
next_payment_attempt: number | null;
/**
* A unique, identifying string that appears on emails sent to the customer for this invoice. This starts with the customer's unique invoice_prefix if it is specified.
*/
number: string | null;
/**
* The account (if any) for which the funds of the invoice payment are intended. If set, the invoice will be presented with the branding and support information of the specified account. See the [Invoices with Connect](https://docs.epayments.network/billing/invoices/connect) documentation for details.
*/
on_behalf_of: string | ExpressPayments.Account | null;
/**
* Whether payment was successfully collected for this invoice. An invoice can be paid (most commonly) with a charge or with credit from the customer's account balance.
*/
paid: boolean;
/**
* Returns true if the invoice was manually marked paid, returns false if the invoice hasn't been paid yet or was paid on ExpressPayments.
*/
paid_out_of_band: boolean;
/**
* The PaymentIntent associated with this invoice. The PaymentIntent is generated when the invoice is finalized, and can then be used to pay the invoice. Note that voiding an invoice will cancel the PaymentIntent.
*/
payment_intent: string | ExpressPayments.PaymentIntent | null;
payment_settings: Invoice.PaymentSettings;
/**
* End of the usage period during which invoice items were added to this invoice.
*/
period_end: number;
/**
* Start of the usage period during which invoice items were added to this invoice.
*/
period_start: number;
/**
* Total amount of all post-payment credit notes issued for this invoice.
*/
post_payment_credit_notes_amount: number;
/**
* Total amount of all pre-payment credit notes issued for this invoice.
*/
pre_payment_credit_notes_amount: number;
/**
* The quote this invoice was generated from.
*/
quote: string | ExpressPayments.Quote | null;
/**
* This is the transaction number that appears on email receipts sent for this invoice.
*/
receipt_number: string | null;
/**
* Options for invoice PDF rendering.
*/
rendering_options: Invoice.RenderingOptions | null;
/**
* The details of the cost of shipping, including the ShippingRate applied on the invoice.
*/
shipping_cost: Invoice.ShippingCost | null;
/**
* Shipping details for the invoice. The Invoice PDF will use the `shipping_details` value if it is set, otherwise the PDF will render the shipping address from the customer.
*/
shipping_details: Invoice.ShippingDetails | null;
/**
* Starting customer balance before the invoice is finalized. If the invoice has not been finalized yet, this will be the current customer balance. For revision invoices, this also includes any customer balance that was applied to the original invoice.
*/
starting_balance: number;
/**
* Extra information about an invoice for the customer's credit card statement.
*/
statement_descriptor: string | null;
/**
* The status of the invoice, one of `draft`, `open`, `paid`, `uncollectible`, or `void`. [Learn more](https://docs.epayments.network/billing/invoices/workflow#workflow-overview)
*/
status: Invoice.Status | null;
status_transitions: Invoice.StatusTransitions;
/**
* The subscription that this invoice was prepared for, if any.
*/
subscription: string | ExpressPayments.Subscription | null;
/**
* Only set for upcoming invoices that preview prorations. The time used to calculate prorations.
*/
subscription_proration_date?: number;
/**
* Total of all subscriptions, invoice items, and prorations on the invoice before any invoice level discount or exclusive tax is applied. Item discounts are already incorporated
*/
subtotal: number;
/**
* The integer amount in %s representing the subtotal of the invoice before any invoice level discount or tax is applied. Item discounts are already incorporated
*/
subtotal_excluding_tax: number | null;
/**
* The amount of tax on this invoice. This is the sum of all the tax amounts on this invoice.
*/
tax: number | null;
/**
* ID of the test clock this invoice belongs to.
*/
test_clock: string | ExpressPayments.TestHelpers.TestClock | null;
threshold_reason?: Invoice.ThresholdReason;
/**
* Total after discounts and taxes.
*/
total: number;
/**
* The aggregate amounts calculated per discount across all line items.
*/
total_discount_amounts: Array<Invoice.TotalDiscountAmount> | null;
/**
* The integer amount in %s representing the total amount of the invoice including all discounts but excluding all tax.
*/
total_excluding_tax: number | null;
/**
* The aggregate amounts calculated per tax rate for all line items.
*/
total_tax_amounts: Array<Invoice.TotalTaxAmount>;
/**
* The account (if any) the payment will be attributed to for tax reporting, and where funds from the payment will be transferred to for the invoice.
*/
transfer_data: Invoice.TransferData | null;
/**
* Invoices are automatically paid or sent 1 hour after webhooks are delivered, or until all webhook delivery attempts have [been exhausted](https://docs.epayments.network/billing/webhooks#understand). This field tracks the time when webhooks for this invoice were successfully delivered. If the invoice had no webhooks to deliver, this will be set while the invoice is being created.
*/
webhooks_delivered_at: number | null;
}
namespace Invoice {
interface AutomaticTax {
/**
* Whether ExpressPayments automatically computes tax on this invoice. Note that incompatible invoice items (invoice items with manually specified [tax rates](https://docs.epayments.network/api/tax_rates), negative amounts, or `tax_behavior=unspecified`) cannot be added to automatic tax invoices.
*/
enabled: boolean;
/**
* The status of the most recent automated tax calculation for this invoice.
*/
status: AutomaticTax.Status | null;
}
namespace AutomaticTax {
type Status =
| 'complete'
| 'failed'
| 'requires_location_inputs';
}
type BillingReason =
| 'automatic_pending_invoice_item_invoice'
| 'manual'
| 'quote_accept'
| 'subscription'
| 'subscription_create'
| 'subscription_cycle'
| 'subscription_threshold'
| 'subscription_update'
| 'upcoming';
type CollectionMethod = 'charge_automatically' | 'send_invoice';
interface CustomerShipping {
address?: ExpressPayments.Address;
/**
* The delivery service that shipped a physical product, such as Fedex, UPS, USPS, etc.
*/
carrier?: string | null;
/**
* Recipient name.
*/
name?: string;
/**
* Recipient phone (including extension).
*/
phone?: string | null;
/**
* The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.
*/
tracking_number?: string | null;
}
type CustomerTaxExempt = 'exempt' | 'none' | 'reverse';
interface CustomerTaxId {
/**
* The type of the tax ID, one of `eu_vat`, `br_cnpj`, `br_cpf`, `eu_oss_vat`, `gb_vat`, `nz_gst`, `au_abn`, `au_arn`, `in_gst`, `no_vat`, `za_vat`, `ch_vat`, `mx_rfc`, `sg_uen`, `ru_inn`, `ru_kpp`, `ca_bn`, `hk_br`, `es_cif`, `tw_vat`, `th_vat`, `jp_cn`, `jp_rn`, `jp_trn`, `li_uid`, `my_itn`, `us_ein`, `kr_brn`, `ca_qst`, `ca_gst_hst`, `ca_pst_bc`, `ca_pst_mb`, `ca_pst_sk`, `my_sst`, `sg_gst`, `ae_trn`, `cl_tin`, `sa_vat`, `id_npwp`, `my_frp`, `il_vat`, `ge_vat`, `ua_vat`, `is_vat`, `bg_uic`, `hu_tin`, `si_tin`, `ke_pin`, `tr_tin`, `eg_tin`, `ph_tin`, or `unknown`
*/
type: CustomerTaxId.Type;
/**
* The value of the tax ID.
*/
value: string | null;
}
namespace CustomerTaxId {
type Type =
| 'ae_trn'
| 'au_abn'
| 'au_arn'
| 'bg_uic'
| 'br_cnpj'
| 'br_cpf'
| 'ca_bn'
| 'ca_gst_hst'
| 'ca_pst_bc'
| 'ca_pst_mb'
| 'ca_pst_sk'
| 'ca_qst'
| 'ch_vat'
| 'cl_tin'
| 'eg_tin'
| 'es_cif'
| 'eu_oss_vat'
| 'eu_vat'
| 'gb_vat'
| 'ge_vat'
| 'hk_br'
| 'hu_tin'
| 'id_npwp'
| 'il_vat'
| 'in_gst'
| 'is_vat'
| 'jp_cn'
| 'jp_rn'
| 'jp_trn'
| 'ke_pin'
| 'kr_brn'
| 'li_uid'
| 'mx_rfc'
| 'my_frp'
| 'my_itn'
| 'my_sst'
| 'no_vat'
| 'nz_gst'
| 'ph_tin'
| 'ru_inn'
| 'ru_kpp'
| 'sa_vat'
| 'sg_gst'
| 'sg_uen'
| 'si_tin'
| 'th_vat'
| 'tr_tin'
| 'tw_vat'
| 'ua_vat'
| 'unknown'
| 'us_ein'
| 'za_vat';
}
interface CustomField {
/**
* The name of the custom field.
*/
name: string;
/**
* The value of the custom field.
*/
value: string;
}
interface FromInvoice {
/**
* The relation between this invoice and the cloned invoice
*/
action: string;
/**
* The invoice that was cloned.
*/
invoice: string | ExpressPayments.Invoice;
}
interface LastFinalizationError {
/**
* For card errors, the ID of the failed charge.
*/
charge?: string;
/**
* For some errors that could be handled programmatically, a short string indicating the [error code](https://docs.epayments.network/error-codes) reported.
*/
code?: LastFinalizationError.Code;
/**
* For card errors resulting from a card issuer decline, a short string indicating the [card issuer's reason for the decline](https://docs.epayments.network/declines#issuer-declines) if they provide one.
*/
decline_code?: string;
/**
* A URL to more information about the [error code](https://docs.epayments.network/error-codes) reported.
*/
doc_url?: string;
/**
* A human-readable message providing more details about the error. For card errors, these messages can be shown to your users.
*/
message?: string;
/**
* If the error is parameter-specific, the parameter related to the error. For example, you can use this to display a message near the correct form field.
*/
param?: string;
/**
* A PaymentIntent guides you through the process of collecting a payment from your customer.
* We recommend that you create exactly one PaymentIntent for each order or
* customer session in your system. You can reference the PaymentIntent later to
* see the history of payment attempts for a particular session.
*
* A PaymentIntent transitions through
* [multiple statuses](https://docs.epayments.network/payments/intents#intent-statuses)
* throughout its lifetime as it interfaces with ExpressPayments.js to perform
* authentication flows and ultimately creates at most one successful charge.
*
* Related guide: [Payment Intents API](https://docs.epayments.network/payments/payment-intents)
*/
payment_intent?: ExpressPayments.PaymentIntent;
/**
* PaymentMethod objects represent your customer's payment instruments.
* You can use them with [PaymentIntents](https://docs.epayments.network/payments/payment-intents) to collect payments or save them to
* Customer objects to store instrument details for future payments.
*
* Related guides: [Payment Methods](https://docs.epayments.network/payments/payment-methods) and [More Payment Scenarios](https://docs.epayments.network/payments/more-payment-scenarios).
*/
payment_method?: ExpressPayments.PaymentMethod;
/**
* If the error is specific to the type of payment method, the payment method type that had a problem. This field is only populated for invoice-related errors.
*/
payment_method_type?: string;
/**
* A URL to the request log entry in your dashboard.
*/
request_log_url?: string;
/**
* A SetupIntent guides you through the process of setting up and saving a customer's payment credentials for future payments.
* For example, you could use a SetupIntent to set up and save your customer's card without immediately collecting a payment.
* Later, you can use [PaymentIntents](https://docs.epayments.network/api#payment_intents) to drive the payment flow.
*
* Create a SetupIntent as soon as you're ready to collect your customer's payment credentials.
* Do not maintain long-lived, unconfirmed SetupIntents as they may no longer be valid.
* The SetupIntent then transitions through multiple [statuses](https://docs.epayments.network/payments/intents#intent-statuses) as it guides
* you through the setup process.
*
* Successful SetupIntents result in payment credentials that are optimized for future payments.
* For example, cardholders in [certain regions](https://epayments.network/guides/strong-customer-authentication) may need to be run through
* [Strong Customer Authentication](https://docs.epayments.network/strong-customer-authentication) at the time of payment method collection
* in order to streamline later [off-session payments](https://docs.epayments.network/payments/setup-intents).
* If the SetupIntent is used with a [Customer](https://docs.epayments.network/api#setup_intent_object-customer), upon success,
* it will automatically attach the resulting payment method to that Customer.
* We recommend using SetupIntents or [setup_future_usage](https://docs.epayments.network/api#payment_intent_object-setup_future_usage) on
* PaymentIntents to save payment methods in order to prevent saving invalid or unoptimized payment methods.
*
* By using SetupIntents, you ensure that your customers experience the minimum set of required friction,
* even as regulations change over time.
*
* Related guide: [Setup Intents API](https://docs.epayments.network/payments/setup-intents)
*/
setup_intent?: ExpressPayments.SetupIntent;
source?: ExpressPayments.CustomerSource;
/**
* The type of error returned. One of `api_error`, `card_error`, `idempotency_error`, or `invalid_request_error`
*/
type: LastFinalizationError.Type;
}
namespace LastFinalizationError {
type Code =
| 'account_closed'
| 'account_country_invalid_address'
| 'account_error_country_change_requires_additional_steps'
| 'account_information_mismatch'
| 'account_invalid'
| 'account_number_invalid'
| 'acss_debit_session_incomplete'
| 'alipay_upgrade_required'
| 'amount_too_large'
| 'amount_too_small'
| 'api_key_expired'
| 'authentication_required'
| 'balance_insufficient'
| 'bank_account_bad_routing_numbers'
| 'bank_account_declined'
| 'bank_account_exists'
| 'bank_account_restricted'
| 'bank_account_unusable'
| 'bank_account_unverified'
| 'bank_account_verification_failed'
| 'billing_invalid_mandate'
| 'bitcoin_upgrade_required'
| 'capture_charge_authorization_expired'
| 'capture_unauthorized_payment'
| 'card_decline_rate_limit_exceeded'
| 'card_declined'
| 'cardholder_phone_number_required'
| 'charge_already_captured'
| 'charge_already_refunded'
| 'charge_disputed'
| 'charge_exceeds_source_limit'
| 'charge_expired_for_capture'
| 'charge_invalid_parameter'
| 'charge_not_refundable'
| 'clearing_code_unsupported'
| 'country_code_invalid'
| 'country_unsupported'
| 'coupon_expired'
| 'customer_max_payment_methods'
| 'customer_max_subscriptions'
| 'debit_not_authorized'
| 'email_invalid'
| 'expired_card'
| 'idempotency_key_in_use'
| 'incorrect_address'
| 'incorrect_cvc'
| 'incorrect_number'
| 'incorrect_zip'
| 'instant_payouts_config_disabled'
| 'instant_payouts_currency_disabled'
| 'instant_payouts_limit_exceeded'
| 'instant_payouts_unsupported'
| 'insufficient_funds'
| 'intent_invalid_state'
| 'intent_verification_method_missing'
| 'invalid_card_type'
| 'invalid_characters'
| 'invalid_charge_amount'
| 'invalid_cvc'
| 'invalid_expiry_month'
| 'invalid_expiry_year'
| 'invalid_number'
| 'invalid_source_usage'
| 'invoice_no_customer_line_items'
| 'invoice_no_payment_method_types'
| 'invoice_no_subscription_line_items'
| 'invoice_not_editable'
| 'invoice_on_behalf_of_not_editable'
| 'invoice_payment_intent_requires_action'
| 'invoice_upcoming_none'
| 'livemode_mismatch'
| 'lock_timeout'
| 'missing'
| 'no_account'
| 'not_allowed_on_standard_account'
| 'out_of_inventory'
| 'ownership_declaration_not_allowed'
| 'parameter_invalid_empty'
| 'parameter_invalid_integer'
| 'parameter_invalid_string_blank'
| 'parameter_invalid_string_empty'
| 'parameter_missing'
| 'parameter_unknown'
| 'parameters_exclusive'
| 'payment_intent_action_required'
| 'payment_intent_authentication_failure'
| 'payment_intent_incompatible_payment_method'
| 'payment_intent_invalid_parameter'
| 'payment_intent_konbini_rejected_confirmation_number'
| 'payment_intent_mandate_invalid'
| 'payment_intent_payment_attempt_expired'
| 'payment_intent_payment_attempt_failed'
| 'payment_intent_unexpected_state'
| 'payment_method_bank_account_already_verified'
| 'payment_method_bank_account_blocked'
| 'payment_method_billing_details_address_missing'
| 'payment_method_configuration_failures'
| 'payment_method_currency_mismatch'
| 'payment_method_customer_decline'
| 'payment_method_invalid_parameter'
| 'payment_method_invalid_parameter_testmode'
| 'payment_method_microdeposit_failed'
| 'payment_method_microdeposit_verification_amounts_invalid'
| 'payment_method_microdeposit_verification_amounts_mismatch'
| 'payment_method_microdeposit_verification_attempts_exceeded'
| 'payment_method_microdeposit_verification_descriptor_code_mismatch'
| 'payment_method_microdeposit_verification_timeout'
| 'payment_method_not_available'
| 'payment_method_provider_decline'
| 'payment_method_provider_timeout'
| 'payment_method_unactivated'
| 'payment_method_unexpected_state'
| 'payment_method_unsupported_type'
| 'payout_reconciliation_not_ready'
| 'payouts_limit_exceeded'
| 'payouts_not_allowed'
| 'platform_account_required'
| 'platform_api_key_expired'
| 'postal_code_invalid'
| 'processing_error'
| 'product_inactive'
| 'progressive_onboarding_limit_exceeded'
| 'rate_limit'
| 'refer_to_customer'
| 'refund_disputed_payment'
| 'resource_already_exists'
| 'resource_missing'
| 'return_intent_already_processed'
| 'routing_number_invalid'
| 'secret_key_required'
| 'sepa_unsupported_account'
| 'setup_attempt_failed'
| 'setup_intent_authentication_failure'
| 'setup_intent_invalid_parameter'
| 'setup_intent_mandate_invalid'
| 'setup_intent_setup_attempt_expired'
| 'setup_intent_unexpected_state'
| 'shipping_calculation_failed'
| 'sku_inactive'
| 'state_unsupported'
| 'status_transition_invalid'
| 'tax_id_invalid'
| 'taxes_calculation_failed'
| 'terminal_location_country_unsupported'
| 'terminal_reader_busy'
| 'terminal_reader_offline'
| 'terminal_reader_timeout'
| 'testmode_charges_only'
| 'tls_version_unsupported'
| 'token_already_used'
| 'token_in_use'
| 'transfer_source_balance_parameters_mismatch'
| 'transfers_not_allowed'
| 'url_invalid';
type Type =
| 'api_error'
| 'card_error'
| 'idempotency_error'
| 'invalid_request_error';
}
interface PaymentSettings {
/**
* ID of the mandate to be used for this invoice. It must correspond to the payment method used to pay the invoice, including the invoice's default_payment_method or default_source, if set.
*/
default_mandate: string | null;
/**
* Payment-method-specific configuration to provide to the invoice's PaymentIntent.
*/
payment_method_options: PaymentSettings.PaymentMethodOptions | null;
/**
* The list of payment method types (e.g. card) to provide to the invoice's PaymentIntent. If not set, ExpressPayments attempts to automatically determine the types to use by looking at the invoice's default payment method, the subscription's default payment method, the customer's default payment method, and your [invoice template settings](https://dashboard.epayments.network/settings/billing/invoice).
*/
payment_method_types: Array<
PaymentSettings.PaymentMethodType
> | null;
}
namespace PaymentSettings {
interface PaymentMethodOptions {
/**
* If paying by `acss_debit`, this sub-hash contains details about the Canadian pre-authorized debit payment method options to pass to the invoice's PaymentIntent.
*/
acss_debit: PaymentMethodOptions.AcssDebit | null;
/**
* If paying by `bancontact`, this sub-hash contains details about the Bancontact payment method options to pass to the invoice's PaymentIntent.
*/
bancontact: PaymentMethodOptions.Bancontact | null;
/**
* If paying by `card`, this sub-hash contains details about the Card payment method options to pass to the invoice's PaymentIntent.
*/
card: PaymentMethodOptions.Card | null;
/**
* If paying by `customer_balance`, this sub-hash contains details about the Bank transfer payment method options to pass to the invoice's PaymentIntent.
*/
customer_balance: PaymentMethodOptions.CustomerBalance | null;
/**
* If paying by `konbini`, this sub-hash contains details about the Konbini payment method options to pass to the invoice's PaymentIntent.
*/
konbini: PaymentMethodOptions.Konbini | null;
/**
* If paying by `us_bank_account`, this sub-hash contains details about the ACH direct debit payment method options to pass to the invoice's PaymentIntent.
*/
us_bank_account: PaymentMethodOptions.UsBankAccount | null;
}
namespace PaymentMethodOptions {
interface AcssDebit {
mandate_options?: AcssDebit.MandateOptions;
/**
* Bank account verification method.
*/
verification_method?: AcssDebit.VerificationMethod;
}
namespace AcssDebit {
interface MandateOptions {
/**
* Transaction type of the mandate.
*/
transaction_type: MandateOptions.TransactionType | null;
}
namespace MandateOptions {
type TransactionType = 'business' | 'personal';
}
type VerificationMethod =
| 'automatic'
| 'instant'
| 'microdeposits';
}
interface Bancontact {
/**
* Preferred language of the Bancontact authorization page that the customer is redirected to.
*/
preferred_language: Bancontact.PreferredLanguage;
}
namespace Bancontact {
type PreferredLanguage = 'de' | 'en' | 'fr' | 'nl';
}
interface Card {
installments?: Card.Installments;
/**
* We strongly recommend that you rely on our SCA Engine to automatically prompt your customers for authentication based on risk level and [other requirements](https://docs.epayments.network/strong-customer-authentication). However, if you wish to request 3D Secure based on logic from your own fraud engine, provide this option. Read our guide on [manually requesting 3D Secure](https://docs.epayments.network/payments/3d-secure#manual-three-ds) for more information on how this configuration interacts with Radar and our SCA Engine.
*/
request_three_d_secure: Card.RequestThreeDSecure | null;
}
namespace Card {
interface Installments {
/**
* Whether Installments are enabled for this Invoice.
*/
enabled: boolean | null;
}
type RequestThreeDSecure = 'any' | 'automatic';
}
interface CustomerBalance {
bank_transfer?: CustomerBalance.BankTransfer;
/**
* The funding method type to be used when there are not enough funds in the customer balance. Permitted values include: `bank_transfer`.
*/
funding_type: 'bank_transfer' | null;
}
namespace CustomerBalance {
interface BankTransfer {
eu_bank_transfer?: BankTransfer.EuBankTransfer;
/**
* The bank transfer type that can be used for funding. Permitted values include: `eu_bank_transfer`, `gb_bank_transfer`, `jp_bank_transfer`, `mx_bank_transfer`, or `us_bank_transfer`.
*/
type: string | null;
}
namespace BankTransfer {
interface EuBankTransfer {
/**
* The desired country code of the bank account information. Permitted values include: `BE`, `DE`, `ES`, `FR`, `IE`, or `NL`.
*/
country: EuBankTransfer.Country;
}
namespace EuBankTransfer {
type Country =
| 'BE'
| 'DE'
| 'ES'
| 'FR'
| 'IE'
| 'NL';
}
}
}
interface Konbini {}
interface UsBankAccount {
financial_connections?: UsBankAccount.FinancialConnections;
/**
* Bank account verification method.
*/
verification_method?: UsBankAccount.VerificationMethod;
}
namespace UsBankAccount {
interface FinancialConnections {
/**
* The list of permissions to request. The `payment_method` permission must be included.
*/
permissions?: Array<
FinancialConnections.Permission
>;
}
namespace FinancialConnections {
type Permission =
| 'balances'
| 'payment_method'
| 'transactions';
}
type VerificationMethod =
| 'automatic'