expresspayments
Version:
ExpressPayments API wrapper
1,076 lines (890 loc) • 162 kB
TypeScript
// File generated from our OpenAPI spec
declare module 'expresspayments' {
namespace ExpressPayments {
interface AccountCreateParams {
/**
* An [account token](https://docs.epayments.network/api#create_account_token), used to securely provide details to the account.
*/
account_token?: string;
/**
* Business information about the account.
*/
business_profile?: AccountCreateParams.BusinessProfile;
/**
* The business type.
*/
business_type?: AccountCreateParams.BusinessType;
/**
* Each key of the dictionary represents a capability, and each capability maps to its settings (e.g. whether it has been requested or not). Each capability will be inactive until you have provided its specific requirements and ExpressPayments has verified them. An account may have some of its requested capabilities be active and some be inactive.
*/
capabilities?: AccountCreateParams.Capabilities;
/**
* Information about the company or business. This field is available for any `business_type`.
*/
company?: AccountCreateParams.Company;
/**
* The country in which the account holder resides, or in which the business is legally established. This should be an ISO 3166-1 alpha-2 country code. For example, if you are in the United States and the business for which you're creating an account is legally represented in Canada, you would use `CA` as the country for the account being created. Available countries include [ExpressPayments' global markets](https://epayments.network/global) as well as countries where [cross-border payouts](https://docs.epayments.network/connect/cross-border-payouts) are supported.
*/
country?: string;
/**
* Three-letter ISO currency code representing the default currency for the account. This must be a currency that [ExpressPayments supports in the account's country](https://docs.epayments.network/payouts).
*/
default_currency?: string;
/**
* Documents that may be submitted to satisfy various informational requests.
*/
documents?: AccountCreateParams.Documents;
/**
* The email address of the account holder. This is only to make the account easier to identify to you. ExpressPayments only emails Custom accounts with your consent.
*/
email?: string;
/**
* Specifies which fields in the response should be expanded.
*/
expand?: Array<string>;
/**
* A card or bank account to attach to the account for receiving [payouts](https://docs.epayments.network/connect/bank-debit-card-payouts) (you won't be able to use it for top-ups). You can provide either a token, like the ones returned by [ExpressPayments.js](https://docs.epayments.network/js), or a dictionary, as documented in the `external_account` parameter for [bank account](https://docs.epayments.network/api#account_create_bank_account) creation.
*
* By default, providing an external account sets it as the new default external account for its currency, and deletes the old default if one exists. To add additional external accounts without replacing the existing default for the currency, use the [bank account](https://docs.epayments.network/api#account_create_bank_account) or [card creation](https://docs.epayments.network/api#account_create_card) APIs.
*/
external_account?: string | AccountCreateParams.ExternalAccount;
/**
* Information about the person represented by the account. This field is null unless `business_type` is set to `individual`.
*/
individual?: AccountCreateParams.Individual;
/**
* 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.Emptyable<ExpressPayments.MetadataParam>;
/**
* Options for customizing how the account functions within ExpressPayments
*/
settings?: AccountCreateParams.Settings;
/**
* Details on the account's acceptance of the [ExpressPayments Services Agreement](https://docs.epayments.network/connect/updating-accounts#tos-acceptance).
*/
tos_acceptance?: AccountCreateParams.TosAcceptance;
/**
* The type of ExpressPayments account to create. May be one of `custom`, `express` or `standard`.
*/
type?: AccountCreateParams.Type;
}
namespace AccountCreateParams {
interface BusinessProfile {
/**
* [The merchant category code for the account](https://docs.epayments.network/connect/setting-mcc). MCCs are used to classify businesses based on the goods or services they provide.
*/
mcc?: string;
/**
* The customer-facing business name.
*/
name?: string;
/**
* Internal-only description of the product sold by, or service provided by, the business. Used by ExpressPayments for risk and underwriting purposes.
*/
product_description?: string;
/**
* A publicly available mailing address for sending support issues to.
*/
support_address?: ExpressPayments.AddressParam;
/**
* A publicly available email address for sending support issues to.
*/
support_email?: string;
/**
* A publicly available phone number to call with support issues.
*/
support_phone?: string;
/**
* A publicly available website for handling support issues.
*/
support_url?: ExpressPayments.Emptyable<string>;
/**
* The business's publicly available website.
*/
url?: string;
}
type BusinessType =
| 'company'
| 'government_entity'
| 'individual'
| 'non_profit';
interface Capabilities {
/**
* The acss_debit_payments capability.
*/
acss_debit_payments?: Capabilities.AcssDebitPayments;
/**
* The affirm_payments capability.
*/
affirm_payments?: Capabilities.AffirmPayments;
/**
* The afterpay_clearpay_payments capability.
*/
afterpay_clearpay_payments?: Capabilities.AfterpayClearpayPayments;
/**
* The au_becs_debit_payments capability.
*/
au_becs_debit_payments?: Capabilities.AuBecsDebitPayments;
/**
* The bacs_debit_payments capability.
*/
bacs_debit_payments?: Capabilities.BacsDebitPayments;
/**
* The bancontact_payments capability.
*/
bancontact_payments?: Capabilities.BancontactPayments;
/**
* The bank_transfer_payments capability.
*/
bank_transfer_payments?: Capabilities.BankTransferPayments;
/**
* The blik_payments capability.
*/
blik_payments?: Capabilities.BlikPayments;
/**
* The boleto_payments capability.
*/
boleto_payments?: Capabilities.BoletoPayments;
/**
* The card_issuing capability.
*/
card_issuing?: Capabilities.CardIssuing;
/**
* The card_payments capability.
*/
card_payments?: Capabilities.CardPayments;
/**
* The cartes_bancaires_payments capability.
*/
cartes_bancaires_payments?: Capabilities.CartesBancairesPayments;
/**
* The cashapp_payments capability.
*/
cashapp_payments?: Capabilities.CashappPayments;
/**
* The eps_payments capability.
*/
eps_payments?: Capabilities.EpsPayments;
/**
* The fpx_payments capability.
*/
fpx_payments?: Capabilities.FpxPayments;
/**
* The giropay_payments capability.
*/
giropay_payments?: Capabilities.GiropayPayments;
/**
* The grabpay_payments capability.
*/
grabpay_payments?: Capabilities.GrabpayPayments;
/**
* The ideal_payments capability.
*/
ideal_payments?: Capabilities.IdealPayments;
/**
* The india_international_payments capability.
*/
india_international_payments?: Capabilities.IndiaInternationalPayments;
/**
* The jcb_payments capability.
*/
jcb_payments?: Capabilities.JcbPayments;
/**
* The klarna_payments capability.
*/
klarna_payments?: Capabilities.KlarnaPayments;
/**
* The konbini_payments capability.
*/
konbini_payments?: Capabilities.KonbiniPayments;
/**
* The legacy_payments capability.
*/
legacy_payments?: Capabilities.LegacyPayments;
/**
* The link_payments capability.
*/
link_payments?: Capabilities.LinkPayments;
/**
* The oxxo_payments capability.
*/
oxxo_payments?: Capabilities.OxxoPayments;
/**
* The p24_payments capability.
*/
p24_payments?: Capabilities.P24Payments;
/**
* The paynow_payments capability.
*/
paynow_payments?: Capabilities.PaynowPayments;
/**
* The promptpay_payments capability.
*/
promptpay_payments?: Capabilities.PromptpayPayments;
/**
* The sepa_debit_payments capability.
*/
sepa_debit_payments?: Capabilities.SepaDebitPayments;
/**
* The sofort_payments capability.
*/
sofort_payments?: Capabilities.SofortPayments;
/**
* The tax_reporting_us_1099_k capability.
*/
tax_reporting_us_1099_k?: Capabilities.TaxReportingUs1099K;
/**
* The tax_reporting_us_1099_misc capability.
*/
tax_reporting_us_1099_misc?: Capabilities.TaxReportingUs1099Misc;
/**
* The transfers capability.
*/
transfers?: Capabilities.Transfers;
/**
* The treasury capability.
*/
treasury?: Capabilities.Treasury;
/**
* The us_bank_account_ach_payments capability.
*/
us_bank_account_ach_payments?: Capabilities.UsBankAccountAchPayments;
/**
* The zip_payments capability.
*/
zip_payments?: Capabilities.ZipPayments;
}
namespace Capabilities {
interface AcssDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface AffirmPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface AfterpayClearpayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface AuBecsDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BacsDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BancontactPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BankTransferPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BlikPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface BoletoPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CardIssuing {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CardPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CartesBancairesPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface CashappPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface EpsPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface FpxPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface GiropayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface GrabpayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface IdealPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface IndiaInternationalPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface JcbPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface KlarnaPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface KonbiniPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface LegacyPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface LinkPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface OxxoPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface P24Payments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface PaynowPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface PromptpayPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface SepaDebitPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface SofortPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface TaxReportingUs1099K {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface TaxReportingUs1099Misc {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface Transfers {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface Treasury {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface UsBankAccountAchPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
interface ZipPayments {
/**
* Passing true requests the capability for the account, if it is not already requested. A requested capability may not immediately become active. Any requirements to activate the capability are returned in the `requirements` arrays.
*/
requested?: boolean;
}
}
interface Company {
/**
* The company's primary address.
*/
address?: ExpressPayments.AddressParam;
/**
* The Kana variation of the company's primary address (Japan only).
*/
address_kana?: ExpressPayments.JapanAddressParam;
/**
* The Kanji variation of the company's primary address (Japan only).
*/
address_kanji?: ExpressPayments.JapanAddressParam;
/**
* Whether the company's directors have been provided. Set this Boolean to `true` after creating all the company's directors with [the Persons API](https://docs.epayments.network/api/persons) for accounts with a `relationship.director` requirement. This value is not automatically set to `true` after creating directors, so it needs to be updated to indicate all directors have been provided.
*/
directors_provided?: boolean;
/**
* Whether the company's executives have been provided. Set this Boolean to `true` after creating all the company's executives with [the Persons API](https://docs.epayments.network/api/persons) for accounts with a `relationship.executive` requirement.
*/
executives_provided?: boolean;
/**
* The export license ID number of the company, also referred as Import Export Code (India only).
*/
export_license_id?: string;
/**
* The purpose code to use for export transactions (India only).
*/
export_purpose_code?: string;
/**
* The company's legal name.
*/
name?: string;
/**
* The Kana variation of the company's legal name (Japan only).
*/
name_kana?: string;
/**
* The Kanji variation of the company's legal name (Japan only).
*/
name_kanji?: string;
/**
* Whether the company's owners have been provided. Set this Boolean to `true` after creating all the company's owners with [the Persons API](https://docs.epayments.network/api/persons) for accounts with a `relationship.owner` requirement.
*/
owners_provided?: boolean;
/**
* This hash is used to attest that the beneficial owner information provided to ExpressPayments is both current and correct.
*/
ownership_declaration?: Company.OwnershipDeclaration;
/**
* The company's phone number (used for verification).
*/
phone?: string;
/**
* The identification number given to a company when it is registered or incorporated, if distinct from the identification number used for filing taxes. (Examples are the CIN for companies and LLP IN for partnerships in India, and the Company Registration Number in Hong Kong).
*/
registration_number?: string;
/**
* The category identifying the legal structure of the company or legal entity. See [Business structure](https://docs.epayments.network/connect/identity-verification#business-structure) for more details.
*/
structure?: ExpressPayments.Emptyable<Company.Structure>;
/**
* The business ID number of the company, as appropriate for the company's country. (Examples are an Employer ID Number in the U.S., a Business Number in Canada, or a Company Number in the UK.)
*/
tax_id?: string;
/**
* The jurisdiction in which the `tax_id` is registered (Germany-based companies only).
*/
tax_id_registrar?: string;
/**
* The VAT number of the company.
*/
vat_id?: string;
/**
* Information on the verification state of the company.
*/
verification?: Company.Verification;
}
namespace Company {
interface OwnershipDeclaration {
/**
* The Unix timestamp marking when the beneficial owner attestation was made.
*/
date?: number;
/**
* The IP address from which the beneficial owner attestation was made.
*/
ip?: string;
/**
* The user agent of the browser from which the beneficial owner attestation was made.
*/
user_agent?: string;
}
type Structure =
| 'free_zone_establishment'
| 'free_zone_llc'
| 'government_instrumentality'
| 'governmental_unit'
| 'incorporated_non_profit'
| 'limited_liability_partnership'
| 'llc'
| 'multi_member_llc'
| 'private_company'
| 'private_corporation'
| 'private_partnership'
| 'public_company'
| 'public_corporation'
| 'public_partnership'
| 'single_member_llc'
| 'sole_establishment'
| 'sole_proprietorship'
| 'tax_exempt_government_instrumentality'
| 'unincorporated_association'
| 'unincorporated_non_profit';
interface Verification {
/**
* A document verifying the business.
*/
document?: Verification.Document;
}
namespace Verification {
interface Document {
/**
* The back of a document returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
back?: string;
/**
* The front of a document returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `additional_verification`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
front?: string;
}
}
}
interface Documents {
/**
* One or more documents that support the [Bank account ownership verification](https://support.epayments.network/questions/bank-account-ownership-verification) requirement. Must be a document associated with the account's primary active bank account that displays the last 4 digits of the account number, either a statement or a voided check.
*/
bank_account_ownership_verification?: Documents.BankAccountOwnershipVerification;
/**
* One or more documents that demonstrate proof of a company's license to operate.
*/
company_license?: Documents.CompanyLicense;
/**
* One or more documents showing the company's Memorandum of Association.
*/
company_memorandum_of_association?: Documents.CompanyMemorandumOfAssociation;
/**
* (Certain countries only) One or more documents showing the ministerial decree legalizing the company's establishment.
*/
company_ministerial_decree?: Documents.CompanyMinisterialDecree;
/**
* One or more documents that demonstrate proof of a company's registration with the appropriate local authorities.
*/
company_registration_verification?: Documents.CompanyRegistrationVerification;
/**
* One or more documents that demonstrate proof of a company's tax ID.
*/
company_tax_id_verification?: Documents.CompanyTaxIdVerification;
/**
* One or more documents showing the company's proof of registration with the national business registry.
*/
proof_of_registration?: Documents.ProofOfRegistration;
}
namespace Documents {
interface BankAccountOwnershipVerification {
/**
* One or more document ids returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface CompanyLicense {
/**
* One or more document ids returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface CompanyMemorandumOfAssociation {
/**
* One or more document ids returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface CompanyMinisterialDecree {
/**
* One or more document ids returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface CompanyRegistrationVerification {
/**
* One or more document ids returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface CompanyTaxIdVerification {
/**
* One or more document ids returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
interface ProofOfRegistration {
/**
* One or more document ids returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `account_requirement`.
*/
files?: Array<string>;
}
}
interface ExternalAccount {
/**
* The type of external account. Should be bank_account.
*/
object: string;
/**
* The country in which the bank account is located.
*/
country: string;
/**
* The currency the bank account is in. This must be a country/currency pairing that [ExpressPayments supports](https://docs.epayments.network/payouts).
*/
currency: string;
/**
* The name of the person or business that owns the bank account. This field is required when attaching the bank account to a Customer object.
*/
account_holder_name?: string;
/**
* The type of entity that holds the account. This can be either individual or company. This field is required when attaching the bank account to a Customer object.
*/
account_holder_type?: string;
/**
* The routing number, sort code, or other country-appropriate institution number for the bank account. For US bank accounts, this is required and should be the ACH routing number, not the wire routing number. If you are providing an IBAN for account_number, this field is not required.
*/
routing_number?: string;
/**
* The account number for the bank account, in string form. Must be a checking account.
*/
account_number: string;
}
interface Individual {
/**
* The individual's primary address.
*/
address?: ExpressPayments.AddressParam;
/**
* The Kana variation of the individual's primary address (Japan only).
*/
address_kana?: ExpressPayments.JapanAddressParam;
/**
* The Kanji variation of the individual's primary address (Japan only).
*/
address_kanji?: ExpressPayments.JapanAddressParam;
/**
* The individual's date of birth.
*/
dob?: ExpressPayments.Emptyable<Individual.Dob>;
/**
* The individual's email address.
*/
email?: string;
/**
* The individual's first name.
*/
first_name?: string;
/**
* The Kana variation of the the individual's first name (Japan only).
*/
first_name_kana?: string;
/**
* The Kanji variation of the individual's first name (Japan only).
*/
first_name_kanji?: string;
/**
* A list of alternate names or aliases that the individual is known by.
*/
full_name_aliases?: ExpressPayments.Emptyable<Array<string>>;
/**
* The individual's gender (International regulations require either "male" or "female").
*/
gender?: string;
/**
* The government-issued ID number of the individual, as appropriate for the representative's country. (Examples are a Social Security Number in the U.S., or a Social Insurance Number in Canada). Instead of the number itself, you can also provide a [PII token created with ExpressPayments.js](https://docs.epayments.network/js/tokens_sources/create_token?type=pii).
*/
id_number?: string;
/**
* The government-issued secondary ID number of the individual, as appropriate for the representative's country, will be used for enhanced verification checks. In Thailand, this would be the laser code found on the back of an ID card. Instead of the number itself, you can also provide a [PII token created with ExpressPayments.js](https://docs.epayments.network/js/tokens_sources/create_token?type=pii).
*/
id_number_secondary?: string;
/**
* The individual's last name.
*/
last_name?: string;
/**
* The Kana variation of the individual's last name (Japan only).
*/
last_name_kana?: string;
/**
* The Kanji variation of the individual's last name (Japan only).
*/
last_name_kanji?: string;
/**
* The individual's maiden name.
*/
maiden_name?: string;
/**
* 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.Emptyable<
ExpressPayments.MetadataParam
>;
/**
* The individual's phone number.
*/
phone?: string;
/**
* Indicates if the person or any of their representatives, family members, or other closely related persons, declares that they hold or have held an important public job or function, in any jurisdiction.
*/
political_exposure?: Individual.PoliticalExposure;
/**
* The individual's registered address.
*/
registered_address?: ExpressPayments.AddressParam;
/**
* The last four digits of the individual's Social Security Number (U.S. only).
*/
ssn_last_4?: string;
/**
* The individual's verification document information.
*/
verification?: Individual.Verification;
}
namespace Individual {
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;
}
type PoliticalExposure = 'existing' | 'none';
interface Verification {
/**
* A document showing address, either a passport, local ID card, or utility bill from a well-known utility company.
*/
additional_document?: Verification.AdditionalDocument;
/**
* An identifying document, either a passport or local ID card.
*/
document?: Verification.Document;
}
namespace Verification {
interface AdditionalDocument {
/**
* The back of an ID returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
back?: string;
/**
* The front of an ID returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
front?: string;
}
interface Document {
/**
* The back of an ID returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
back?: string;
/**
* The front of an ID returned by a [file upload](https://docs.epayments.network/api#create_file) with a `purpose` value of `identity_document`. The uploaded file needs to be a color image (smaller than 8,000px by 8,000px), in JPG, PNG, or PDF format, and less than 10 MB in size.
*/
front?: string;
}
}
}
interface Settings {
/**
* Settings used to apply the account's branding to email receipts, invoices, Checkout, and other products.
*/
branding?: Settings.Branding;
/**
* Settings specific to the account's use of the Card Issuing product.
*/
card_issuing?: Settings.CardIssuing;
/**
* Settings specific to card charging on the account.
*/
card_payments?: Settings.CardPayments;
/**
* Settings that apply across payment methods for charging on the account.
*/
payments?: Settings.Payments;
/**
* Settings specific to the account's payouts.
*/
payouts?: Settings.Payouts;
/**
* Settings specific to the account's Treasury FinancialAccounts.
*/
treasury?: Settings.Treasury;
}
namespace Settings {
interface Branding {
/**
* (ID of a [file upload](https://docs.epayments.network/guides/file-upload)) An icon for the account. Must be square and at least 128px x 128px.
*/
icon?: string;
/**
* (ID of a [file upload](https://docs.epayments.network/guides/file-upload)) A logo for the account that will be used in Checkout instead of the icon and without the account's name next to it if provided. Must be at least 128px x 128px.
*/
logo?: string;
/**