allOf:
- $ref: '#/components/schemas/RetryPostResponse'
_links:
type: object
description: The links related to the payment
minItems: 2
required:
- self
- actions
properties:
self:
type: object
allOf:
- $ref: '#/components/schemas/Link'
description: The URI of the payment
actions:
type: object
allOf:
- $ref: '#/components/schemas/Link'
description: A link to the payment's associated actions
authorize:
type: object
allOf:
- $ref: '#/components/schemas/Link'
description: A link to increment the authorization, where applicable
void:
type: object
allOf:
- $ref: '#/components/schemas/Link'
description: A link to void the payment, where applicable
capture:
type: object
allOf:
- $ref: '#/components/schemas/Link'
description: A link to capture the payment, where applicable
refund:
type: object
allOf:
- $ref: '#/components/schemas/Link'
description: A link to refund the payment, where applicable
cancel:
type: object
allOf:
- $ref: '#/components/schemas/Link'
description: A link to cancel the upcoming scheduled retry, where applicable.
example:
self:
href: 'https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44'
actions:
href: 'https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/actions'
authorize:
href: 'https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/authorizations'
void:
href: 'https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/voids'
capture:
href: 'https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/capture'
cancel:
href: 'https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44/cancel'
PaymentResponseBalances:
type: object
description: The balances of the payment
properties:
total_authorized:
type: integer
description: The total amount that has been authorized
example: 6540
total_voided:
type: integer
description: The total amount that has been voided
example: 0
available_to_void:
type: integer
description: The total amount that is still available for voiding
example: 6540
total_captured:
type: integer
description: The total amount that has been captured
example: 0
available_to_capture:
type: integer
description: The total amount that is still available for capture
example: 6540
total_refunded:
type: integer
description: The total amount that has been refunded
example: 0
available_to_refund:
type: integer
description: The total amount that is still available for refund
example: 0
PaymentResponseDestination:
type: object
description: Payment destination
discriminator:
propertyName: type
mapping:
bank_account: '#/components/schemas/PaymentResponseBankAccountDestination'
oneOf:
- $ref: '#/components/schemas/PaymentResponseBankAccountDestination'
required:
- type
properties:
type:
type: string
description: |
The payment destination type.
example: 'card'
PaymentResponseSource:
type: object
description: Payment source in /payments successfully created response
required:
- type
properties:
type:
type: string
description: |
The payment source type. For any payment request sources that result in a card token (token, source ID, etc.),
this will be `card`
For payment types not specified in this list, the response will not contain a source object.
discriminator:
propertyName: type
mapping:
card: '#/components/schemas/PaymentResponseCardSource'
ach: '#/components/schemas/PaymentDeclinedSourceResponse'
alipay_cn: '#/components/schemas/PaymentDeclinedSourceResponse'
bank_account: '#/components/schemas/PaymentDeclinedSourceResponse'
sepa: '#/components/schemas/PaymentDeclinedSourceResponse'
oneOf:
- $ref: '#/components/schemas/PaymentResponseCardSource'
- $ref: '#/components/schemas/PaymentDeclinedSourceResponse'
PaymentReversalAcceptedResponse:
type: object
description: Reversal response
required:
- action_id
properties:
action_id:
description: The unique identifier for the payment reversal action.
allOf:
- $ref: '#/components/schemas/ActionId'
reference:
type: string
description: A unique reference for the payment reversal.
example: 'ORD-5023-4E89'
action_type:
type: string
description: |
The payment action performed during the reversal.
Determined by the payment's state at the time of processing:
- `Refund` if the payment has been fully or partially captured
- `Void` if the payment is in an `Authorized` state.
example: 'Refund'
_links:
type: object
description: Links related to the payment reversal.
readOnly: true
required:
- payment
properties:
payment:
description: |
The URI of the payment to be reversed.
You can use this value to check the status of the payment reversal.
allOf:
- $ref: '#/components/schemas/Link'
- example:
href: 'https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44'
PaymentReversalRequest:
type: object
properties:
reference:
type: string
description: |
An internal reference to identify the payment reversal.
For American Express payment reversals, there is a 30-character limit.
maxLength: 80
example: 'ORD-5023-4E89'
metadata:
type: object
additionalProperties: true
description: |
Stores additional information about the transaction with custom fields.
You can only supply primitive data types with one level of depth. Fields of type `object` or `array` are not supported.
example:
coupon_code: 'NY2018'
partner_id: 123989
PayoutBillingDescriptor:
type: object
required: [reference]
description: |
Beneficiary banks typically construct the billing descriptor using the billing descriptor reference and sender information. For direct sellers, the sender is typically your entity’s legal company name. If the ultimate sender is provided, then it is the values of the Sender object.
properties:
reference:
type: string
minLength: 11
maxLength: 15
description: |
The reference shown on the beneficiary's bank statement.
Format – The length varies per beneficiary bank. In general, we recommend fewer than 11 characters.
Note – References are not supported in the US.
PayoutDetails:
type: object
description: Payment response
properties:
id:
description: Payment unique identifier
allOf:
- $ref: '#/components/schemas/PaymentId'
requested_on:
description: The date/time the payment was requested
allOf:
- $ref: '#/components/schemas/ServerTimestamp'
source:
description: The source of the payout
type: object
properties:
id:
type: string
description: The payment source identifier, which can be used for subsequent payments
example: ca_y3oqhf46pyzuxjbcn2giaqnb44
type:
type: string
description: The payment source type. This is always `currency_account` for payouts.
example: currency_account
currency:
type: string
description: The three-letter ISO currency code of the payout source
example: GBP
maxLength: 3
minLength: 3
amount:
type: integer
description: The amount paid out, in minor units, from the source currency account.
example: 1000
destination:
description: The destination of the payout
type: object
properties:
type:
type: string
description: The payout destination type
example: bank_account
id:
type: string
description: The payment instrument identifier
example: src_4pakgjwmv5re5m5ivqohsqpxnm
amount:
type: integer
description: The original payout amount
example: 1000
currency:
type: string
description: The three-letter ISO currency code of the payment
example: GBP
maxLength: 3
minLength: 3
reference:
type: string
description: Your reference for the payout
example: PO-215-5721
billing_descriptor:
type: object
description: Details about the billing descriptor
properties:
reference:
type: string
description: The reference that is displayed on the account holder's statement
example: Withdrawal
status:
type: string
description: The status of the payout
enum:
- Pending
- Paid
- Declined
- Returned
example: Pending
approved:
type: boolean
description: Whether the authorization was successful
example: true
sender:
description: Information about the sender of the payment's funds
type: object
allOf:
- $ref: '#/components/schemas/PaymentDetailsResponseSender'
instruction:
description: Details about the instruction for payouts to bank accounts
The fields will depend on which ones were included in the request.
type: object
properties:
value_date:
type: string
description: The date (in ISO 8601 format) on which the recipient's account will be credited
purpose:
type: string
description: An optional description of the payout purpose, like `Insurance_claim` or `Remittance`
charge_bearer:
type: string
description: Who should be charged the payout fee
enum:
- OUR
- SHA
repair:
type: boolean
description: Determines whether the payout details can be modified to attempt to prevent a payout from being returned
scheme:
type: string
description: The preferred payment scheme or network the bank transfer will be sent through
enum:
- swift
- local
- instant
quote_id:
type: string
description: The FX quote identifier
example:
value_date: '2020-06-13T01:49:19.1864428Z'
purpose: Wallet Withdrawal
quote_id: qte_xrhaw53z5m6ehbbxz2n6n5lk74
_links:
type: object
description: Links related to the payouts
properties:
self:
type: object
description: The direct link to the payout
properties:
href:
type: string
description: The link URL
example: https://{prefix}.api.sandbox.checkout.com/payments/pay_gwlowf7eap7uzm4cyaaqoq62au
actions:
type: object
description: The link to the list of actions related to the payout
properties:
href:
type: string
description: The link URL
example: https://{prefix}.api.sandbox.checkout.com/payments/pay_gwlowf7eap7uzm4cyaaqoq62au/actions
PayoutSender:
type: object
description: |
The ultimate sender of the payout – that is, your customer.
Not supported for Platform or Direct Seller Checkout.com clients.
discriminator:
propertyName: type
mapping:
instrument: '#/components/schemas/03_PayoutRequestInstrumentSender'
individual: '#/components/schemas/01_PayoutRequestIndividualSender'
corporate: '#/components/schemas/02_PayoutRequestCorporateSender'
required:
- reference
properties:
type:
type: string
enum:
- instrument
- individual
- corporate
description: The sender type. Given it is set to `instrument`, then the sender parameters are retrieved from the destination.
reference:
type: string
description: A unique reference to the underlying client's customer. A global KYC requirement.
PlanInstallment:
type: object
title: Installment
description: The information to process a installment payment request. To be used when the `payment_type` is `installment`.
allOf:
- properties:
financing:
type: boolean
default: false
description: If the installment plan has financing.
example: false
- $ref: '#/components/schemas/PaymentPlan'
PlanRecurring:
type: object
title: Recurring
description: The information to process a recurring payment request. To be used when the `payment_type` is `recurring`.
allOf:
- properties:
amount_variability:
type: string
description: Specifies whether the amount is fixed or variable for each recurrence.
enum:
- Fixed
- Variable
example: Variable
- $ref: '#/components/schemas/PaymentPlan'
ProcessingData:
type: object
description: Returns information related to the processing of the payment
properties:
preferred_scheme:
type: string
enum:
- "mastercard"
- "visa"
- "cartes_bancaires"
description: The preferred scheme for co-badged card payment processing. If performing 3DS via a third party, set this value to the scheme that processed 3DS. This field does not support PINless debit schemes in the US (STAR, PULSE, NYCE, ACCEL, SHAZAM).
example: 'cartes_bancaires'
app_id:
type: string
description: The customer's application identifier.
example: 'com.iap.linker_portal'
airline_data:
$ref: '#/components/schemas/AirlineData'
accommodation_data:
$ref: '#/components/schemas/AccommodationData'
partner_customer_id:
type: string
description: The customer's ID on the partner platform.
example: '2102209000001106125F8'
partner_payment_id:
type: string
description: 'The partner-originated unique payment identifier'
example: '440644309099499894406'
partner_code:
type: string
pattern: '^\d{6}$'
minLength: 6
maxLength: 6
description: |
The 6-digit partner code returned by the payment provider. Returned when `source.type` is `blik`.
example: '999111'
failure_code:
type: string
description: |
A high-level failure category returned by the payment provider when a payment is declined or fails. Not all payment methods return this field.
example: 'partner_error'
partner_response_code:
type: string
description: |
The raw response code returned by the payment provider when a payment is declined or fails. Not all payment methods return this field.
example: 'ER_WRONG_TICKET'
tax_amount:
type: number
description: Total tax amount of the order.
example: 1000
locale:
type: string
pattern: '^[a-z]{2}(?:-[A-Z][a-z]{3})?(?:-(?:[A-Z]{2}))?$'
description: The language and region of the customer. ISO 639-2 language code, its value consists of language-country
example: en-US
maxLength: 10
minLength: 2
retrieval_reference_number:
type: string
description: 'A unique identifier for the authorization provided by partner'
example: '909913440644'
partner_order_id:
type: string
description: The Klarna order ID associated with the payment.
partner_status:
type: string
description: "Status of a payment provided by partner"
partner_transaction_id:
type: string
description: "Unique transaction identification provided by partner"
partner_error_codes:
type: array
description: The list of error codes that led the payment to fail or be declined, as given by the payment provider
items:
type: string
partner_merchant_advice_code:
type: string
description: |
The Merchant Advice Code (MAC) provided by Mastercard, which contains additional information about the transaction.
For example, the MAC can inform you if the transaction was performed using a consumer non-reloadable prepaid card or a consumer single-use virtual card.
For declined transactions, the MAC will also let you know whether the payment can be retried, and how long you should wait before doing so.
example: '24'
partner_error_message:
type: string
description: "Error description provided by partner"
partner_authorization_code:
type: string
description: "Authorization code provided by partner"
partner_authorization_response_code:
type: string
description: "Authorization response code provided by partner"
partner_fraud_status:
type: string
description: Partner fraud status. If the status is Pending, and the Merchant captures before it changes to Accepted the risk of the transaction is solely of the merchant.
pan_type_processed:
type: string
description: The type of Primary Account Number (PAN) used for the payment. DPAN indicates network token was used, FPAN indicates the full card was used
enum:
- "fpan"
- "dpan"
fallback_source_used:
type: boolean
description: Indicates whether the `fallback_source` field was used for the payment.
example: false
custom_payment_method_ids:
type: array
description: An array defining which of the configured payment options within a payment category (for example, `pay_later` or `pay_over_time`) should be displayed for this purchase.
items:
type: string
aft:
type: boolean
description: Indicates whether the payment is an [Account Funding Transaction](https://www.checkout.com/docs/payments/manage-payments/account-funding-transactions)
merchant_category_code:
type: string
description: Four-digit code for retail financial services expressed in ISO 18245 format, classifying the types of goods or services you provide.
example: '5311'
scheme_merchant_id:
type: string
description: The merchant identifier that was configured with the scheme and used for the payment.
example: "123456"
scheme:
type: string
description: The scheme on which the payment was authorized. This may differ from the card's scheme used for the payment if the card is co-badged and the payment was authorized on a different network.
example: "ACCEL"
readOnly: true
scheme_transaction_link_id:
type: string
description: 'The scheme transaction link identifier.'
RefundAcceptedResponse:
type: object
description: Refund response
required:
- action_id
properties:
action_id:
description: The unique identifier for the refund action
allOf:
- $ref: '#/components/schemas/ActionId'
reference:
type: string
description: Your reference for the refund request
example: ORD-5023-4E89
_links:
type: object
description: The links related to the refund
readOnly: true
minItems: 2
properties:
payment:
type: object
allOf:
- $ref: '#/components/schemas/Link'
description: The URI of the payment to be refunded. Use this to check the status of the payment
example:
href: 'https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44'
required:
- payment
RefundBankAccountDestination:
type: object
description: |
The destination of the refund.
This field is required for giropay and EPS refunds.
required:
- country
- account_number
- bank_code
- account_holder
allOf:
- type: object
properties:
account_type:
description: The type of account to which the refund will be sent.
type: string
enum:
- savings
- current
- cash
example: savings
account_number:
description: The account number.
type: string
example: '13654567455'
bank_code:
description: The code that identifies the bank.
type: string
example: 123-456
branch_code:
description: The code that identifies the bank branch.
type: string
example: '6443'
iban:
description: The account's International Bank Account Number (IBAN).
type: string
example: HU93116000060000000012345676
bban:
description: |
The account's Basic Bank Account Number (BBAN).
The BBAN is a combination of the account number and the bank or branch code, or both.
type: string
example: 3704 0044 0532 0130 00
swift_bic:
description: An 8 or 11-digit code that identifies the bank or bank branch.
type: string
example: '37040044'
country:
description: The two-letter ISO country code of the country where the account is based.
type: string
example: GB
account_holder:
$ref: '#/components/schemas/RefundDestinationAccountHolder'
bank:
$ref: '#/components/schemas/BankDetails'
RefundDestinationAccountHolder:
type: object
description: The account holder details.
required:
- first_name
- last_name
properties:
type:
description: The account holder type.
type: string
enum:
- individual
- corporate
- government
example: individual
first_name:
description: The account holder's first name.
type: string
example: 'John'
last_name:
description: The account holder's last name.
type: string
example: 'Smith'
company_name:
description: The corporate account holder's company name.
type: string
example: Test company
tax_id:
description: The account holder's tax number or reference.
type: string
example: '123456'
date_of_birth:
description: The account holder's date of birth, in the format `YYYY-MM-DD`.
type: string
format: date
example: '1986-01-01'
country_of_birth:
description: The two-letter ISO country code of the account holder's country of birth.
type: string
example: GB
residential_status:
description: The account holder's residential status.
type: string
enum:
- resident
- non_resident
example: resident
billing_address:
description: The account holder's billing address.
allOf:
- $ref: '#/components/schemas/Address'
phone:
description: The account holder's phone number.
allOf:
- $ref: '#/components/schemas/PhoneNumber'
identification:
$ref: '#/components/schemas/AccountHolderIdentification'
email:
description: The account holder's email address.
type: string
format: email
example: test.user@checkout.com
RefundRequest:
type: object
properties:
amount:
type: integer
description: |
The amount to refund. If not specified, the full payment amount will be refunded.
minimum: 0
example: 6540
reference:
type: string
description: A reference you can later use to identify this refund request.
For Amex, the string limit is 30 characters.
For TWINT, the string limit is 50 characters.
maxLength: 80
example: 'ORD-5023-4E89'
amount_allocations:
$ref: '#/components/schemas/AmountAllocations'
capture_action_id:
type: string
description: The Checkout.com action ID of the capture you want to refund. Only for PayPal and Riverty.
example: 'act_fd3h6evhpn3uxdoqbuu3lqnqbm'
items:
$ref: '#/components/schemas/Items'
destination:
$ref: '#/components/schemas/RefundBankAccountDestination'
metadata:
type: object
description: |
A set of key-value pairs to attach to the authorization request. You can use this to store additional information in a structured format.
The `metadata` object only supports primitive data types. Objects and arrays are not supported.
example:
coupon_code: 'NY2018'
partner_id: 123989
01_PayoutRequestIndividualAccountHolder:
type: object
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/AccountHolder'
required:
- type
- first_name
- last_name
- billing_address
properties:
first_name:
description: |
The legal first name of the account holder.
type: string
example: 'John'
last_name:
description: |
The legal last name of the account holder.
type: string
example: 'Smith'
tax_id:
description: The legal account holder's tax number or reference.
type: string
example: '123456'
date_of_birth:
description: The account holder's date of birth in a `YYYY-MM-DD` format. Strongly recommended where available.
type: string
format: date
example: '1986-01-01'
country_of_birth:
description: The two-letter ISO country code of the account holder's country of birth.
type: string
example: GB
residential_status:
description: The account holder's residential status.
type: string
enum:
- resident
- non_resident
example: resident
billing_address:
description: The current billing address associated with the destination account. Required for payouts to individuals. Strongly recommended when available.
allOf:
- $ref: '#/components/schemas/Address'
phone:
description: The phone number of the account holder.
allOf:
- $ref: '#/components/schemas/PhoneNumber'
identification:
type: object
description: The account holder's government document identification. For example, the social security number (SSN).
properties:
type:
type: string
description: The document type
example: SSN
issuing_country:
type: string
description: The country where the document was issued
number:
type: string
description: The document number
02_PayoutRequestCorporateAccountHolder:
type: object
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/AccountHolder'
required:
- type
- company_name
properties:
company_name:
description: |
The full legal name of a registered company that holds the account.
type: string
example: Test company
tax_id:
description: The legal account holder's tax number or reference.
type: string
example: '123456'
billing_address:
description: The current billing address associated with the destination account. Strongly recommended when available.
allOf:
- $ref: '#/components/schemas/Address'
03_PayoutRequestGovernmentAccountHolder:
type: object
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/AccountHolder'
required:
- type
- company_name
properties:
company_name:
description: |
The full legal name of a registered company that holds the account.
type: string
example: Test company
tax_id:
description: The legal account holder's tax number or reference.
type: string
example: '123456'
billing_address:
description: The current billing address associated with the destination account. Strongly recommended when available.
allOf:
- $ref: '#/components/schemas/Address'
PaymentBankAccountDestination:
type: object
description: An existing payment instrument.
required:
- country
- account_type
- type
properties:
type:
type: string
description: The payout destination type.
example: 'bank_account'
country:
description: The two-letter ISO country code of where the account is based. Note that not all countries are available, see our docs for details.
type: string
minLength: 2
maxLength: 2
example: GB
iban:
description: Internationally agreed standard for identifying bank accounts. Lengths vary per `destination_country`. See the glossary for details.
type: string
example: HU93116000060000000012345676
account_number:
description: Number (which can contain letters) that identifies the local account.
type: string
example: '13654567455'
bank_code:
description: Code that identifies the bank. Also referred as Routing Number in the United States.
type: string
example: 123-456
branch_code:
description: Code that identifies the bank branch.
type: string
example: '6443'
bban:
description: The combination of bank code and/or branch code and account number.
type: string
example: 3704 0044 0532 0130 00
swift_bic:
description: 8 or 11 character code which identifies the bank or bank branch.
type: string
example: '37040044'
account_type:
description: The type of the bank account. Note: that some beneficiary banks do not accept payouts to savings accounts.
type: string
enum:
- savings
- current
- cash
example: savings
account_holder:
$ref: '#/components/schemas/AccountHolder'
PaymentRequestIdDestination:
type: object
description: An existing payment instrument.
required:
- id
- type
properties:
type:
type: string
description: The payout destination type.
example: 'id'
id:
type: string
pattern: "^(src)_(\\w{26})$"
description: The existing payment instrument's identifier. It is advisable that payment instruments are reused, see the documentation for more information.
example: src_wmlfc3zyhqzehihu7giusaaawu
01_PaymentRequestIndividualSender:
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/PaymentRequestSender'
- type: object
required:
- first_name
- last_name
- address
properties:
first_name:
type: string
description: The sender's first name
example: 'John'
last_name:
type: string
description: The sender's last name
example: 'Jones'
date_of_birth:
type: string
format: date
description: The sender's date of birth (yyyy-mm-dd)
maxLength: 10
example: '1985-05-15'
address:
description: The sender's address
allOf:
- $ref: '#/components/schemas/Address'
identification:
type: object
properties:
type:
type: string
description: The type of identification used to identify the sender
enum:
- passport
- driving_licence
- national_id
example: driving_licence
number:
type: string
description: The identification number
example: '1234'
issuing_country:
type: string
description: The two-letter ISO country code of the country that issued the identification
example: GT
01_PayoutRequestIndividualSender:
type: object
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/PayoutSender'
required:
- type
- first_name
- last_name
- address
properties:
first_name:
type: string
description: The legal first name of the ultimate sender.
example: 'John'
last_name:
type: string
description: The legal last name of the ultimate sender.
example: 'Jones'
dob:
type: string
format: date
description: The sender's date of birth in a `YYYY-MM-DD` format. Strongly recommended where available.
maxLength: 10
example: '1985-05-15'
address:
description: The sender's address.
allOf:
- $ref: '#/components/schemas/Address'
identification:
type: object
properties:
type:
type: string
description: The type of identification used to identify the sender.
enum:
- passport
- driving_licence
- national_id
example: driving_licence
number:
type: string
description: The identification number.
example: '1234'
issuing_country:
type: string
description: The two-letter ISO country code that issued the identification.
example: GT
02_PaymentRequestCorporateSender:
type: object
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/PaymentRequestSender'
- type: object
required:
- company_name
- address
properties:
company_name:
type: string
description: The sender's company name
address:
description: The sender's address
allOf:
- $ref: '#/components/schemas/Address'
02_PayoutRequestCorporateSender:
type: object
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/PayoutSender'
required:
- type
- company_name
- address
properties:
company_name:
type: string
description: The sender's company name
address:
description: The sender's address
allOf:
- $ref: '#/components/schemas/Address'
03_PaymentRequestInstrumentSender:
type: object
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/PaymentRequestSender'
03_PayoutRequestInstrumentSender:
type: object
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/PayoutSender'
required:
- type
PaymentRequestAchSource:
type: object
description: An ach payment source
required:
- type
- account_type
- account_holder
- account_number
- bank_code
- country
properties:
account_type:
type: string
description: The type of Direct Debit account
example: savings
enum:
- savings
- checking
- cash
country:
type: string
description: The source country
minLength: 2
maxLength: 2
example: US
account_number:
type: string
description: The account number of the Direct Debit account
minLength: 4
maxLength: 17
example: '136549956'
bank_code:
type: string
description: The bank code of the Direct Debit account
minLength: 8
maxLength: 9
example: '021000021'
account_holder:
$ref: '#/components/schemas/AccountHolderAch'
type:
type: string
description: The payment source type.
example: ach
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- ach
PaymentRequestAlipayCnSource:
type: object
description: 'Alipay CN Source'
properties:
type:
type: string
description: The payment source type.
example: alipay_cn
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- alipay_cn
required:
- type
PaymentRequestAlipayHkSource:
type: object
description: 'Alipay HK Source'
properties:
type:
type: string
description: The payment source type.
example: alipay_hk
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- alipay_hk
required:
- type
PaymentRequestAlipayPlusSource:
type: object
description: 'Alipay Plus Source'
properties:
type:
type: string
description: The payment source type.
example: alipay_plus
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- alipay_plus
required:
- type
PaymentRequestAlmaSource:
type: object
description: Alma payment source
required:
- type
properties:
type:
type: string
description: The payment source type.
example: alma
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- alma
billing_address:
description: The billing address of the cardholder
allOf:
- $ref: '#/components/schemas/Address'
- type: object
required:
- address_line1
- city
- country
PaymentRequestBancontactSource:
###
# Warning: this file was auto generated from OpenAPI specs using 'npm run sync-generated-specs'. Do not manually edit.
###
type: object
description: 'Bancontact Source'
required:
- type
- payment_country
- account_holder_name
properties:
payment_country:
maxLength: 2
minLength: 2
enum:
- BE
type: string
description: 'The 2-letter ISO country code of the country in which the payment
instrument is issued/operated.'
account_holder_name:
maxLength: 100
minLength: 3
type: string
description: 'The account holder.'
billing_descriptor:
maxLength: 65534
type: string
description: 'Payment billing descriptor.'
language:
maxLength: 2
minLength: 2
enum:
- fr
- nl
- de
- en
type: string
description: 'The 2-letter ISO language code that should be preferred when presenting
payment pages to the consumer.'
default: fr
example: nl
type:
type: string
description: The payment source type.
example: bancontact
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- bancontact
PaymentRequestBizumSource:
type: object
description: 'Bizum Source'
properties:
type:
type: string
description: The payment source type.
example: bizum
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- bizum
required:
- type
PaymentRequestBlikSource:
type: object
description: |
Blik source. Use this to process Blik payments in Poland.
When `source.type` is `blik`:
- `currency` must be `PLN`.
- `amount` must not exceed `5000000` (in the [minor currency unit](https://www.checkout.com/docs/resources/calculating-the-amount)).
- `reference` is limited to 35 characters.
For customer-initiated payments (`merchant_initiated: false`), provide the customer's 6-digit Blik code in `processing.partner_code`. This applies to one-off (`payment_type: Regular`) payments and to the initial payment of a recurring agreement (`payment_type: Recurring`).
For merchant-initiated recurring payments (`merchant_initiated: true`), use either:
- `source.type: id` with a `source.id` value returned from a previous Blik recurring payment, or
- `source.type: blik` with `partner_agreement_id` set to an external Blik PAYID created with another PSP.
required:
- type
properties:
type:
type: string
description: The payment source type.
example: blik
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- blik
partner_agreement_id:
type: string
description: |
The Blik PAYID identifying an external partner agreement created with another PSP.
Only used when processing merchant-initiated recurring payments (`merchant_initiated: true`) without a stored Checkout.com source.
maxLength: 64
example: blik_payid_123456789
PaymentRequestCardSource:
type: object
description: A card payment source
required:
- type
- number
- expiry_month
- expiry_year
properties:
number:
type: string
description: The card number (without separators)
example: '4543474002249996'
expiry_month:
type: integer
description: The expiry month of the card
minimum: 1
maximum: 12
example: 6
expiry_year:
type: integer
description: 4-digit expiry year of the card
example: 2030
name:
type: string
description: The name of the cardholder
example: 'Bruce Wayne'
cvv:
type: string
description: The card verification value/code. 3 digits, except for American
Express (4 digits)
example: '956'
minLength: 3
maxLength: 4
stored:
type: boolean
description: >-
Indicates whether this card is being submitted from your own stored card-on-file system, rather than being entered by the customer at the time of payment. Set to `true` when you provide card details that you already have on file for the customer.
default: false
example: true
store_for_future_use:
type: boolean
description: This must be set to true if you intend to reuse the payment
credentials in subsequent payments. Setting the field as false will mean
that a payment instrument will not be included in the payment
response.
default: true
example: false
billing_address:
description: The billing address of the cardholder
allOf:
- $ref: '#/components/schemas/Address'
phone:
description: The phone number of the cardholder
allOf:
- $ref: '#/components/schemas/PhoneNumber'
account_holder:
type: object
description: Information about the account holder of the card
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/01_RequestSources_AccountHolderIndividual'
corporate: '#/components/schemas/02_RequestSources_AccountHolderCorporate'
government: '#/components/schemas/03_RequestSources_AccountHolderGovernment'
required:
- type
properties:
type:
type: string
example: 'individual'
allow_update:
type: boolean
description: Specifies whether to use the Real-Time
Account Updater to update the card information.
default: true
example: false
type:
type: string
description: The payment source type.
example: card
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- card
PaymentRequestCustomerSource:
type: object
description: A customer source
required:
- type
- id
properties:
id:
type: string
pattern: "^(cus)_(\\w{26})$"
description: The customer's identifier.
example: 'cus_y3oqhf46pyzuxjbcn2giaqnb44'
billing_address:
description: The cardholder's billing address.
allOf:
- $ref: '#/components/schemas/Address'
phone:
description: The cardholder's phone number.
allOf:
- $ref: '#/components/schemas/PhoneNumber'
account_holder:
type: object
description: Information about the account holder of the customer's default
payment instrument
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/01_RequestSources_AccountHolderIndividual'
corporate: '#/components/schemas/02_RequestSources_AccountHolderCorporate'
government: '#/components/schemas/03_RequestSources_AccountHolderGovernment'
properties:
type:
type: string
example: 'individual'
allow_update:
type: boolean
description: Specifies whether to use the Real-Time
Account Updater to update the card information.
default: true
example: false
type:
type: string
description: The payment source type.
example: customer
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- customer
PaymentRequestDanaSource:
type: object
description: 'Dana Source'
properties:
type:
description: The payment source type.
example: dana
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- dana
required:
- type
PaymentRequestEpsSource:
###
# Warning: this file was auto generated from OpenAPI specs using 'npm run sync-generated-specs'. Do not manually edit.
###
type: object
description: 'EPS Source'
required:
- type
- purpose
properties:
type:
type: string
description: The payment source type.
example: eps
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- eps
purpose:
maxLength: 27
type: string
description: "Purpose of the payment as appearing on customer's bank statement."
account_holder:
$ref: '#/components/schemas/AccountHolderEps'
PaymentRequestFallbackSource:
type: object
description: A card payment source
required:
- type
- number
- expiry_month
- expiry_year
properties:
number:
type: string
description: The card number (without separators)
example: '4543474002249996'
expiry_month:
type: integer
description: The expiry month of the card
minimum: 1
maximum: 12
example: 6
expiry_year:
type: integer
description: 4-digit expiry year of the card
example: 2030
name:
type: string
description: The name of the cardholder
example: 'Bruce Wayne'
cvv:
type: string
description: The card verification value/code. 3 digits, except for American
Express (4 digits)
example: '956'
minLength: 3
maxLength: 4
stored:
type: boolean
description: >-
Indicates whether this card is being submitted from your own stored card-on-file system, rather than being entered by the customer at the time of payment. Set to `true` when you provide card details that you already have on file for the customer.
default: false
example: true
store_for_future_use:
type: boolean
description: This must be set to true if you intend to reuse the payment
credentials in subsequent payments. Setting the field as false will mean
that a payment instrument will not be included in the payment
response.
default: true
example: false
billing_address:
description: The billing address of the cardholder
allOf:
- $ref: '#/components/schemas/Address'
phone:
description: The phone number of the cardholder
allOf:
- $ref: '#/components/schemas/PhoneNumber'
account_holder:
type: object
description: Information about the account holder of the card
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/01_RequestSources_AccountHolderIndividual'
corporate: '#/components/schemas/02_RequestSources_AccountHolderCorporate'
government: '#/components/schemas/03_RequestSources_AccountHolderGovernment'
required:
- type
properties:
type:
type: string
example: 'individual'
allow_update:
type: boolean
description: Specifies whether to use the Real-Time
Account Updater to update the card information.
default: true
example: false
type:
type: string
description: The payment source type.
example: card
allOf:
- type: string
enum:
- card
PaymentRequestFawrySource:
###
# Warning: this file was auto generated from OpenAPI specs using 'npm run sync-generated-specs'. Do not manually edit.
###
type: object
description: 'Fawry Source'
required:
- type
- description
- products
- customer_email
- customer_mobile
properties:
description:
maxLength: 265
type: string
description: 'The payment description.'
customer_profile_id:
type: string
description: "The customer's id within merchant's system."
customer_email:
type: string
description: "The customer's email address."
customer_mobile:
type: string
description: "The customer's mobile phone number."
expires_on:
type: string
description: 'The date on which the payment expires.'
format: 'date-time'
products:
type: array
items:
required:
- product_id
- quantity
- price
- description
type: object
properties:
product_id:
maxLength: 265
type: string
description: 'The id of the product.'
quantity:
type: integer
description: 'The quantity of the product.'
price:
type: integer
description: "The price of the item. Expressed using Checkout.com's standard
rules for calculating payment values."
description:
maxLength: 265
type: string
description: 'The description of the product.'
description: 'List of Products'
type:
type: string
description: The payment source type.
example: fawry
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- fawry
PaymentRequestGcashSource:
type: object
description: 'GCash Source'
properties:
type:
type: string
description: The payment source type.
example: gcash
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- gcash
required:
- type
PaymentRequestIdealSource:
###
# Warning: this file was auto generated from OpenAPI specs using 'npm run sync-generated-specs'. Do not manually edit.
###
type: object
description: 'iDEAL Source'
required:
- type
- description
properties:
description:
maxLength: 35
type: string
description: "Description of the product(s) or services being paid for. This
field must not contain characters that can lead to problems (for example those
occurring in HTML editing codes). To prevent any possible errors most iDEAL
systems will reject any description that contains HTML-tags and such other code.\n"
language:
maxLength: 2
type: string
description: |
This field enables the issuer's site to select the consumer's preferred language.
For example, the language selected on the merchant's site – if the issuer's site supports it. Code list in accordance with ISO 639-1. (Dutch = 'nl', English = 'en').
If a non-supported or non-existing language is entered, the standard language of the issuer is used. Because not all issuers support other languages, it is recommended to send 'nl' by default.
type:
type: string
description: The payment source type.
example: ideal
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- ideal
PaymentRequestIdSource:
type: object
description: An existing payment source. Payment Method required for ACH payment
required:
- type
- id
properties:
id:
type: string
pattern: "^(src)_(\\w{26})$"
description: The payment source identifier (e.g., a card source identifier)
example: src_wmlfc3zyhqzehihu7giusaaawu
cvv:
type: string
description: |
The card verification value (CVV) or code, if the source is a card. The expected format varies:
- for American Express cards, this should be a 4-digit code
- for other cards, this should be a 3-digit code
- for Checkout.com CVV tokens, this should be an ID value with the prefix `tok_`
pattern: ^tok_(\w{26})$|^\d{3,4}$
example: '956'
payment_method:
type: string
description: The payment method. Payment Method required for ACH payment
example: 'ach'
billing_address:
description: The cardholder's billing address.
allOf:
- $ref: '#/components/schemas/Address'
phone:
description: The cardholder's phone number.
allOf:
- $ref: '#/components/schemas/PhoneNumber'
account_holder:
type: object
description: Information about the account holder of the payment instrument
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/01_RequestSources_AccountHolderIndividual'
corporate: '#/components/schemas/02_RequestSources_AccountHolderCorporate'
government: '#/components/schemas/03_RequestSources_AccountHolderGovernment'
required:
- type
properties:
type:
type: string
example: 'individual'
allow_update:
type: boolean
description: Specifies whether to use the Real-Time
Account Updater to update the card information.
default: true
example: false
type:
type: string
description: The payment source type.
example: id
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- id
PaymentRequestKakaopaySource:
type: object
description: 'Kakaopay Source'
properties:
type:
type: string
description: The payment source type.
example: kakaopay
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- kakaopay
required:
- type
PaymentRequestKnetSource:
type: object
description: 'KNet Source'
required:
- type
properties:
type:
type: string
description: The payment source type.
example: knet
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- knet
language:
maxLength: 2
enum:
- ar
- en
type: string
description: |
Required for KNet Gateway payments.
This field enables the issuer's site to select the consumer's preferred language.
For example, the language selected on the merchant's site – if the issuer's site supports it.
Code list in accordance with ISO 639-1. (Arabic = 'ar', English = 'en').
Note that 'ar' corresponds to 'ARA' and 'en' to 'USA'. Both values accepted by KNet Gateway.
user_defined_field1:
maxLength: 255
type: string
description: >-
User-defined field that can be used to pass and store any additional transaction
data
required to be archived with the transaction and available as a searching criterion.
Only alphanumeric characters and spaces are allowed
user_defined_field2:
maxLength: 255
type: string
description: >-
User-defined field that can be used to pass and store any additional transaction
data
required to be archived with the transaction and available as a searching criterion.
Only alphanumeric characters and spaces are allowed
user_defined_field3:
maxLength: 255
type: string
description: >-
User-defined field that can be used to pass and store any additional transaction
data
required to be archived with the transaction and available as a searching criterion.
Only alphanumeric characters and spaces are allowed.
Note that this field must be omitted when the `card_token` field is not empty.
This restriction
exists because a card token is passed to KNet Gateway as `user_defined_field3`
user_defined_field4:
maxLength: 255
type: string
description: >-
User-defined field that can be used to pass and store any additional transaction
data
required to be archived with the transaction and available as a searching criterion.
Only alphanumeric characters and spaces are allowed.
user_defined_field5:
maxLength: 255
type: string
description: >-
User-defined field that can be used to pass and store any additional transaction
data
required to be archived with the transaction and available as a searching criterion.
Only alphanumeric characters and spaces are allowed.
Note that this field must be omitted when the `ptlf` field is not empty. This
restriction
exists because a PTLF value is passed to KNet Gateway as `user_defined_field5`
card_token:
type: string
pattern: '^[0-9]{8}$'
description: >-
This token allows re-use of card details for multiple payments.
This 8-digit token should be generated by a merchant. When a subsequent payment
is initialized with the same card token, a customer is presented with two options.
The customer can choose to pay with KFast (doesn't need to enter card details
again),
or with KNet as usual. The payment flow stays the same i.e. a merchant should
redirect
a customer to the redirect URL which is provided in the payment creation response.
Note that `user_defined_field3` must be omitted when the `card_token` field
is not empty. This restriction
exists because a card token is passed to KNet Gateway as `user_defined_field3`
ptlf:
maxLength: 45
type: string
description: >-
This is an ID for merchant PTLF functionality tracking.
Only alphanumeric characters are allowed.
Note that `user_defined_field5` must be omitted when the `ptlf` field is not
empty. This restriction
exists because a PTLF value is passed to KNet Gateway as `user_defined_field5`.
token_type:
type: string
enum:
- applepay
description: The token type. This field is always `applepay` for KNet Apple
Pay payments.
token_data:
description: The Apple Pay payment token. Required for Apple Pay payments.
allOf:
- $ref: '#/components/schemas/TokenData'
payment_method_details:
type: object
description: The payment data received in the Apple Pay payload. Required
for Apple Pay payments.
properties:
display_name:
type: string
description: The payment type display name.
example: 'Visa 1234'
type:
type: string
description: The payment method type.
example: 'debit'
network:
type: string
description: The card network.
example: 'Visa'
PaymentRequestMBWaySource:
type: object
description: 'MBWay payment request source'
required:
- type
properties:
type:
type: string
description: The payment source type.
example: mbway
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- mbway
PaymentRequestMobilePaySource:
type: object
description: 'MobilePay Request Source'
properties:
type:
type: string
description: The payment source type.
example: mobilepay
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- mobilepay
required:
- type
PaymentRequestMultibancoSource:
###
# Warning: this file was auto generated from OpenAPI specs using 'npm run sync-generated-specs'. Do not manually edit.
###
type: object
description: 'Multibanco Source'
required:
- type
- payment_country
- account_holder_name
properties:
payment_country:
maxLength: 2
minLength: 2
enum:
- PT
type: string
description: 'The 2-letter ISO country code of the country in which the payment
instrument is issued/operated.'
account_holder_name:
maxLength: 100
minLength: 3
type: string
description: 'The account holder.'
billing_descriptor:
maxLength: 65534
type: string
description: 'Payment billing descriptor.'
type:
type: string
description: The payment source type.
example: multibanco
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- multibanco
PaymentRequestNetworkTokenSource:
type: object
description: A network token payment source
required:
- type
- token
- expiry_month
- expiry_year
- token_type
- cryptogram
- eci
properties:
token:
type: string
description: The network token PAN
example: '4543474002249996'
expiry_month:
type: integer
description: The expiry month of the token
minimum: 1
example: 6
minLength: 1
maxLength: 2
expiry_year:
type: integer
description: The expiry year of the token
example: 2025
minLength: 4
maxLength: 4
token_type:
type: string
description: The type of token
enum:
- vts
- mdes
- applepay
- googlepay
cryptogram:
type: string
description: The Base64 encoded cryptographic identifier (TAVV) used by card
schemes to validate the token verification result. Optional if
`previous_payment_id` is specified and `3ds.enabled` is false
maxLength: 100
example: hv8mUFzPzRZoCAAAAAEQBDMAAAA=
eci:
type: string
description: |
The Electronic Commerce Indicator (ECI) security level associated with the token. Optional if `previous_payment_id` is specified and `3ds.enabled` is false
maxLength: 2
example: '05'
stored:
type: boolean
description: >-
Indicates whether this card is being submitted from your own stored card-on-file system, rather than being entered by the customer at the time of payment. Set to `true` when you provide card details that you already have on file for the customer.
default: false
example: true
store_for_future_use:
type: boolean
description: This must be set to true if you intend to reuse the payment
credentials in subsequent payments. Setting the field as false will mean
that a payment instrument will not be included in the payment
response.
default: true
example: false
name:
type: string
description: The customer's name
example: 'Bruce Wayne'
cvv:
type: string
description: The card verification value/code. 3 digits, except for American
Express (4 digits)
example: '956'
minLength: 3
maxLength: 4
billing_address:
description: The customer's billing address
allOf:
- $ref: '#/components/schemas/Address'
phone:
description: The customer's phone number
allOf:
- $ref: '#/components/schemas/PhoneNumber'
account_holder:
type: object
description: Information about the account holder of the card
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/01_RequestSources_AccountHolderIndividual'
corporate: '#/components/schemas/02_RequestSources_AccountHolderCorporate'
government: '#/components/schemas/03_RequestSources_AccountHolderGovernment'
properties:
type:
type: string
example: 'individual'
type:
type: string
description: The payment source type.
example: network_token
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- network_token
PaymentRequestOctopusPaySource:
type: object
description: "Octopus Pay Source"
required:
- type
properties:
type:
type: string
description: The payment source type.
example: octopus
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- octopus
PaymentRequestP24Source:
###
# Warning: this file was auto generated from OpenAPI specs using 'npm run sync-generated-specs'. Do not manually edit.
###
type: object
description: 'P24 Source'
required:
- type
- payment_country
- account_holder_name
- account_holder_email
properties:
type:
type: string
description: The payment source type.
example: p24
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- p24
payment_country:
maxLength: 2
minLength: 2
enum:
- PL
type: string
description: 'The 2-letter ISO country code of the country in which the payment
instrument is issued/operated.'
account_holder_name:
maxLength: 100
minLength: 3
type: string
description: 'The account holder.'
account_holder_email:
maxLength: 254
type: string
description: 'RFC-compliant email address of the account holder.'
billing_descriptor:
maxLength: 65534
type: string
description: 'Payment billing descriptor.'
PaymentRequestPayNowSource:
type: object
description: 'PayNow Request Source'
required:
- type
properties:
type:
type: string
description: The payment source type.
example: paynow
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- paynow
PaymentRequestPlaidSource:
type: object
description: A Plaid source.
required:
- type
- token
- account_holder
properties:
token:
type: string
description: |
The `processor_token` returned from Plaid’s `/processor/token/create` endpoint.
In the sandbox environment, this token will have the format `processor-sandbox-xxx`.
account_holder:
description: The account holder details.
allOf:
- $ref: '#/components/schemas/AccountHolder'
type:
type: string
description: The payment source type.
example: plaid
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- plaid
PaymentRequestQPaySource:
type: object
description: 'QPay Source'
required:
- type
- description
properties:
type:
type: string
description: The payment source type.
example: qpay
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- qpay
quantity:
minimum: 1
type: integer
description: 'A numeric value greater than zero that represents the quantity of
a purchased item. The value is used for display purposes only and does not affect
the total amount of the payment. The minimum allowed value is 1.'
description:
type: string
description: 'Alphanumeric string containing a description of the payment order.
Note: The maximum allowed length of this property is 255 characters after UTF-8
URL encoding.'
language:
type: string
description: 'Alphabetic value representing the language of the interface displayed
to customer at merchant site, and used as language for the payment description
parameter. PG will use this value to display the interface supporting selected
language to the customer during the payment process. Supported values are:
`En`, `Ar`. The default value is `En`.'
national_id:
maxLength: 32
type: string
description: 'Alphanumeric value representing the national ID of the customer
performing the transaction. The maximum allowed length of this property is 32.'
PaymentRequestSEPAV4Source:
type: object
description: 'SEPA DD Source'
required:
- type
- country
- account_number
- currency
- account_holder
properties:
country:
type: string
description: 'The account''s country, as an ISO 3166-1 alpha-2 code.'
example: FR
account_number:
type: string
description: 'The account holder''s IBAN.'
example: FR7630006000011234567890189
currency:
type: string
description: 'The account holder''s account currency.'
example: EUR
mandate_id:
type: string
description: 'The ID of the mandate.'
example: '123456'
mandate_type:
type: string
enum:
- Core
- B2B
description: 'The type of mandate.'
date_of_signature:
type: string
description: 'The date the mandate was signed, in the format yyyy-MM-dd'
example: 2022-08-02
account_holder:
type: object
description: 'The account holder''s personal information.'
required:
- billing_address
properties:
first_name:
type: string
description: 'The account holder''s first name.'
example: John
maxLength: 50
last_name:
type: string
description: 'The account holder''s last name.'
example: Wick
maxLength: 50
company_name:
type: string
description: 'The account holder''s company name.'
example: Checkout.com
maxLength: 50
type:
type: string
enum:
- Individual
- Corporate
description: The type of account holder
billing_address:
type: object
description: 'The account holder''s billing address.'
required:
- address_line1
- address_line2
- city
- zip
- country
properties:
address_line1:
type: string
description: 'The account holder''s street name.'
example: Evergreen Terrace
address_line2:
type: string
description: 'The account holder''s street number.'
example: '742'
maxLength: 10
city:
type: string
description: 'The account holder''s city.'
example: Paris
maxLength: 35
zip:
type: string
description: 'The account holder''s zip code.'
example: '75000'
maxLength: 16
country:
type: string
description: 'The account holder''s country, as an ISO 3166-1 alpha-2
code.'
example: FR
maxLength: 2
type:
type: string
description: The payment source type.
example: sepa
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- sepa
PaymentRequestSequraSource:
type: object
description: A seQura payment source
required:
- type
- billing_address
properties:
type:
type: string
description: The payment source type.
example: sequra
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- sequra
billing_address:
description: The billing address of the cardholder
required:
- address_line1
- city
- state
- country
- zip
allOf:
- $ref: '#/components/schemas/Address'
PaymentRequestSourceType:
type: string
description: Ordered list of payment request source types used for discriminators
enum:
- card
- customer
- id
- network_token
- token
- ach
- alipay_cn
- alipay_hk
- alipay_plus
- alma
- bancontact
- bizum
- blik
- dana
- eps
- fawry
- gcash
- ideal
- kakaopay
- knet
- mbway
- mobilepay
- multibanco
- octopus
- paynow
- plaid
- p24
- qpay
- sequra
- sepa
- stcpay
- swish
- tamara
- tng
- truemoney
- twint
- vipps
- wechatpay
PaymentRequestStcPaySource:
type: object
description: 'STC Pay request source'
required:
- type
properties:
type:
type: string
description: The payment source type.
example: stcpay
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- stcpay
PaymentRequestSwishSource:
type: object
description: 'Swish source'
required:
- type
- payment_country
- account_holder
properties:
payment_country:
maxLength: 2
minLength: 2
enum:
- SE
type: string
description: 'The 2-letter ISO country code of the country in which the payment
instrument is issued or operated.'
account_holder:
type: object
description: 'Information about the account holder''s details'
required:
- first_name
- last_name
properties:
first_name:
type: string
description: 'The account holder''s first name'
maxLength: 50
last_name:
type: string
description: 'The account holder''s last name'
maxLength: 50
billing_descriptor:
type: object
description: 'Payment billing descriptor'
required:
- name
properties:
name:
type: string
description: 'A description for the payment, which displays on the customer''s
statement'
maxLength: 120
type:
type: string
description: The payment source type.
example: swish
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- swish
PaymentRequestTamaraSource:
type: object
description: A Tamara payment source
required:
- type
- billing_address
properties:
billing_address:
description: The billing address of the cardholder
required:
- address_line1
- city
- country
allOf:
- $ref: '#/components/schemas/Address'
type:
type: string
description: The payment source type.
example: tamara
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- tamara
PaymentRequestTngSource:
type: object
description: 'TNG Source'
properties:
type:
type: string
description: The payment source type.
example: tng
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- tng
required:
- type
PaymentRequestTokenSource:
type: object
description: A token payment source
required:
- type
properties:
type:
type: string
description: The payment source type.
example: token
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- token
token:
type: string
pattern: "^(tok)_(\\w{26})$"
description: The Checkout.com token (e.g., a card token)
example: tok_ubfj2q76miwundwlk72vxt2i7q
billing_address:
description: The customer's billing address. This will override the billing
address specified during tokenization
allOf:
- $ref: '#/components/schemas/Address'
phone:
description: The customer's phone number. This will override the phone
number specified during tokenization
allOf:
- $ref: '#/components/schemas/PhoneNumber'
store_for_future_use:
type: boolean
description: This must be set to true if you intend to reuse the payment
credentials in subsequent payments. Setting the field as false will mean
that a payment instrument will not be included in the payment
response.
default: true
example: false
account_holder:
type: object
description: Information about the account holder of the card
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/01_RequestSources_AccountHolderIndividual'
corporate: '#/components/schemas/02_RequestSources_AccountHolderCorporate'
government: '#/components/schemas/03_RequestSources_AccountHolderGovernment'
required:
- type
properties:
type:
type: string
example: 'individual'
PaymentRequestTruemoneySource:
type: object
description: 'TrueMoney Source'
properties:
type:
type: string
description: The payment source type.
example: truemoney
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- truemoney
required:
- type
PaymentRequestTwintSource:
type: object
description: 'Twint Request Source'
properties:
type:
type: string
description: The payment source type.
example: twint
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- twint
required:
- type
PaymentRequestVippsSource:
type: object
description: 'Vipps Request Source'
properties:
type:
type: string
description: The payment source type.
example: vipps
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- vipps
required:
- type
PaymentRequestWeChatPaySource:
type: object
required:
- type
properties:
billing_address:
type: object
properties:
address_line1:
type: string
description: The first line of the address
example: 150 Kennedy Road
address_line2:
type: string
description: The second line of the address
example: Acacia Building
city:
type: string
description: The address city
example: Wan Chai
state:
type: string
description: The address state
example: Hong Kong
zip:
type: number
description: The address zip/postal code
example: 42345
country:
type: string
description: The two-letter ISO country code of the address
example: HK
type:
type: string
description: The payment source type.
example: wechatpay
allOf:
- $ref: '#/components/schemas/PaymentRequestSourceType'
- type: string
enum:
- wechatpay
BankPayoutRequestCurrencyAccountSource:
type: object
description: A currency account source.
required:
- type
- id
properties:
type:
type: string
description: The payout source type.
example: 'entity'
id:
type: string
pattern: '^(ca)_(\w{26})$'
maxLength: 29
minLength: 29
description: The currency account's identifier.
Its holding currency
must match the payout's `currency`.
example: ca_y3oqhf46pyzuxjbcn2giaqnb44
BankPayoutRequestEntitySource:
type: object
description: A currency account source.
required:
- type
- id
properties:
type:
type: string
description: The payout source type.
example: 'entity'
id:
type: string
pattern: "^(ent)_(\\w{26})$"
description: The entity or sub-entity's identifier, only applies to Platform
Clients.
example: ent_w4jelhppmfiufdnatam37wrfc4
01_RequestSources_AccountHolderIndividual:
type: object
description: Information about the individual account holder of the card
required:
- type
- first_name
- last_name
properties:
type:
type: string
description: |
The card account holder type
example: 'individual'
first_name:
type: string
description: |
The card account holder's first name
*A valid and legal name must be populated in this field. The populated value cannot be only one character or all non-alphabet.*
maxLength: 35
middle_name:
type: string
description: |
The card account holder's middle name
***Conditional*** - required when the [card metadata](https://api-reference.checkout.com/#operation/requestCardMetadata!c=200&path=issuer_country&t=response) `issuer_country` = `ZA` (South Africa)
maxLength: 35
last_name:
type: string
description: |
The card account holder's last name
*A valid and legal name must be populated in this field. The populated value cannot be only one character or all non-alphabet.*
maxLength: 35
account_name_inquiry:
type: boolean
description: |
Whether the ANI (account name inquiry) check should be performed with the scheme (Visa or MasterCard)
02_RequestSources_AccountHolderCorporate:
type: object
description: Information about the corporate account holder of the card
required:
- type
- company_name
properties:
type:
type: string
description: The card account holder type
example: 'corporate'
company_name:
type: string
description: |
The card account holder's company name
*A valid and legal name must be populated in this field. The populated value cannot be only one character or all non-alphabet.*
maxLength: 35
account_name_inquiry:
type: boolean
description: |
Whether the ANI (account name inquiry) check should be performed with the scheme (Visa or MasterCard)
03_RequestSources_AccountHolderGovernment:
type: object
description: Information about the government account holder of the card
required:
- type
- company_name
properties:
type:
type: string
description: The card account holder type
example: 'government'
company_name:
type: string
description: |
The card account holder's company name
*A valid and legal name must be populated in this field. The populated value cannot be only one character or all non-alphabet.*
maxLength: 35
account_name_inquiry:
type: boolean
description: |
Whether the ANI (account name inquiry) check should be performed with the scheme (Visa or MasterCard)
PaymentResponseBankAccountDestination:
type: object
description: A bank account payment destination
required:
- type
- id
properties:
type:
type: string
description: |
The payment destination type.
enum:
- bank_account
example: bank_account
id:
type: string
description: The payment instrument identifier
pattern: ^(src)_(\w{26})$
01_PaymentResponseIndividualSender:
type: object
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/PaymentDetailsResponseSender'
required:
- type
- first_name
- last_name
- address
properties:
first_name:
type: string
description: The sender's first name
example: 'John'
last_name:
type: string
description: The sender's last name
example: 'Jones'
address:
description: The sender's address
allOf:
- $ref: '#/components/schemas/Address'
02_PaymentResponseCorporateSender:
type: object
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/PaymentDetailsResponseSender'
required:
- type
- company_name
properties:
company_name:
type: string
description: The sender's company name
address:
description: The sender's address
allOf:
- $ref: '#/components/schemas/Address'
03_PaymentResponseInstrumentSender:
type: object
description: Store a previously tokenized instrument
allOf:
- $ref: '#/components/schemas/PaymentDetailsResponseSender'
required:
- type
PaymentDeclinedSourceResponse:
type: object
description: 'A source-based APM Declined payment source response'
required:
- id
- type
properties:
id:
type: string
description: 'The payment instrument identifier'
pattern: ^(src)_(\w{26})$
type:
type: string
description: 'The type of payment source'
enum:
- card
- ach
- alipay_cn
- bank_account
- sepa
PaymentResponseCardSource:
type: object
description: A card payment source
required:
- type
- expiry_month
- expiry_year
- last4
- fingerprint
- bin
properties:
type:
type: string
description: The payment source type.
enum:
- card
example: card
id:
type: string
description: The payment source identifier that can be used for subsequent payments. For new sources, this will only be returned if the payment was approved
example: 'src_nwd3m4in3hkuddfpjsaevunhdy'
billing_address:
description: The payment source owner's billing address
allOf:
- $ref: '#/components/schemas/Address'
phone:
description: The payment source owner's phone number
allOf:
- $ref: '#/components/schemas/PhoneNumber'
expiry_month:
type: integer
description: The expiry month
minimum: 1
minLength: 1
maxLength: 2
example: 6
expiry_year:
type: integer
description: The expiry year
minLength: 4
maxLength: 4
example: 2025
name:
type: string
description: The cardholder's name
example: 'Bruce Wayne'
scheme:
type: string
description: The card scheme
example: 'VISA'
scheme_local:
type: string
deprecated: true
description: |
Replaced by `local_schemes`
The local co-branded card scheme.
example: 'Cartes_Bancaires'
local_schemes:
type: array
items:
type: string
description: The local co-branded card schemes.
example: ['cartes_bancaires', 'visa']
last4:
type: string
description: The last four digits of the card number
example: '9996'
fingerprint:
type: string
description: Uniquely identifies this particular card number. You can use this to compare cards across customers.
example: 'F639CAB2745BEE4140BF86DF6B6D6'
bin:
type: string
description: The card issuer's Bank Identification Number (BIN)
maxLength: 8
example: '45434748'
card_type:
type: string
description: The card type
enum:
- CREDIT
- DEBIT
- PREPAID
- CHARGE
- DEFERRED DEBIT
example: CREDIT
card_category:
type: string
description: The card category
enum:
- CONSUMER
- COMMERCIAL
example: CONSUMER
card_wallet_type:
type: string
description: The card wallet type
enum:
- applepay
- googlepay
issuer:
type: string
description: The name of the card issuer
example: 'GOTHAM STATE BANK'
issuer_country:
type: string
maxLength: 2
minLength: 2
description: The card issuer's country (two-letter ISO code)
example: 'US'
product_id:
type: string
description: The issuer/card scheme product identifier
example: 'F'
product_type:
type: string
description: The issuer/card scheme product type
example: CLASSIC
avs_check:
type: string
description: The Address Verification System check result
example: S
cvv_check:
type: string
description: The card verification value (CVV) check result
example: Y
payment_account_reference:
type: string
description: A unique reference to the underlying card for network tokens (e.g., Apple Pay, Google Pay)
example: 'EUNIX9AX7THOOJIEJ2AP6OOFAHGH4'
encrypted_card_number:
type: string
description: The JWE encrypted full card number that has been updated by real-time account updater.
example: 'eyJ0eXAiOiJKV1QiLCJhbGciOiJSUz...'
account_update_status:
type: string
description: Specifies what card information was updated by the Real-Time Account Updater.
enum:
- card_updated
- card_expiry_updated
- card_closed
- contact_cardholder
example: card_updated
account_update_failure_code:
type: string
description: Provides the failure code if the Real-Time Account Updater fails to update the card information.
example: VAU009
account_holder:
type: object
description: Information about the account holder of the card
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/01_ResponseSources_AccountHolderIndividual'
corporate: '#/components/schemas/02_ResponseSources_AccountHolderCorporate'
government: '#/components/schemas/03_ResponseSources_AccountHolderGovernment'
required:
- type
properties:
type:
type: string
example: 'individual'
01_ResponseSources_AccountHolderIndividual:
type: object
description: Information about the individual that owns the account.
required:
- type
- first_name
- last_name
- account_name_inquiry
properties:
type:
type: string
description: The type of the card account holder
example: 'individual'
first_name:
type: string
description: |
The card account holder's first name
*A valid and legal name must be populated in this field. The populated value cannot be only one character or all non-alphabet.*
maxLength: 35
middle_name:
type: string
description: |
The card account holder's middle name
***Conditional*** - required when the [card metadata](https://api-reference.checkout.com/#operation/requestCardMetadata!c=200&path=issuer_country&t=response) `issuer_country` = `ZA` (South Africa)
maxLength: 35
last_name:
type: string
description: |
The card account holder's last name
*A valid and legal name must be populated in this field. The populated value cannot be only one character or all non-alphabet.*
maxLength: 35
account_name_inquiry:
type: string
enum: ["full_match", "partial_match", "no_match", "not_performed", "not_supported"]
description: |
The result of the Account Name Inquiry check.
account_name_inquiry_details:
type: object
description: Details of the Account Name Inquiry check.
allOf:
- $ref: '#/components/schemas/ResponseSources_AccountHolderIndividual_Names_Enquiry'
02_ResponseSources_AccountHolderCorporate:
type: object
description: Information about the corporate account holder of the card
required:
- type
- company_name
- account_name_inquiry
properties:
type:
type: string
description: The type of the card account holder
example: 'corporate'
company_name:
type: string
description: |
The card account holder's company name
*A valid and legal name must be populated in this field. The populated value cannot be only one character or all non-alphabet.*
maxLength: 35
account_name_inquiry:
type: string
enum: ["full_match", "partial_match", "no_match", "not_performed", "not_supported"]
description: |
The Account Name Inquiry check result.
03_ResponseSources_AccountHolderGovernment:
type: object
description: Information about the government account holder of the card
required:
- type
- company_name
- account_name_inquiry
properties:
type:
type: string
description: The type of the card account holder
example: 'government'
company_name:
type: string
description: |
The card account holder's company name
*A valid and legal name must be populated in this field. The populated value cannot be only one character or all non-alphabet.*
maxLength: 35
account_name_inquiry:
type: string
enum: ["full_match", "partial_match", "no_match", "not_performed", "not_supported"]
description: |
The Account Name Inquiry check result.
ResponseSources_AccountHolderIndividual_Names_Enquiry:
type: object
description: The granular results of the Account Name Inquiry check performed on the individual that owns the account.
properties:
first_name:
type: string
enum: [ "full_match", "partial_match", "no_match" ]
description: |
The result of the first name check.
middle_name:
type: string
enum: [ "full_match", "partial_match", "no_match" ]
description: |
The result of the middle name check.
last_name:
type: string
enum: [ "full_match", "partial_match", "no_match" ]
description: |
The result of the last name check.
RetryGetResponse:
type: object
required:
- enabled
description: |
Configuration relating to asynchronous retries
properties:
enabled:
type: boolean
description: Indicates whether asynchronous retries are enabled for the payment.
attempts_made:
type: integer
description: The number of retries attempted so far.
minimum: 0
max_attempts:
type: integer
description: The maximum number of authorization retry attempts, excluding the initial authorization.
default: 6
minimum: 1
maximum: 15
ends_on:
description: A timestamp that details the date on which the retry schedule expires, in ISO 8601 format.
allOf:
- $ref: '#/components/schemas/Timestamp'
next_attempt_on:
description: A timestamp that details the date on which the next authorization attempt will take place, in ISO 8601 format.
allOf:
- $ref: '#/components/schemas/Timestamp'
RetryPostResponse:
type: object
required:
- enabled
description: |
Configuration relating to asynchronous retries
properties:
enabled:
type: boolean
description: Indicates whether asynchronous retries are enabled for the payment.
max_attempts:
type: integer
description: The maximum number of authorization retry attempts, excluding the initial authorization.
default: 6
minimum: 1
maximum: 15
ends_on:
description: A timestamp that details the date on which the retry schedule expires, in ISO 8601 format.
allOf:
- $ref: '#/components/schemas/Timestamp'
next_attempt_on:
description: A timestamp of the date on which the next authorization attempt will take place, in ISO 8601 format.
allOf:
- $ref: '#/components/schemas/Timestamp'
RetryRequest:
type: object
required:
- enabled
description: |
Configuration of asynchronous retries.
For more information about asynchronous retries and supported response codes, see [Configure scheduled retries](https://www.checkout.com/docs/payments/manage-payments/configure-scheduled-retries).
properties:
enabled:
type: boolean
description: Indicates whether asynchronous retries are enabled for the payment.
dunning:
description: Configuration of asynchronous Dunning retries.
allOf:
- $ref: '#/components/schemas/DunningRetryRequest'
downtime:
description: Configuration of asynchronous Downtime retries.
allOf:
- $ref: '#/components/schemas/DowntimeRetryRequest'
RiskRequest:
type: object
description: Configures the risk assessment performed during the processing of the payment
properties:
enabled:
type: boolean
description: Whether a risk assessment should be performed
default: true
example: false
device_session_id:
type: string
description: Device session ID collected from our standalone Risk.js package. If you integrate using our [Frames](https://www.checkout.com/docs/integrate/frames) solution, this ID is not required.
example: "dsid_ipsmclhxwq72phhr32iwfvrflm"
pattern: "^(dsid)_(\\w{26})$"
device:
$ref: '#/components/schemas/DeviceDetails'
Ach:
description: The ACH payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
account_type:
type: string
description: The type of Direct Debit account.
enum:
- savings
- current
- cash
account_holder:
type: object
description: The account holder details.
properties:
type:
type: string
description: The type of account holder.
enum:
- individual
- corporate
- government
first_name:
type: string
description: The first name of the account holder.
last_name:
type: string
description: The last name of the account holder.
company_name:
type: string
description: The legal name of a registered company that holds the account.
date_of_birth:
type: string
description: The account holder's date of birth.
identification:
writeOnly: true
type: object
description: The account holder's government document identification, for example a Social Security Number (SSN).
properties:
type:
type: string
description: The document type.
issuing_country:
type: string
description: The country where the document was issued.
number:
type: string
description: The document number.
account_number:
writeOnly: true
type: string
description: The account number of the Direct Debit account.
minLength: 4
maxLength: 17
bank_code:
writeOnly: true
type: string
description: The bank code of the Direct Debit account.
minLength: 8
maxLength: 9
country:
type: string
description: The two-letter ISO country code of the bank account.
minLength: 2
maxLength: 2
AlipayCn:
description: The Alipay CN payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
terminal_type:
allOf:
- $ref: '#/components/schemas/TerminalType'
os_type:
allOf:
- $ref: '#/components/schemas/OsType'
AlipayHK:
description: The Alipay HK payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
terminal_type:
allOf:
- $ref: '#/components/schemas/TerminalType'
os_type:
allOf:
- $ref: '#/components/schemas/OsType'
Alma:
description: The Alma payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
ApplePay:
description: The Apple Pay payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
token_data:
type: object
writeOnly: true
properties:
version:
type: string
description: The version of the payment token. The token uses `EC_v1` for ECC-encrypted data, and `RSA_v1` for RSA-encrypted data.
writeOnly: true
data:
type: string
description: The encrypted payment data, Base64-encoded.
writeOnly: true
signature:
type: string
description: The signature of the payment and header data. The signature includes the signing certificate, its intermediate CA certificate, and information about the signing algorithm.
writeOnly: true
header:
type: object
description: Additional version-dependent information used to decrypt and verify the payment.
writeOnly: true
properties:
ephemeral_public_key:
type: string
writeOnly: true
public_key_hash:
type: string
writeOnly: true
transaction_id:
type: string
writeOnly: true
token:
type: object
description: The Checkout.com Apple Pay token.
required:
- id
properties:
id:
type: string
description: The token identifier, prefixed by `tok_`.
pattern: ^(tok)_(\w{26})$
expires_on:
type: string
format: date-time
description: The date and time the token expires, in ISO 8601 format.
store_for_future_use:
type: boolean
description: Set to `true` if you intend to reuse the payment credentials in subsequent payments. If set to `false`, a payment instrument will not be included in the payment response.
writeOnly: true
phone:
type: object
description: The customer's phone number.
allOf:
- $ref: '#/components/schemas/PaymentSetupPhone'
account_holder:
allOf:
- $ref: '#/components/schemas/PaymentSetupAccountHolder'
schemes:
type: array
description: The list of supported card scheme names.
readOnly: true
items:
type: string
description: The supported card scheme name.
enum:
- accel
- amex
- cartes_bancaires
- china_union_pay
- diners
- discover
- jcb
- mada
- maestro
- mastercard
- nyce
- omannet
- pulse
- shazam
- star
- upi
- visa
preferred_scheme:
type: string
description: The preferred card scheme to process the payment.
enum:
- visa
- mastercard
- cartes_bancaires
Bacs:
description: The Bacs payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- $ref: '#/components/schemas/PaymentMethodInitialization'
- type: object
properties:
instrument_id:
type: string
description: The ID of the Bacs instrument used for the payment.
example: src_wkq7552u245upl5h75x24554xy
readOnly: true
account_holder:
type: object
description: The account holder details.
properties:
type:
type: string
description: The type of account holder.
enum:
- individual
- corporate
first_name:
type: string
description: The first name of the account holder.
last_name:
type: string
description: The last name of the account holder.
company_name:
type: string
description: The legal name of a registered company that holds the account.
email:
type: string
description: The email address of the account holder.
example: john.smith@example.com
account_number:
writeOnly: true
type: string
description: The account number of the Bacs Direct Debit account.
bank_code:
writeOnly: true
type: string
description: The sort code of the Bacs Direct Debit account.
country:
type: string
description: The account's country, as an ISO 3166-1 alpha-2 code.
minLength: 2
maxLength: 2
currency:
type: string
description: The account holder's account currency.
allow_partial_match:
type: boolean
description: Whether vault may accept a partial match when looking up an existing Bacs instrument for the supplied account details.
default: false
Bancontact:
description: The Bancontact payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
account_holder_name:
type: string
description: The account holder's name.
minLength: 3
maxLength: 100
Benefit:
description: The Benefit payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
Bizum:
description: The Bizum payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
Blik:
description: The Blik payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
partner_code:
type: string
writeOnly: true
description: The 6-digit BLIK code generated by the customer's banking app.
pattern: ^[0-9]{6}$
example: '999111'
Card:
description: The Card payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
token:
type: object
properties:
id:
type: string
description: The Checkout.com card token identifier.
details:
type: object
properties:
number:
type: string
description: The card number (without separators).
writeOnly: true
last4:
type: string
description: The last four digits of the card number.
readOnly: true
bin:
type: string
description: The card issuer's Bank Identification Number (BIN).
readOnly: true
scheme:
type: string
description: The card scheme.
readOnly: true
expiry_month:
type: integer
description: The expiry month of the card.
expiry_year:
type: integer
description: The expiry year of the card.
name:
type: string
description: The cardholder's name.
writeOnly: true
cvv:
type: string
description: The card verification value/code. 3 digits, except for American Express (4 digits).
writeOnly: true
stored:
type: boolean
description: Indicates whether this card is being submitted from your own stored card-on-file system, rather than being entered by the customer at the time of payment. Set to `true` when you provide card details that you already have on file for the customer.
writeOnly: true
expires_on:
type: string
format: date-time
description: The time by which the card details must be confirmed.
readOnly: true
allow_update:
type: boolean
description: Indicates whether to use the Real-Time Account Updater to update the card information.
store_for_future_use:
type: boolean
description: Set to `true` if you intend to reuse the payment credentials in subsequent payments. If set to `false`, a payment instrument will not be included in the payment response.
writeOnly: true
phone:
type: object
description: The customer's phone number.
allOf:
- $ref: '#/components/schemas/PaymentSetupPhone'
account_holder:
allOf:
- $ref: '#/components/schemas/PaymentSetupAccountHolder'
schemes:
type: array
description: The list of supported card scheme names.
readOnly: true
items:
type: string
description: The supported card scheme name.
enum:
- accel
- amex
- cartes_bancaires
- china_union_pay
- diners
- discover
- jcb
- mada
- maestro
- mastercard
- nyce
- omannet
- pulse
- shazam
- star
- upi
- visa
preferred_scheme:
type: string
description: The preferred card scheme to process the payment.
enum:
- visa
- mastercard
- cartes_bancaires
CardPresent:
description: The Card Present payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
track2:
type: string
description: The Track 2 data read from card or device.
writeOnly: true
emv:
type: string
description: The EMV data read from the card or device.
writeOnly: true
entry_mode:
type: string
description: The mode used to capture the card details at the point of sale.
writeOnly: true
pin:
type: object
description: The encrypted PIN block details.
writeOnly: true
required:
- key_set_id
- block
- block_format
properties:
key_serial_number:
type: string
description: The Key Serial Number (KSN) used by the HSM to decrypt the PIN block.
example: FFFF9876543210E00001
pattern: ^([0-9a-fA-F]{20}|[0-9a-fA-F]{24})$
writeOnly: true
block:
type: string
description: The encrypted PIN block.
writeOnly: true
block_format:
type: string
description: The format of the encrypted PIN block.
writeOnly: true
key_set_id:
type: string
description: The identifier of the key set used to encrypt the PIN block.
writeOnly: true
store_for_future_use:
type: boolean
description: Set to `true` if you intend to reuse the payment credentials in subsequent payments.
writeOnly: true
name:
type: string
description: The cardholder's name.
writeOnly: true
Dana:
description: The Dana payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
terminal_type:
allOf:
- $ref: '#/components/schemas/TerminalType'
os_type:
allOf:
- $ref: '#/components/schemas/OsType'
Eps:
description: The EPS payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
GCash:
description: The GCash payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
terminal_type:
allOf:
- $ref: '#/components/schemas/TerminalType'
os_type:
allOf:
- $ref: '#/components/schemas/OsType'
GooglePay:
description: The Google Pay payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
token_data:
type: object
writeOnly: true
properties:
protocol_version:
type: string
description: The encryption and signing scheme used to create this message. If not set, the default is `ECv0`.
writeOnly: true
signature:
type: string
description: The signature that verifies the message came from Google, created using `ECDSA`.
writeOnly: true
signed_message:
type: string
description: A serialized JSON string containing the `encryptedMessage`, `ephemeralPublicKey`, and `tag`. To simplify the signature verification process, this value is serialized.
writeOnly: true
tokenization_key:
type: string
description: The public key provided to the Google API in the `tokenizationSpecification.parameters.gatewayMerchantId` field.
writeOnly: true
token:
type: object
description: The Checkout.com Google Pay token.
required:
- id
properties:
id:
type: string
description: The token identifier, prefixed by `tok_`.
pattern: ^(tok)_(\w{26})$
expires_on:
type: string
format: date-time
description: The date and time the token expires, in ISO 8601 format.
store_for_future_use:
type: boolean
description: Set to `true` if you intend to reuse the payment credentials in subsequent payments. If set to `false`, a payment instrument will not be included in the payment response.
writeOnly: true
phone:
type: object
description: The customer's phone number.
allOf:
- $ref: '#/components/schemas/PaymentSetupPhone'
account_holder:
allOf:
- $ref: '#/components/schemas/PaymentSetupAccountHolder'
schemes:
type: array
description: The list of supported card scheme names.
readOnly: true
items:
type: string
description: The supported card scheme name.
enum:
- accel
- amex
- china_union_pay
- diners
- discover
- jcb
- mada
- maestro
- mastercard
- nyce
- omannet
- pulse
- shazam
- star
- upi
- visa
preferred_scheme:
type: string
description: The preferred card scheme to process the payment.
enum:
- visa
- mastercard
Ideal:
description: The iDEAL payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
description:
type: string
description: A description of the products or services being paid for. Do not include HTML tags or special characters, as these are rejected by iDEAL.
example: 2 t-shirts
maxLength: 35
KakaoPay:
description: The KakaoPay payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
terminal_type:
allOf:
- $ref: '#/components/schemas/TerminalType'
os_type:
allOf:
- $ref: '#/components/schemas/OsType'
Klarna:
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- $ref: '#/components/schemas/PaymentMethodInitialization'
- type: object
description: The Klarna payment method's details and configuration.
properties:
action:
type: object
readOnly: true
description: The next available action for the payment method.
properties:
type:
type: string
description: The type of action.
enum:
- sdk
client_token:
type: string
description: The client token for the Klarna SDK.
example: >-
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.ewogICJzZXNzaW9uX2lkIiA6ICIw
session_id:
type: string
description: The session ID.
example: 0b1d9815-165e-42e2-8867-35bc03789e00
account_holder:
readOnly: true
allOf:
- $ref: '#/components/schemas/KlarnaAccountHolder'
iban:
type: string
readOnly: true
description: The IBAN of the account used to complete Klarna verification.
example: DE89370400440532013000
KlarnaAccountHolder:
type: object
description: The account holder details returned by Klarna after the shopper completes verification.
properties:
name:
type: string
description: The full name of the account holder.
Knet:
description: The KNET payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
language:
type: string
description: |
The customer's preferred language, as an ISO 639-1 code. For example, the language selected on your site, if the issuer's site supports it.
- `ar` - Arabic
- `en` - English
enum:
- en
- ar
MBWay:
description: The MBWay payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
MobilePay:
description: The MobilePay payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
Multibanco:
description: The Multibanco payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
account_holder_name:
type: string
description: The account holder's name.
minLength: 3
maxLength: 100
Octopus:
description: The Octopus payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
OrderItem:
type: object
description: A line item from the customer's order.
properties:
name:
type: string
description: The descriptive name of the line item.
example: Battery Power Pack
quantity:
type: integer
description: The quantity of the line item.
example: 1
unit_price:
type: number
description: The unit price of the line item, in minor currency units.
example: 1000
total_amount:
type: number
description: |
The total cost of the line item, in minor currency units.
Include any tax and discounts applied, using the formula: `value = (quantity x unit_price) - discount_amount`.
example: 1000
reference:
type: string
description: The line item reference or product stock keeping unit (SKU).
example: BA67A
discount_amount:
type: number
description: The discount applied to each invoice line item.
example: 150
url:
type: string
description: Link to the line item's product page.
maxLength: 1024
example: https://example.com/products/my-item
image_url:
type: string
description: Link to the item image to show in the order confirmation.
maxLength: 1024
example: https://example.com/products/my-item/image
type:
type: string
description: The item type. For example, physical or digital.
example: digital
OsType:
type: string
enum:
- android
- ios
description: The customer's operating system type. Required when `terminal_type` is not `web`.
example: android
P24:
description: The P24 (Przelewy24) payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
account_holder:
type: object
description: The account holder's details.
properties:
name:
type: string
description: The account holder's name.
minLength: 3
maxLength: 100
email:
type: string
format: email
description: The account holder's email address.
maxLength: 254
PayByBank:
description: The Pay by Bank (Open Banking) payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
bank_id:
type: string
description: The identifier of the bank the customer has selected for the payment.
example: ob-natwest
action:
type: object
readOnly: true
description: The next available action for the payment method.
properties:
type:
type: string
description: The type of action.
enum:
- select_bank
banks:
type: array
description: The list of banks available for the customer to select.
items:
type: object
properties:
bank_id:
type: string
description: The unique identifier of the bank.
example: ob-natwest
display_name:
type: string
description: The display name of the bank.
example: NatWest
logo_url:
type: string
description: The URL of the bank's logo.
example: https://cdn.token.io/banks/natwest.png
available:
type: boolean
description: Whether the bank is currently available for selection.
example: true
PaymentMethodFlags:
type: array
description: The list of error codes or indicators that highlight missing or invalid information.
readOnly: true
items:
type: string
description: Flags relating to the payment method option.
PaymentMethodInitialization:
type: object
properties:
initialization:
enum:
- disabled
- enabled
type: string
description: |
The initialization state of the payment method.
When you create a Payment Setup, this defaults to `disabled`.
default: disabled
PaymentMethodStatus:
type: string
description: The payment method status.
enum:
- unavailable
- action_required
- ready
- initialization_required
- invalid
readOnly: true
example: ready
PaymentSetup:
type: object
required:
- processing_channel_id
- amount
- currency
properties:
id:
type: string
readOnly: true
processing_channel_id:
pattern: ^(pc)_(\w{26})$
type: string
description: The processing channel to use for the payment.
example: pc_q4dbxom5jbgudnjzjpz7j2z6uq
amount:
type: number
description: The payment amount, in the minor currency unit.
example: 10000
currency:
type: string
description: The currency of the payment, as a three-letter ISO currency code.
example: GBP
presentment_details:
$ref: '#/components/schemas/PaymentSetupPresentmentDetails'
payment_type:
enum:
- regular
- recurring
- moto
- installment
- pay_later
- unscheduled
type: string
description: |
The type of payment.
You must provide this field for card payments in which the cardholder is not present. For example, if the transaction is a recurring payment, or a mail order/telephone order (MOTO) payment.
default: regular
example: regular
reference:
type: string
description: A reference you can use to identify the payment. For example, an order number.
maxLength: 80
example: REF-0987-475
description:
type: string
description: A description of the payment.
maxLength: 100
example: Set of 3 t-shirts
payment_methods:
type: object
description: The payment methods that are enabled on your account and available for use.
properties:
auto_confirm:
type: string
description: The payment method that automatically confirms the payment when it is ready.
example: card
instrument:
$ref: '#/components/schemas/PaymentSetupInstrument'
klarna:
$ref: '#/components/schemas/Klarna'
stcpay:
$ref: '#/components/schemas/StcPay'
tabby:
$ref: '#/components/schemas/Tabby'
bizum:
readOnly: true
allOf:
- $ref: '#/components/schemas/Bizum'
paynow:
readOnly: true
allOf:
- $ref: '#/components/schemas/PayNow'
qpay:
$ref: '#/components/schemas/Qpay'
eps:
readOnly: true
allOf:
- $ref: '#/components/schemas/Eps'
ideal:
$ref: '#/components/schemas/Ideal'
knet:
$ref: '#/components/schemas/Knet'
bancontact:
$ref: '#/components/schemas/Bancontact'
benefit:
readOnly: true
allOf:
- $ref: '#/components/schemas/Benefit'
blik:
$ref: '#/components/schemas/Blik'
vipps:
readOnly: true
allOf:
- $ref: '#/components/schemas/Vipps'
twint:
readOnly: true
allOf:
- $ref: '#/components/schemas/Twint'
alipay_cn:
$ref: '#/components/schemas/AlipayCn'
alipay_hk:
$ref: '#/components/schemas/AlipayHK'
gcash:
$ref: '#/components/schemas/GCash'
tng:
$ref: '#/components/schemas/Tng'
dana:
$ref: '#/components/schemas/Dana'
mobilepay:
readOnly: true
allOf:
- $ref: '#/components/schemas/MobilePay'
tamara:
$ref: '#/components/schemas/Tamara'
mbway:
readOnly: true
allOf:
- $ref: '#/components/schemas/MBWay'
multibanco:
$ref: '#/components/schemas/Multibanco'
wechatpay:
readOnly: true
allOf:
- $ref: '#/components/schemas/WeChatPay'
kakaopay:
$ref: '#/components/schemas/KakaoPay'
truemoney:
$ref: '#/components/schemas/TrueMoney'
octopus:
readOnly: true
allOf:
- $ref: '#/components/schemas/Octopus'
p24:
$ref: '#/components/schemas/P24'
alma:
$ref: '#/components/schemas/Alma'
swish:
$ref: '#/components/schemas/Swish'
sequra:
$ref: '#/components/schemas/Sequra'
ach:
$ref: '#/components/schemas/Ach'
sepa:
$ref: '#/components/schemas/Sepa'
bacs:
$ref: '#/components/schemas/Bacs'
paybybank:
$ref: '#/components/schemas/PayByBank'
paypal:
$ref: '#/components/schemas/PayPal'
googlepay:
$ref: '#/components/schemas/GooglePay'
applepay:
$ref: '#/components/schemas/ApplePay'
card:
$ref: '#/components/schemas/Card'
card_present:
$ref: '#/components/schemas/CardPresent'
stablecoin:
$ref: '#/components/schemas/Stablecoin'
available_payment_methods:
type: array
readOnly: true
description: |
An ordered list of available payment method names. The order indicates
the recommended presentation priority, with the first item being the
highest priority.
items:
type: string
example:
- card
- klarna
- stcpay
- stablecoin
settings:
type: object
description: Settings for the Payment Setup.
properties:
success_url:
maxLength: 255
type: string
description: |
The URL to redirect the customer to, if the payment is successful.
For payment methods with a redirect, this value overrides the default success redirect URL configured on your account.
format: uri
example: https://example.com/payments/success
failure_url:
maxLength: 255
type: string
description: |
The URL to redirect the customer to, if the payment is unsuccessful.
For payment methods with a redirect, this value overrides the default failure redirect URL configured on your account.
format: uri
example: https://example.com/payments/fail
capture:
type: boolean
description: Indicates whether to capture the payment immediately.
default: true
example: true
excluded_payment_methods:
type: array
description: The list of payment methods excluded from the Payment Setup.
items:
type: string
example:
- card
- klarna
- stcpay
risk:
type: object
description: Risk assessment settings for the Payment Setup.
properties:
enabled:
type: boolean
description: Indicates whether a risk assessment should be performed.
default: true
example: true
customer:
type: object
description: The customer's details.
properties:
country:
type: string
minLength: 2
maxLength: 2
description: The two-letter ISO country code of the customer for this payment.
example: GB
id:
type: string
description: The unique identifier of the customer.
example: cus_123456789
email:
type: object
description: Details of the customer's email.
properties:
address:
type: string
description: The customer's email address.
example: johnsmith@example.com
verified:
type: boolean
description: Specifies whether the customer's email address is verified.
example: true
name:
type: string
description: The customer's full name.
maxLength: 100
example: John Smith
tax_number:
type: string
description: The customer's tax identification number.
example: GB123456789
phone:
allOf:
- $ref: '#/components/schemas/PaymentSetupPhone'
device:
type: object
description: Details of the customer's device.
properties:
locale:
type: string
description: The locale of the device.
example: en_GB
merchant_account:
allOf:
- $ref: '#/components/schemas/PaymentSetupMerchantAccount'
order:
type: object
description: The customer's order details.
properties:
items:
type: array
description: A list of items in the order.
items:
allOf:
- $ref: '#/components/schemas/OrderItem'
shipping:
allOf:
- $ref: '#/components/schemas/PaymentSetupShipping'
sub_merchants:
type: array
description: The details of the sub-merchants.
items:
allOf:
- $ref: '#/components/schemas/PaymentSetupSubMerchant'
invoice_id:
type: string
description: The unique identifier for the invoice.
example: inv_123456789
shipping_amount:
type: integer
description: The total shipping amount for the order.
minimum: 0
example: 5
discount_amount:
type: integer
description: The discount amount the merchant applied to the transaction.
minimum: 0
example: 10
tax_amount:
type: integer
description: The total tax amount for the order.
minimum: 0
example: 2
tipping_amount:
type: integer
format: int64
description: The total tipping amount for the order.
minimum: 0
example: 2
surcharge_amount:
type: integer
format: int64
description: The total surcharge amount for the order.
minimum: 0
example: 2
amount_allocations:
type: array
description: The sub-entities that the payment is being processed on behalf of.
minItems: 1
maxItems: 50
items:
allOf:
- $ref: '#/components/schemas/PaymentSetupAmountAllocation'
billing:
$ref: '#/components/schemas/PaymentSetupBilling'
industry:
type: object
description: Industry-specific information.
properties:
airline:
type: array
items:
allOf:
- $ref: '#/components/schemas/PaymentSetupAirline'
accommodation:
type: array
items:
allOf:
- $ref: '#/components/schemas/PaymentSetupAccommodation'
account_funding_transaction:
allOf:
- $ref: '#/components/schemas/PaymentSetupAccountFundingTransaction'
terminal:
allOf:
- $ref: '#/components/schemas/PaymentSetupTerminal'
billing_descriptor:
$ref: '#/components/schemas/PaymentSetupBillingDescriptor'
metadata:
type: object
description: A set of key/value pairs you can attach to a payment. It can be useful for storing additional information about the payment.
maxProperties: 20
additionalProperties:
oneOf:
- type: string
maxLength: 255
- type: number
- type: boolean
latest_payment:
type: object
readOnly: true
description: The latest payment response from the gateway, populated when auto-confirm succeeds during setup creation. For the full response schema, see Request a Payment or Payout.
PaymentSetupAccommodation:
type: object
properties:
name:
type: string
description: >-
For lodging, contains the lodging name that appears on the
storefront/customer receipts. For cruise, contains the ship name booked for the cruise.
example: Checkout Lodge
booking_reference:
type: string
description: A unique identifier for the booking.
example: REF9083748
check_in_date:
type: string
description: >-
For lodging bookings, the customer's check-in date.
For cruise bookings, the cruise departure date. Also referred to as the sail date.
format: date
example: '2025-04-11'
check_out_date:
type: string
description: >-
For lodging bookings, the customer's check-out date.
For cruise bookings, the cruise return date.
format: date
example: '2025-04-18'
address:
type: object
description: The accommodation's address.
properties:
address_line1:
type: string
description: The first line of the address.
example: 123 High Street
city:
type: string
description: The address city.
example: London
state:
type: string
description: The address state or county.
example: Greater London
country:
type: string
description: The address country, in ISO 3166-1 alpha-2 format.
example: GB
zip:
type: string
description: The zip code or postal code.
example: NE1 1CK
number_of_rooms:
type: integer
description: The total number of rooms booked for the accommodation.
example: 2
guests:
type: array
description: The list of guests staying at the accommodation.
items:
type: object
properties:
first_name:
type: string
description: The guest's first name.
example: John
last_name:
type: string
description: The guest's last name.
example: Smith
date_of_birth:
type: string
description: The guest's date of birth.
format: date
example: '1970-03-19'
room:
type: array
description: The list of rooms booked by the customer.
items:
type: object
properties:
rate:
type: number
description: The rate or cost of the room per day.
example: 42.3
number_of_nights:
type: integer
description: The number of nights the room is booked for.
example: 5
PaymentSetupAccountFundingTransaction:
type: object
description: Account funding transaction details for the payment.
properties:
enabled:
type: boolean
description: Whether to process this payment as an account funding transaction.
example: true
purpose:
type: string
description: Specifies the purpose of the account funding transaction.
enum:
- donations
- education
- emergency_need
- expatriation
- family_support
- financial_services
- gifts
- income
- insurance
- investment
- it_services
- leisure
- loan_payment
- medical_treatment
- other
- pension
- royalties
- savings
- travel_and_tourism
example: financial_services
sender:
type: object
description: Account funding transaction sender details.
properties:
date_of_birth:
type: string
format: date
description: Date of birth of the sender (yyyy-mm-dd).
example: '2000-01-01'
reference:
type: string
description: The unique reference for the sender of the payment.
example: 0fc88634-78c1-4286-9cb6-6ca358730c8c
identification:
type: object
description: Sender identification details.
properties:
type:
type: string
description: The type of identification used to identify the sender.
enum:
- passport
- driving_license
- national_id
number:
type: string
description: The identification number.
example: '1234567890'
issuing_country:
type: string
description: The two-letter ISO country code of the country that issued the identification
example: US
recipient:
type: object
description: Account funding transaction recipient details.
properties:
date_of_birth:
type: string
format: date
description: Date of birth of the recipient (yyyy-mm-dd).
example: '2000-01-01'
account_number:
type: string
maxLength: 34
description: Any identifier like part of the PAN (first six digits and last four digits), an IBAN, an internal account number, or a phone number related to the primary recipient's account
first_name:
type: string
maxLength: 50
description: The recipient's first name.
last_name:
type: string
maxLength: 50
description: The recipient's last name.
address:
allOf:
- $ref: '#/components/schemas/PaymentSetupAddress'
PaymentSetupAccountHolder:
type: object
description: Account holder details for the payment.
properties:
type:
type: string
description: The card account holder type.
enum:
- individual
- government
- corporate
first_name:
type: string
description: The card account holder's first name.
last_name:
type: string
description: The card account holder's last name.
middle_name:
type: string
description: The card account holder's middle name.
company_name:
type: string
description: The card account holder's company name.
account_name_inquiry:
type: boolean
description: Indicates whether the ANI (account name inquiry) check is performed with the card scheme (Visa or Mastercard).
PaymentSetupAddress:
type: object
description: A physical address.
properties:
address_line1:
type: string
description: The first line of the address.
maxLength: 200
example: 10 Canterbury Road
address_line2:
type: string
description: The second line of the address.
maxLength: 200
example: Flat 2
city:
type: string
description: The address city.
maxLength: 50
example: London
state:
type: string
description: The address state or county.
maxLength: 50
example: Greater London
zip:
type: string
description: The postal or zip code.
maxLength: 50
example: NE1 1KO
country:
type: string
description: The address country, in ISO 3166-1 alpha-2 format.
maxLength: 2
example: GB
PaymentSetupAirline:
type: object
description: Details about the airline ticket and flights the customer booked.
properties:
ticket:
type: object
description: Details about the airline ticket.
properties:
number:
type: string
description: The ticket's unique identifier.
example: '0742464639523'
issue_date:
type: string
description: The date the airline ticket was issued.
format: date
example: '2025-05-01'
issuing_carrier_code:
type: string
description: The carrier code of the ticket issuer.
example: '042'
travel_package_indicator:
type: string
description: |
The travel package indicator, as one of the following codes:
- `A` - Airline flight reservation
- `B` - Car rental and airline reservation
- `C` - Car rental reservation
- `N` - Unknown
example: A
travel_agency_name:
type: string
description: The name of the travel agency.
example: Checkout Travel Agents
travel_agency_code:
type: string
description: The IATA or ARC unique identifier for the travel agency that issues the ticket.
example: '91114362'
passengers:
type: array
description: The list of passengers on the flight.
items:
type: object
properties:
first_name:
type: string
description: The passenger's first name.
example: John
last_name:
type: string
description: The passenger's last name.
example: Smith
date_of_birth:
type: string
description: The passenger's date of birth.
format: date
example: '1990-10-31'
address:
type: object
description: Details about the passenger's address.
properties:
country:
type: string
description: The two-letter ISO country code of the passenger's country of residence.
example: GB
flight_leg_details:
type: array
description: The list of flight legs booked by the customer.
items:
allOf:
- $ref: '#/components/schemas/PaymentSetupFlightLegDetails'
PaymentSetupAmountAllocation:
type: object
required:
- id
- amount
title: Amount Allocations
description: An amount allocation representing a sub-entity on whose behalf the payment is being processed.
properties:
id:
type: string
description: The id of the sub-entity.
example: ent_w4jelhppmfiufdnatam37wrfc4
amount:
type: integer
description: |
The split amount - this will be credited to your sub-entity's currency account. The sum of all split amounts must be equal to the payment amount.
The amount must be provided in the minor currency unit.
minimum: 0
format: int64
maximum: 9999999999
example: 1000
reference:
type: string
description: A reference you can later use to identify this split, such as an order number.
maxLength: 50
example: ORD-5023-4E89
commission:
type: object
title: Commission
description: |
Commission you'd like to collect from this split - this will be credited to your currency account. The commission cannot exceed the split amount.
Commission = (`amount` * `commission.percentage`) + `commission.amount`
properties:
amount:
type: integer
format: int64
description: |
Optional fixed amount of commission to collect.
The amount must be provided in the minor currency unit.
minimum: 0
example: 1000
percentage:
type: number
description: |
Optional percentage of commission to collect.
Supports up to 8 decimal places.
minimum: 0
maximum: 100
example: 1.125
PaymentSetupBilling:
type: object
description: The billing details for the payment.
properties:
address:
allOf:
- $ref: '#/components/schemas/PaymentSetupAddress'
PaymentSetupBillingDescriptor:
type: object
description: The billing descriptor for payment.
properties:
name:
type: string
description: A dynamic description of the payment.
maxLength: 25
example: Checkout.com
city:
type: string
description: The city from which the payment was made.
maxLength: 13
example: London
reference:
type: string
description: The reference shown on the statement.
maxLength: 50
example: Payment for order 123456
PaymentSetupFlightLegDetails:
type: object
properties:
flight_number:
type: string
description: The flight identifier.
example: BA1483
carrier_code:
type: string
description: The IATA 2-letter accounting code (PAX) that identifies the carrier. Required if the airline data includes leg details.
example: BA
class_of_travelling:
type: string
description: |
A one-letter identifier for the travel class. For example:
- `F` - First class
- `J` - Business class
- `W` - Premium economy class
- `Y` - Economy class
example: W
departure_airport:
type: string
description: The IATA three-letter airport code for the departure airport. Required if the airline data includes leg details.
example: LHR
departure_date:
type: string
format: date
description: The date of the scheduled take-off.
example: '2025-10-13'
departure_time:
type: string
description: The time of the scheduled take-off.
example: '18:30'
arrival_airport:
type: string
description: The IATA three-letter airport code for the destination airport. Required if the airline data includes leg details.
example: JFK
stop_over_code:
type: string
description: |
A one-letter code that indicates whether the passenger is entitled to make a stopover. Specify `O` or a blank space if the passenger is entitled. Specify `X` if the passenger is not entitled.
example: X
fare_basis_code:
type: string
description: The alphanumeric fare basis code.
example: WUP14B
PaymentSetupInstrument:
description: The instrument payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
id:
type: string
description: The unique identifier of the selected instrument.
example: src_wmlfc3zttb4uzmk6snpwb43jbi
type:
type: string
readOnly: true
description: The type of the instrument.
example: bacs
action:
type: object
readOnly: true
description: The next available action for the payment method.
properties:
type:
enum:
- set_instrument
type: string
description: The type of action.
PaymentSetupMerchantAccount:
type: object
description: Details of the account the customer holds with the merchant.
properties:
id:
type: string
description: The merchant's unique identifier for the customer's account.
example: '1234'
registration_date:
type: string
description: The date the customer registered their account with the merchant.
format: date
example: '2023-05-01'
last_modified:
type: string
description: The date the customer's account with the merchant was last modified.
format: date
example: '2023-05-01'
returning_customer:
type: boolean
description: Specifies if the customer is a returning customer.
first_transaction_date:
type: string
description: The date of the customer's first transaction.
format: date
example: '2023-09-15'
last_transaction_date:
type: string
description: The date of the customer's most recent transaction.
format: date
example: '2025-03-28'
total_order_count:
type: integer
description: The total number of orders made by the customer.
example: 6
last_payment_amount:
type: number
description: The payment amount of the customer's most recent transaction.
example: 55.99
PaymentSetupPaymentMethod:
type: object
properties:
status:
allOf:
- $ref: '#/components/schemas/PaymentMethodStatus'
flags:
allOf:
- $ref: '#/components/schemas/PaymentMethodFlags'
PaymentSetupPhone:
type: object
description: The customer's phone number.
properties:
country_code:
maxLength: 7
minLength: 1
type: string
description: |
The phone number's international country calling code.
example: '+44'
number:
maxLength: 25
minLength: 6
type: string
description: The phone number.
example: 207 946 0000
PaymentSetupPresentmentDetails:
type: object
description: |
The amount and currency to present to the customer, when the settlement
currency differs from the customer-facing currency.
properties:
amount:
type: integer
format: int64
description: The presentment amount, in the minor currency unit.
example: 110
currency:
type: string
description: The presentment currency, as a three-letter ISO currency code.
example: EUR
PaymentSetupResponse:
allOf:
- required:
- id
type: object
- $ref: '#/components/schemas/PaymentSetup'
PaymentSetupShipping:
type: object
description: The customer's shipping details.
properties:
first_name:
type: string
description: The customer's first name.
maxLength: 50
example: Jane
last_name:
type: string
description: The customer's last name.
maxLength: 50
example: Doe
email:
type: string
description: The customer's email address.
maxLength: 100
example: jane.doe@example.com
phone:
allOf:
- $ref: '#/components/schemas/PaymentSetupPhone'
address:
allOf:
- $ref: '#/components/schemas/PaymentSetupAddress'
method:
type: string
description: |
The shipping method the customer selected.
For more information on which values you can specify, refer to the payment method's external API reference.
delay:
type: integer
description: The number of days between the order date and the expected delivery date.
example: 3
minimum: 0
maximum: 365
PaymentSetupSubMerchant:
type: object
description: Details about a sub-merchant in the order.
properties:
id:
type: string
description: The unique identifier for the sub-merchant.
example: SUB12345
product_category:
type: string
description: The product category for the sub-merchant.
example: Electronics
number_of_sales:
type: integer
description: The number of orders the sub-merchant has processed.
example: 500
registration_date:
type: string
description: The date the sub-merchant was registered.
format: date
example: '2023-01-15'
PaymentSetupTerminal:
type: object
description: Terminal details.
properties:
id:
type: string
description: Terminal identifier.
maxLength: 8
minLength: 8
example: '12345678'
local_date_time:
type: string
format: date-time
description: The local date and time on the terminal, in ISO 8601 format.
example: '2026-05-26T13:05:14+01:00'
PaymentSetupValidationError:
type: object
description: The validation errors flagged with the request.
properties:
request_id:
type: string
description: The unique identifier of the flagged request.
example: 0HL80RJLS76I7
error_type:
type: string
description: The type of error flagged.
example: request_invalid
error_codes:
type: array
description: The error codes returned by the failed request.
items:
type: string
example: amount_required
PayNow:
description: The PayNow payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
PayPal:
description: The PayPal payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- $ref: '#/components/schemas/PaymentMethodInitialization'
- type: object
properties:
user_action:
type: string
description: |
The user action for the PayPal widget.
- `pay_now` - After the customer clicks the PayPal button, the customer is redirected to a page to enter payment details and immediately directed to finalize the payment.
- `continue` - After the customer clicks the PayPal button, the customer is redirected to a page to enter payment details and then redirected back to the merchant's site to review and finalize the payment.
enum:
- pay_now
- continue
example: pay_now
brand_name:
type: string
description: The brand name to display in the PayPal checkout experience.
maxLength: 127
example: Acme Corporation
shipping_preference:
type: string
description: |
Where to obtain the shipping information.
- `no_shipping` - Redacts the shipping address from the PayPal pages.
- `get_from_file` - Obtains the shipping address from the customer's PayPal account.
- `set_provided_address` - Uses the shipping address provided by the merchant.
enum:
- no_shipping
- get_from_file
- set_provided_address
example: no_shipping
action:
type: object
readOnly: true
description: The next available action for the payment method.
properties:
type:
type: string
description: The type of action.
example: sdk
enum:
- sdk
order_id:
type: string
description: The PayPal order ID to use with the PayPal SDK.
example: dd4b1a85-31de-404b-99f4-f143f8ba35ba
Qpay:
description: The QPay payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
national_id:
type: string
writeOnly: true
description: The Qatari national ID. Must start with 2 or 3, followed by 10 digits.
example: '21234567890'
description:
type: string
description: A description of the payment order. Alphanumeric characters only.
maxLength: 255
Sepa:
description: The SEPA payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
account_holder:
type: object
description: The account holder details.
properties:
type:
type: string
description: The type of account holder.
enum:
- individual
- corporate
first_name:
type: string
description: The first name of the account holder.
last_name:
type: string
description: The last name of the account holder.
company_name:
type: string
description: The legal name of a registered company that holds the account.
account_number:
writeOnly: true
type: string
description: The account holder's IBAN.
country:
type: string
description: The account's country, as an ISO 3166-1 alpha-2 code.
minLength: 2
maxLength: 2
currency:
type: string
description: The account holder's account currency.
mandate:
type: object
description: The mandate details.
properties:
id:
type: string
description: The ID of the mandate.
type:
type: string
description: The type of mandate.
enum:
- core
- b2b
date_of_signature:
type: string
format: date
description: The date the mandate was signed.
Sequra:
description: The Sequra payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
Stablecoin:
description: The Stablecoin payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
StcPay:
description: The stc pay payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- $ref: '#/components/schemas/PaymentMethodInitialization'
- type: object
properties:
otp:
type: string
writeOnly: true
description: The one-time password (OTP) for stc pay.
example: '123456'
action:
type: object
readOnly: true
description: The next available action for the payment method.
properties:
type:
type: string
enum:
- otp
description: The type of action.
Swish:
description: The Swish payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
billing_descriptor:
type: string
description: A description that appears on the customer's billing statement.
account_holder:
type: object
description: The account holder's details.
properties:
first_name:
type: string
description: The account holder's first name.
minLength: 1
example: John
last_name:
type: string
description: The account holder's last name.
minLength: 1
example: Smith
Tabby:
description: The Tabby payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- $ref: '#/components/schemas/PaymentMethodInitialization'
- type: object
properties:
payment_types:
type: array
description: The available payment types for Tabby (For example, `installments`).
items:
type: string
example:
- pay_later
Tamara:
description: The Tamara payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
TerminalType:
type: string
enum:
- web
- wap
- app
description: The client-side terminal type. Indicates whether the customer is using a PC browser, mobile browser, or mobile application.
example: web
Tng:
description: The TNG payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
terminal_type:
allOf:
- $ref: '#/components/schemas/TerminalType'
os_type:
allOf:
- $ref: '#/components/schemas/OsType'
TrueMoney:
description: The TrueMoney payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
properties:
terminal_type:
allOf:
- $ref: '#/components/schemas/TerminalType'
os_type:
allOf:
- $ref: '#/components/schemas/OsType'
Twint:
description: The Twint payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
Vipps:
description: The Vipps payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
WeChatPay:
description: The WeChatPay payment method's details and configuration.
allOf:
- $ref: '#/components/schemas/PaymentSetupPaymentMethod'
- type: object
Shipping:
type: object
description: The shipping details.
properties:
first_name:
type: string
description: The first name of the person receiving the goods or the service.
example: 'John'
maxLength: 300
last_name:
type: string
description: The last name of the person receiving the goods or the service.
example: 'Smith'
maxLength: 300
email:
type: string
description: The email address associated with the shipping order.
example: 'john.smith@example.com'
maxLength: 255
address:
description: The shipping address.
allOf:
- $ref: '#/components/schemas/Address'
phone:
description: The phone number associated with the shipping address.
allOf:
- $ref: '#/components/schemas/PhoneNumber'
from_address_zip:
type: string
description: The postal code or zip code of the location being shipped from.
example: '123456'
maxLength: 10
timeframe:
type: string
description: Indicates the merchandise delivery timeframe. The following values will be supported by Checkout.com, otherwise your specific value will be passed through to the provider.
enum:
- ElectronicDelivery
- SameDay
- Overnight
- TwoDayOrMore
example: 'SameDay'
method:
type: string
description: Indicates the shipping method chosen for the transaction. The following values will be supported by Checkout.com, otherwise your specific value will be passed through to the provider.
enum:
- Digital
- PickUp
- BillingAddress
- OtherAddress
example: 'BillingAddress'
delay:
type: integer
description: The number of days by which the shipping is delayed.
example: 5
minimum: 0
Subscription:
type: object
title: Subscription
description: The details of the subscription.
properties:
id:
type: string
description: The ID or reference linking a series of recurring payments together.
maxLength: 50
TrackingInfo:
type: object
properties:
return_shipping_company:
description: Name of the shipping company for the return shipment (as specific as possible).
maxLength: 100
type: string
example: DHL US
return_tracking_number:
description: Tracking number for the return shipment.
maxLength: 100
type: string
example: GM275322484009027685
return_tracking_uri:
description: URL where the customer can track the return shipment.
maxLength: 1024
type: string
example: https://example.com/tracking/GM275322484009027685
shipping_company:
description: Name of the shipping company (as specific as possible)
maxLength: 100
type: string
example: DHL US
tracking_number:
description: Tracking number for the shipment.
maxLength: 100
type: string
example: GM275322484009027685
tracking_uri:
description: URI where the customer can track their shipment.
maxLength: 1024
type: string
example: https://example.com/tracking/GM275322484009027685
TrustedListing:
type: object
title: TrustedListing
description: The details of the trusted listing status of the merchant
properties:
status:
type: string
description: >
Enables the communication of trusted beneficiary status between the Access Control Server (ACS), the Directory Server (DS), and the 3D Secure (3DS) Requestor.
• Y = 3DS Requestor is allowlisted by cardholder
• N = 3DS Requestor is not allowlisted by cardholder
• E = Not eligible as determined by issuer
• P = Pending confirmation by cardholder
• R = Cardholder rejected
• U = Allowlist status unknown, unavailable, or does not apply
enum:
- Y
- N
- E
- P
- R
- U
example: Y
source:
type: string
description: >
The system setting trusted beneficiary status
• 01 = 3DS Server
• 02 = DS
• 03 = ACS
• 80-99 = DS-specific values
example: '01'
UnreferencedRefundRequest:
title: Unreferenced Refund
type: object
required:
- source
- destination
- amount
- currency
- payment_type
- processing_channel_id
properties:
source:
type: object
description: The source of the unreferenced refund.
required:
- type
- id
properties:
type:
type: string
description: The unreferenced refund source type.
enum:
- currency_account
id:
type: string
description: The ID of the currency account that will fund the unreferenced refund.
pattern: '^(ca)_(\w{26})$'
maxLength: 29
minLength: 29
destination:
$ref: '#/components/schemas/UnreferencedRefundRequestDestination'
instruction:
type: object
description: Additional details about the unreferenced refund instruction.
properties:
funds_transfer_type:
type: string
description: |
**Required** if `processing.processing_speed` is `fast`.
Value of this field should be based on the destination card scheme:
- For Visa, use `MI`
- For Mastercard, use `C60`
purpose:
type: string
description: |
The purpose of the unreferenced refund.
This field is required if the card's `issuer_country` is one of:
- `AR` (Argentina)
- `BD` (Bangladesh)
- `CL` (Chile)
- `CO` (Colombia)
- `EG` (Egypt)
- `IN` (India)
- `MX` (Mexico)
To view a card's `issuer_country`, [retrieve the card's metadata](https://api-reference.checkout.com/#operation/requestCardMetadata!c=200&path=issuer_country&t=response).
enum:
- family_support
- expatriation
- travel_and_tourism
- education
- medical_treatment
- emergency_need
- leisure
- savings
- gifts
- donations
- financial_services
- it_services
- investment
- insurance
- loan_payment
- pension
- royalties
- other
- income
amount:
description: 'The amount in minor currency'
allOf:
- $ref: '#/components/schemas/Amount'
- minimum: 1
maximum: 9999999999
currency:
type: string
description: The three-letter ISO currency code of the payment.
example: GBP
maxLength: 3
minLength: 3
payment_type:
type: string
description: The type of the payment
enum: ['UnreferencedRefund']
processing_channel_id:
type: string
pattern: "^(pc)_(\\w{26})$"
description: The processing channel identifier
reference:
type: string
description: An internal reference you can later use to identify this payment
metadata:
type: object
description: |
A set of key-value pairs that you can attach to the refund request. It can be useful for storing additional information in a structured format. **Note**: This object only allows one level of depth, so cannot accept non-primitive data types such as objects or arrays.
example:
coupon_code: 'NY2018'
partner_id: 123989
previous_payment_id:
type: string
description: |
The previous related payment identifier. This could be the ID of the payment that you want to refund.
example: 'pay_fun26akvvjjerahhctaq2uzhu4'
segment:
$ref: '#/components/schemas/Segment'
processing:
type: object
description: Returns information related to the processing of the payment.
properties:
processing_speed:
type: string
description: |
The speed at which the unreferenced refund is processed.
Only applicable for unreferenced refunds.
enum:
- "fast"
VoidAcceptedResponse:
type: object
description: Void response
required:
- action_id
properties:
action_id:
description: The unique identifier for the void action
allOf:
- $ref: '#/components/schemas/ActionId'
reference:
type: string
description: Your reference for the void request
example: 'ORD-5023-4E89'
_links:
type: object
description: The links related to the void
readOnly: true
minItems: 2
properties:
payment:
type: object
allOf:
- $ref: '#/components/schemas/Link'
example:
href: 'https://{prefix}.api.checkout.com/payments/pay_y3oqhf46pyzuxjbcn2giaqnb44'
required:
- payment
VoidRequest:
type: object
properties:
reference:
type: string
description: A reference you can later use to identify this void request.
For Amex, the string limit is 30 characters.
maxLength: 80
example: 'ORD-5023-4E89'
metadata:
type: object
description: |
A set of key-value pairs to attach to the authorization request. You can use this to store additional information in a structured format.
The `metadata` object only supports primitive data types. Objects and arrays are not supported.
example:
coupon_code: 'NY2018'
partner_id: 123989
BankPayout:
title: Bank payout
type: object
properties:
id:
type: string
description: The unique identifier of the payout.
example: pay_mbabizu24mvu3mela5njyhpit4
requested_on:
type: string
description: 'The UTC date and time the payment was requested, in ISO 8601 format.'
example: '2023-08-24T14:15:22Z'
destination:
type: object
properties:
type:
type: string
description: The payout destination type.
example: bank_account
id:
type: string
description: The unique identifier of the payment instrument.
example: src_4pakgjwmv5re5m5ivqohsqpxnm
bank_code:
type: string
description: The code that identifies the bank.
example: 123-456
branch_code:
type: string
description: The code that identifies the bank branch.
example: '6443'
iban:
type: string
description: The International Bank Account Number (IBAN) of the account.
example: HU93116000060000000012345676
country:
type: string
description: 'The country where the account is based, as a [two-letter ISO country code](https://www.checkout.com/docs/developer-resources/codes/country-codes).'
example: GB
account_holder:
type: object
properties:
first_name:
type: string
description: The account holder's first name.
example: Jia
last_name:
type: string
description: The account holder's last name.
example: Tsang
description: The account holder's details.
description: The destination of the payout.
amount:
type: number
description: The original payout amount.
example: 10000
currency:
type: string
description: 'The currency of the payout, as a [three-letter ISO currency code](https://www.checkout.com/docs/developer-resources/codes/currency-codes).'
example: GBP
reference:
type: string
description: The reference for the payout.
example: ORD-5023-4E89
billing_descriptor:
type: object
properties:
reference:
type: string
description: The reference displayed on the payout recipient's bank statement.
example: BANK-REF
description: The billing descriptor details.
status:
type: string
description: The status of the payout.
example: Pending
processing_channel_id:
type: string
description: The unique identifier of the processing channel that was used for the payout.
example: pc_vxt6yftthv4e5flqak6w2i7rim
sender:
type: object
properties:
first_name:
type: string
description: The sender's first name.
example: Ali
last_name:
type: string
description: The sender's last name.
example: Farid
description: The payout sender's details.
actions:
type: array
items:
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: '^(act)_(\w{26})$'
type: string
description: The unique identifier of the payment action.
type:
enum:
- Payout
- Return
type: string
description: The type of action.
processed_on:
type: string
description: The date and time the action was processed.
format: date-time
response_code:
type: string
description: The response code.
response_summary:
type: string
description: The response summary.
reference:
type: string
description: The reference for the payout.
example:
- type: Return
processed_on: '2023-08-24T14:15:25.3448464+00:00'
status: Returned
- id: act_m4wvaqkqdzferpgpw32ykoxvuq
type: Payout
processed_on: '2023-08-24T14:15:23.3448464+00:00'
status: Approved
response_code: '10000'
response_summary: Approved
- id: act_4crmhihaknzuvhjclvxu7bni24
type: Payout
processed_on: '2023-08-24T14:15:22.3448464+00:00'
status: Pending
reference: fd45gyh7-6y74-3gt6-bb3d-fd167854bc3c
BankPayoutResponse:
title: BankPayout Response
type: object
properties:
data:
type: array
items:
anyOf:
- $ref: '#/components/schemas/BankPayout'
_links:
$ref: '#/components/schemas/Links'
CardPayout:
title: Card payout
type: object
properties:
id:
type: string
description: The unique identifier of the payout.
example: pay_mbabizu24mvu3mela5njyhpit4
requested_on:
type: string
description: 'The UTC date and time the payment was requested, in ISO 8601 format.'
example: '2023-08-24T14:15:22Z'
destination:
type: object
properties:
type:
type: string
description: The payout destination type.
example: card
id:
type: string
description: The unique identifier of the payment source.
example: ca_y3oqhf46pyzuxjbcn2giaqnb44
expiry_year:
type: string
description: The card expiration year.
example: '2024'
expiry_month:
type: string
description: The card expiration month.
example: '04'
account_holder:
type: object
properties:
first_name:
type: string
description: "The account holder's first name.\n\nThis field is only returned if `destination.account_holder.type` is `individual`.\n"
example: Jia
last_name:
type: string
description: "The account holder's last name.\n\nThis field is only returned if `destination.account_holder.type` is `individual`.\n"
example: Tsang
description: The account holder's details.
scheme:
type: string
description: The card scheme.
example: Visa
last4:
type: string
description: The last four digits of the card number.
example: '1212'
issuer:
type: string
description: The issuer name.
example: issuer
issuer_country:
type: string
description: 'The issuer country, as a [two-letter ISO country code](https://www.checkout.com/docs/developer-resources/codes/country-codes).'
example: issuer
description: The destination of the payout.
amount:
type: number
description: The original payout amount.
example: 10000
currency:
type: string
description: 'The currency of the payout, as a [three-letter ISO currency code](https://www.checkout.com/docs/developer-resources/codes/currency-codes).'
example: GBP
reference:
type: string
description: The reference for the payout.
example: ORD-5023-4E89
billing_descriptor:
type: object
properties:
reference:
type: string
description: The reference displayed on the payout recipient's bank statement.
example: CARD-REF
description: The billing descriptor details.
status:
type: string
description: The status of the payout.
example: Paid
processing_channel_id:
type: string
description: The unique identifier of the processing channel that was used for the payout.
example: pc_vxt6yftthv4e5flqak6w2i7rim
sender:
type: object
properties:
type:
type: string
description: "The sender type. \n\nThis field is only returned for payout requests for some [funds transfer types](https://www.checkout.com/docs/payments/request-payouts/card-payouts#Fund_Transfer_Types).\n"
example: individual
first_name:
type: string
description: "The sender's first name.\n\nThis field is only returned if `sender.type` is `individual`.\n"
example: Ali
last_name:
type: string
description: "The sender's last name.\n\nThis field is only returned if `sender.type` is `individual`.\n"
example: Farid
description: The payout sender's details.
metadata:
type: object
description: 'A set of key-value pairs attached to the payout, used to store additional information.'
actions:
type: array
items:
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: '^(act)_(\w{26})$'
type: string
description: The unique identifier of the payment action.
type:
enum:
- Payout
type: string
description: The type of action.
processed_on:
type: string
description: The date and time the action was processed.
format: date-time
processing:
type: object
properties:
acquirer_reference_number:
type: string
description: A unique identifier for the payout that is submitted to the card scheme during processing.
response_code:
type: string
description: The response code.
response_summary:
type: string
description: The response summary.
reference:
type: string
description: The reference for the payout.
sanction_screening:
type: string
description: The outcome of sanction screening.
example:
- id: act_obwnktnk6i2e5bcp5i7xq673se
type: Payout
processed_on: '2023-08-24T14:15:23.3448464+00:00'
status: Approved
response_code: '10000'
response_summary: Approved
sanction_screening: Pass
processing:
acquirer_reference_number: '232810098064'
- id: act_rdqbtrhinozuza3wbnhi3n7noa
type: Payout
processed_on: '2023-08-24T14:15:22.3448464+00:00'
status: Pending
reference: fd45gyh7-6y74-3gt6-bb3d-fd167854bc3c
CardPayoutResponse:
title: CardPayout Response
type: object
properties:
data:
type: array
items:
anyOf:
- $ref: '#/components/schemas/CardPayout'
_links:
$ref: '#/components/schemas/Links'
Links:
title: Links
type: object
description: Links related to the search.
properties:
next:
type: object
maxLength: 2048
minLength: 1
allOf:
- $ref: '#/components/schemas/Link'
description: |
A link to the next page of results, if the search returned more results than the value specified in `limit`.
Pagination links expire after 24 hours. If you attempt to access the link after this time, you receive a `404 Not Found` response code.
example:
next:
href: 'https://{prefix}.api.checkout.com/payments/search/nGd7-altGkOfSl3fJptLxA?token=MTc0MDUwMjE2MjQxOCxlN2NiNTdmYy04MDA5LTQ3YmMtOTYzNi0zNDEyOWRmZTkwZTI'
Payin:
title: Payin
type: object
properties:
id:
type: string
description: The unique identifier of the payment.
example: pay_mbabizu24mvu3mela5njyhpit4
requested_on:
type: string
description: 'The UTC date and time the payment was requested, in ISO 8601 format.'
example: '2023-08-24T14:15:22Z'
source:
type: object
properties:
type:
type: string
description: "The payment source type. \n\nFor payment request sources that result in a card token, this will be `card`. For example, a token or source ID.\n"
example: card
expiry_month:
type: string
description: The card expiration month.
example: '04'
expiry_year:
type: string
description: The card expiration year.
example: '2024'
name:
type: string
description: The cardholder's name.
example: Jia Tsang
scheme:
type: string
description: The card scheme.
example: Visa
local_schemes:
type: array
items:
type: string
description: The local co-branded card scheme.
example:
- cartes bancaires
last4:
type: string
description: The last four digits of the card number.
example: '3131'
fingerprint:
type: string
description: "The card's unique fingerprint.\n\nYou can use the card fingerprint to compare cards across customers.\n"
example: B16D9C2EF0C861A8825C9BD59CCE9171D84EBC45E89CC792B5D1D2D0DDE3DAB7
bin:
type: string
description: The card issuer's Bank Identification Number (BIN).
example: '313131'
card_type:
type: string
description: The card type.
example: credit
card_wallet_type:
type: string
description: The card wallet type.
example: googlepay
issuer:
type: string
description: The card issuer.
example: 'GE CAPITAL FINANCIAL, INC'
issuer_country:
type: string
description: 'The issuer country, as a [two-letter ISO country code](https://www.checkout.com/docs/developer-resources/codes/country-codes).'
example: US
avs_check:
type: string
description: The result of the Address Verification System (AVS) check.
example: G
description: The source of the payment.
amount:
type: number
description: The original payment amount.
example: 10000
amount_requested:
type: number
description: 'The full amount from the original authorization, if a partial authorization was requested.'
example: 10000
currency:
type: string
description: 'The currency of the payment, as a [three-letter ISO currency code](https://www.checkout.com/docs/developer-resources/codes/currency-codes).'
example: GBP
payment_type:
type: string
description: "The type of payment.\n\nThis field is returned for card payments where the cardholder was not present. For example, recurring payments or mail order / telephone order (MOTO) payments.\n"
example: regular
processing_channel_id:
type: string
description: The unique identifier of the processing channel that was used for the payment.
example: pc_vxt6yftthv4e5flqak6w2i7rim
reference:
type: string
description: The reference for the payment.
example: ORD-5023-4E89
status:
type: string
description: The status of the payment.
example: captured
balances:
type: object
properties:
total_authorized:
type: number
description: The total amount that was authorized.
example: 200
total_captured:
type: number
description: The total amount that was captured.
example: 150
total_refunded:
type: number
description: The total amount that was refunded.
example: 50
description: The payment's balances.
3ds:
type: object
properties:
eci:
type: string
description: The Electronic Commerce Indicator (ECI).
example: '02'
version:
type: string
description: The version of 3DS that was used for authentication.
example: '2.1.0'
description: Details relating to payments processed with 3D Secure (3DS).
risk:
type: object
properties:
flagged:
type: boolean
description: Specifies whether the payment was flagged by a risk check.
example: false
score:
type: string
description: "The risk score calculated by our Fraud Detection engine.\n\nThis field is only returned if sufficient data was provided to Fraud Detection.\n"
example: '22'
description: The payment's risk assessment results.
customer:
type: object
properties:
email:
type: string
description: The customer's email address.
example: jia.tsang@checkout.com
name:
type: string
description: The customer's name.
example: Jia Tsang
description: The customer linked to the payment.
billing_descriptor:
type: object
properties:
name:
type: string
description: The reference displayed on the customer's bank statement.
example: Purchase
city:
type: string
description: The city from which the payment originated.
example: London
description: "An optional description displayed on the customer's statement identifying a purchase.\n\nApplies to card payments only.\n"
metadata:
type: object
description: 'A set of key-value pairs attached to the payout, used to store additional information.'
actions:
type: array
items:
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: '^(act)_(\w{26})$'
type: string
description: 'The unique identifier of the payment action, including authentication and disputes.'
type:
enum:
- Authentication
- Authorization
- Card Verification
- Void
- Capture
- Partial Capture
- Partial Refund
- Refund
- Cancelation
- Request
- Pending
- Dispute
type: string
description: The type of action.
status:
type: string
description: The action outcome.
processed_on:
type: string
description: The date and time the action was processed.
format: date-time
amount:
type: integer
description: The action amount in minor currency units.
auth_code:
type: string
description: The issuer authorization code for cards.
response_code:
type: string
description: The response code.
response_summary:
type: string
description: The response summary.
reference:
type: string
description: Your reference for the action.
processing:
type: object
properties:
acquirer_reference_number:
type: string
description: A unique identifier for the capture that is submitted to the card scheme during processing.
fraud_score:
type: string
description: The risk score calculated by our Fraud Detection engine. This field is only returned if sufficient data was provided to Fraud Detection.
response_status_reason:
type: string
description: The reason for the response status. This is only available as a result of a 3DS2 authentication.
authentication_experience:
type: string
description: The authentication type used.
reason_code:
type: string
description: The reason code provided by the card scheme. This only applies to disputes.
example:
- id: act_egiv5753bwmexj6ip3tlpog6gq
type: Dispute
processed_on: '2023-08-25T14:15:24Z'
status: Evidence Required
amount: 1310
reason_code: '13.1'
- id: act_i3cd3w3lcooexmyrtlgulk3d7a
type: Capture
processed_on: '2023-08-24T14:15:26Z'
status: Approved
amount: 1310
auth_code: '983647'
response_code: '10000'
response_summary: Approved
reference: REF-7HR-IYW
processing:
acquirer_reference_number: '25651432189281252509653'
- id: act_2uwlm6xyeszerhroqhfnotmiwu
type: Authorization
processed_on: '2023-08-24T14:15:25Z'
status: Approved
amount: 1310
auth_code: '983647'
response_code: '10000'
response_summary: Approved
reference: REF-7HR-IYW
processing:
acquirer_reference_number: '25651432189281252509653'
- id: act_mscwxewzdldefh2rbbnhm6aeqi
type: Authorization
processed_on: '2023-08-24T14:15:24Z'
status: Pending
amount: 1310
reference: REF-7HR-IYW
- id: act_qocmjw6skb4u3c4wd3avpot64y
type: Authentication
processed_on: '2023-08-24T14:15:34Z'
status: Approved
authentication_experience: 3ds
authentication_transaction_id: f05af960-f718-428d-b856-068f6cb9a3b4
- id: act_qocmjw6skb4u3c4wd3avpot64y
type: Authentication
processed_on: '2023-08-24T14:15:22Z'
status: Pending
reference: REF-7HR-IYW
PayinResponse:
title: Payin Response
type: object
properties:
data:
type: array
items:
anyOf:
- $ref: '#/components/schemas/Payin'
_links:
$ref: '#/components/schemas/Links'
SearchError:
title: Search error
type: object
properties:
request_id:
type: string
example: 0HL80RJLS76I7
error_type:
type: string
example: request_invalid
error_codes:
type: array
items:
type: string
example: unknown_attribute
SearchRequest:
title: Search request
type: object
properties:
query:
maxLength: 1024
type: string
description: "The query string.\n\nFor more information on how to build out your query, see the Search and filter payments documentation."
example: id:'pay_mbabizu24mvu3mela5njyhpit4'
limit:
maximum: 1000
minimum: 1
type: integer
description: The number of results to return per page.
default: 10
example: 10
from:
type: string
description: The UTC date and time for the query start in ISO 8601 format. Required if `to` is provided.
example: '2023-08-24T14:15:22Z'
to:
type: string
description: The UTC date and time for the query end in ISO 8601 format. Required if `from` is provided.
example: '2023-08-24T14:15:22Z'
CreateAndSubmitPaymentSessionsActionRequiredResponse:
type: object
required:
- id
- status
- type
- action
- payment_session_id
- payment_session_secret
description: Response for an action required payment session payment.
properties:
id:
allOf:
- $ref: '#/components/schemas/PaymentId'
status:
type: string
description: The payment's status.
enum:
- Action Required
type:
type: string
description: The payment method name.
allOf:
- $ref: '#/components/schemas/PaymentInterfacesPaymentMethod'
action:
type: object
description: Instruction for further payment action.
payment_session_id:
allOf:
- $ref: '#/components/schemas/PaymentSessionId'
payment_session_secret:
allOf:
- $ref: '#/components/schemas/PaymentSessionSecret'
CreateAndSubmitPaymentSessionsProcessedResponse:
type: object
required:
- id
- status
- type
properties:
id:
allOf:
- $ref: '#/components/schemas/PaymentId'
status:
type: string
description: The payment's status.
enum:
- Approved
- Declined
type:
type: string
description: The payment method name.
allOf:
- $ref: '#/components/schemas/PaymentInterfacesPaymentMethod'
discriminator:
propertyName: status
mapping:
Approved: '#/components/schemas/CreateAndSubmitPaymentSessionsProcessedResponseStatusApproved'
Declined: '#/components/schemas/CreateAndSubmitPaymentSessionsProcessedResponseStatusDeclined'
CreateAndSubmitPaymentSessionsProcessedResponseStatusApproved:
type: object
required:
- id
- status
- type
- payment_session_id
- payment_session_secret
description: Response for an approved payment session payment.
allOf:
- $ref: '#/components/schemas/CreateAndSubmitPaymentSessionsProcessedResponse'
- type: object
properties:
status:
type: string
enum: [Approved]
description: The payment was approved.
payment_session_id:
allOf:
- $ref: '#/components/schemas/PaymentSessionId'
payment_session_secret:
allOf:
- $ref: '#/components/schemas/PaymentSessionSecret'
CreateAndSubmitPaymentSessionsProcessedResponseStatusDeclined:
type: object
required:
- id
- status
- type
- decline_reason
description: Response for a declined payment session payment.
allOf:
- $ref: '#/components/schemas/CreateAndSubmitPaymentSessionsProcessedResponse'
- type: object
properties:
status:
type: string
enum: [Declined]
description: The payment was declined.
decline_reason:
type: string
description: The reason for the payment decline.
CreateAndSubmitPaymentSessionsRequest:
type: object
allOf:
# Keep this first to ensure session_data comes first in the request body
- type: object
required:
- session_data
properties:
session_data:
allOf:
- $ref: '#/components/schemas/PaymentSessionsSessionData'
- $ref: '#/components/schemas/CreatePaymentSessionsBaseRequest'
CreatePaymentSessionsBaseRequest:
type: object
required:
- amount
- currency
- billing
- success_url
- failure_url
properties:
amount:
allOf:
- $ref: '#/components/schemas/PaymentSessionsAmount'
currency:
allOf:
- $ref: '#/components/schemas/PaymentSessionCurrency'
payment_type:
allOf:
- $ref: '#/components/schemas/PaymentSessionPaymentType'
authorization_type:
type: string
description: The authorization type.
enum:
- Final
- Estimated
default: Final
example: 'Estimated'
billing:
allOf:
- $ref: '#/components/schemas/PaymentSessionBilling'
billing_descriptor:
allOf:
- $ref: '#/components/schemas/PaymentSessionsBillingDescriptor'
reference:
allOf:
- $ref: '#/components/schemas/PaymentInterfacesReference'
description:
maxLength: 100
example: Payment for gold necklace
description: A description for the payment.
type: string
customer:
allOf:
- $ref: '#/components/schemas/PaymentSessionCustomer'
shipping:
allOf:
- $ref: '#/components/schemas/PaymentSessionShipping'
recipient:
allOf:
- $ref: '#/components/schemas/PaymentInterfacesRecipient'
processing:
allOf:
- $ref: '#/components/schemas/PaymentInterfacesProcessing'
instruction:
type: object
description: Details about the payment instruction.
properties:
purpose:
allOf:
- $ref: '#/components/schemas/Purpose'
processing_channel_id:
allOf:
- $ref: '#/components/schemas/PaymentSessionProcessingChannelId'
items:
allOf:
- $ref: '#/components/schemas/PaymentSessionsItems'
amount_allocations:
description: The sub-entities that the payment is being processed on behalf of.
minItems: 1
maxItems: 50
type: array
items:
description: The sub-entities that the payment is being processed on behalf of.
type: object
properties:
id:
description: The sub-entity's ID.
type: string
amount:
type: integer
description: The split amount, in minor currency units. The sum of all split amounts must be equal to the payment amount. The split amount will be credited to your sub-entity's currency account.
minimum: 0
example: 1
reference:
description: A reference you can use to identify the split. For example, an order number.
maxLength: 50
example: ORD-123A
type: string
commission:
description: |
The commission you'd like to collect from the split, calculated using the formula: `commission = (amount * commission.percentage) + commission.amount`. The commission cannot exceed the split amount. Commission will be credited to your currency account.
type: object
properties:
amount:
type: integer
description: An optional commission to collect, as a fixed amount in minor currency units.
minimum: 0
example: 10
percentage:
description: An optional commission to collect, as a percentage value with up to eight decimal places.
minimum: 0
maximum: 100
example: 12.5
type: number
required:
- id
- amount
risk:
description: Configures the risk assessment performed during payment processing.
type: object
properties:
enabled:
description: Specifies whether to perform a risk assessment.
default: true
example: false
type: boolean
required:
- enabled
display_name:
description: The merchant's display name.
maxLength: 255
type: string
success_url:
allOf:
- $ref: '#/components/schemas/PaymentSessionsSuccessUrl'
failure_url:
allOf:
- $ref: '#/components/schemas/PaymentSessionsFailureUrl'
metadata:
allOf:
- $ref: '#/components/schemas/PaymentSessionMetadata'
locale:
description: Creates a translated version of the page in the specified language.
default: en-GB
type: string
enum:
- ar
- da-DK
- de-DE
- el
- en-GB
- es-ES
- fi-FI
- fil-PH
- fr-FR
- hi-IN
- id-ID
- it-IT
- ja-JP
- ko-KR
- ms-MY
- nb-NO
- nl-NL
- pt-PT
- sv-SE
- th-TH
- vi-VN
- zh-CN
- zh-HK
- zh-TW
3ds:
allOf:
- $ref: '#/components/schemas/PaymentSessions3DS'
sender:
description: The sender of the payment.
type: object
allOf:
- $ref: '#/components/schemas/PaymentInterfacesSender'
capture:
allOf:
- $ref: '#/components/schemas/PaymentSessionCapture/properties/capture'
capture_on:
allOf:
- $ref: '#/components/schemas/PaymentSessionCapture/properties/capture_on'
payment_plan:
allOf:
- $ref: '#/components/schemas/PaymentSessionPaymentPlanRecurring'
CreatePaymentSessionsRequest:
type: object
allOf:
- $ref: '#/components/schemas/CreatePaymentSessionsBaseRequest'
- type: object
properties:
expires_on:
description: A timestamp specifying when the `PaymentSession` should expire, as an ISO 8601 code. If no value is provided, expiry is set to 24 hours after the `PaymentSession` is created. You cannot set the session expiry to more than 60 days after the `PaymentSession` is created.
format: date-time
type: string
example: '2024-01-01T09:15:30Z'
enabled_payment_methods:
allOf:
- $ref: '#/components/schemas/PaymentInterfacesPaymentMethods'
example: ["card", "applepay", "googlepay"]
description: |
Specifies which payment method options to present to the customer.
The values in this field override any equivalent values in `disabled_payment_methods`.
disabled_payment_methods:
allOf:
- $ref: '#/components/schemas/PaymentInterfacesPaymentMethods'
example: ["eps", "ideal", "knet"]
description: |
Specifies which payment method options to not present to the customer.
If you specify the same payment method in this field and in `enabled_payment_methods`, the `disabled_payment_methods` value will be overridden.
Any payment method options not explicitly specified in this field will be presented to the customer by default.
payment_method_configuration:
allOf:
- $ref: '#/components/schemas/PaymentSessionsPaymentMethodConfigurationBase'
- type: object
properties:
applepay:
type: object
properties:
account_holder:
type: object
description: The account holder's details.
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/01_PaymentSessionRequest_AccountHolderIndividual'
corporate: '#/components/schemas/02_PaymentSessionRequest_AccountHolderCorporate'
government: '#/components/schemas/03_PaymentSessionRequest_AccountHolderGovernment'
properties:
type:
type: string
example: 'individual'
total_type:
description: The [type](https://developer.apple.com/documentation/applepayontheweb/applepaylineitemtype) of the Apple Pay payment [total line item](https://developer.apple.com/documentation/applepayontheweb/applepaypaymentrequest/total).
default: final
type: string
enum:
- pending
- final
card:
type: object
properties:
account_holder:
type: object
description: The account holder's details.
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/01_PaymentSessionRequest_AccountHolderIndividual'
corporate: '#/components/schemas/02_PaymentSessionRequest_AccountHolderCorporate'
government: '#/components/schemas/03_PaymentSessionRequest_AccountHolderGovernment'
properties:
type:
type: string
example: 'individual'
googlepay:
type: object
properties:
account_holder:
type: object
description: The account holder's details.
discriminator:
propertyName: type
mapping:
individual: '#/components/schemas/01_PaymentSessionRequest_AccountHolderIndividual'
corporate: '#/components/schemas/02_PaymentSessionRequest_AccountHolderCorporate'
government: '#/components/schemas/03_PaymentSessionRequest_AccountHolderGovernment'
properties:
type:
type: string
example: 'individual'
total_price_status:
description: The status of the Google Pay payment [total price](https://developers.google.com/pay/api/web/reference/request-objects#TransactionInfo).
default: final
type: string
enum:
- estimated
- final
stored_card:
description: Configuration options specific to stored card payments.
type: object
properties:
customer_id:
pattern: ^(cus)_(\w{26})$
description: |
The unique identifier for an existing [customer](https://api-reference.checkout.com/#tag/Customers). Enables the stored card payment method if the customer has one or more payment instruments stored.
This value takes precedence over `payment_method_configuration.stored_card.instrument_ids` when choosing the stored cards to present to the customer.
type: string
instrument_ids:
description: |
The unique identifiers for card instruments. Enables stored card payment method if any exists.
The first valid payment instrument in the list is shown to the customer as the default option.
Alternatively, you can specify a default payment instrument by providing its ID in the `payment_method_configuration.stored_card.default_instrument_id` field.
minItems: 1
maxItems: 10
type: array
items:
pattern: ^(src)_(\w{26})$
type: string
default_instrument_id:
pattern: ^(src)_(\w{26})$
description: The unique identifier for the payment instrument to present to the customer as the default option.
type: string
customer_retry:
description: Configuration for asynchronous retries.
type: object
properties:
max_attempts:
description: The maximum number of authorization retry attempts, excluding the initial authorization.
example: 2
default: 5
minimum: 0
maximum: 5
type: integer
required:
- max_attempts
ip_address:
deprecated: true
description: The Customers IP address. Only IPv4 and IPv6 addresses are accepted.
allOf:
- $ref: '#/components/schemas/IPAddress'
CreatePaymentSessionsResponse:
type: object
properties:
id:
allOf:
- $ref: '#/components/schemas/PaymentSessionId'
payment_session_token:
type: string
description: |
A unique token representing the payment session, which you must provide when you initialize [Flow](https://www.checkout.com/docs/payments/accept-payments/accept-a-payment-on-your-website/get-started-with-flow#Step_2:_Initialize_and_mount_Flow_).
Do not log or store this value.
payment_session_secret:
allOf:
- $ref: '#/components/schemas/PaymentSessionSecret'
_links:
type: object
description: "The links related to the Payment Session."
properties:
self:
type: object
description: "The URI of the Payment Session."
properties:
href:
type: string
description: "The link URL"
example: "https://{prefix}.api.sandbox.checkout.com/payment-sessions/ps_2Un6I6lRpIAiIEwQIyxWVnV9CqQ"
required:
- href
required:
- self
required:
- id
- payment_session_token
- payment_session_secret
- _links
PaymentSessionsRateLimitedResponse:
type: object
properties:
request_id:
type: string
error_type:
type: string
error_codes:
type: array
items:
type: string
required:
- request_id
- error_type
- error_codes
PaymentSessionsValidationErrorResponse:
type: object
properties:
request_id:
type: string
error_type:
type: string
error_codes:
type: array
items:
type: string
required:
- request_id
- error_type
- error_codes
PaymentSessionBilling:
type: object
description: The billing details.
required:
- address
properties:
address:
description: The billing address.
allOf:
- $ref: '#/components/schemas/Address'
required:
- country
phone:
description: The phone number associated with the billing address
allOf:
- $ref: '#/components/schemas/PaymentInterfacesPhoneNumber'
PaymentSessionCapture:
type: object
properties:
capture:
description: Specifies whether to capture the payment, if applicable.
example: true
default: true
type: boolean
capture_on:
description: A timestamp specifying when to capture the payment, as an ISO 8601 code. If a value is provided, `capture` is automatically set to `true`.
format: date-time
type: string
example: '2024-01-01T09:15:30Z'
PaymentSessionCurrency:
description: The three-letter ISO currency code.
type: string
example: USD
maxLength: 3
minLength: 3
PaymentSessionCustomer:
description: The customer's details. Required if `source.type` is `tamara`.
type: object
properties:
email:
format: email
maxLength: 255
example: jia.tsang@example.com
description: The customer's email address. Required if `source.type` is `tamara`.
type: string
name:
maxLength: 255
example: Jia Tsang
description: The customer's name. Required if `source.type` is `tamara`.
type: string
id:
pattern: ^(cus)_(\w{26})$
description: The unique identifier for an existing customer.
type: string
phone:
description: The customer's phone number. Required if `source.type` is `tamara`.
allOf:
- $ref: '#/components/schemas/PaymentInterfacesPhoneNumber'
tax_number:
maxLength: 13
description: The customer's value-added tax (VAT) registration number.
type: string
summary:
allOf:
- $ref: '#/components/schemas/PaymentInterfacesCustomerSummary'
PaymentSessionId:
type: string
pattern: "^(ps)_(\\w{27})$"
description: The Payment Sessions unique identifier
maxLength: 30
minLength: 30
example: "ps_2Un6I6lRpIAiIEwQIyxWVnV9CqQ"
PaymentSessionMetadata:
type: object
description: |
Allows you to store additional information about a transaction with custom fields and up to five user-defined fields, which can be used for reporting purposes. You can supply fields of type `string`, `number`, and `boolean` within the `metadata` object. Arrays and objects are not supported.
You can provide up to 18 metadata fields per API call, but the value of each field must not exceed 255 characters in length.
You can also reference [`metadata` properties](https://www.checkout.com/docs/business-operations/prevent-fraud/understand-fraud-detection#Metadata) in your custom rules for Fraud Detection. For example, `$coupon_code = '1234'`.
example:
coupon_code: 'NY2018'
maxProperties: 18
PaymentSessionPaymentPlanRecurring:
description: The information to process a recurring payment request. To be used when the payment_type is Recurring.
type: object
properties:
amount_variability:
description: Specifies whether the amount is fixed or variable for each recurrence.
type: string
enum:
- Fixed
- Variable
example: Variable
days_between_payments:
description: Indicates the minimum number of days between payments.
type: integer
example: 28
total_number_of_payments:
description: Indicates the agreed total number of payments.
type: integer
example: 5
current_payment_number:
description: The number of the current installment payment.
type: integer
example: 3
expiry:
description: The date after which no further payments will be performed, in the format YYYYMMDD.
type: string
example: '20251031'
name:
description: |
The name of the payment plan.
Required when `source.type` is `blik`. For Blik merchant-initiated requests using an external `partner_agreement_id`, this value is used as the Blik Alias Label.
type: string
maxLength: 35
example: 'Subscription 1234'
start_date:
type: string
description: |
The date on which the first payment will be taken, in `YYYYMMDD` format.
Required when `source.type` is `blik` and the recurring agreement is created without an initial payment (`amount` set to `0`).
example: '20260507'
amount:
type: integer
description: |
The amount to charge for each payment in the plan, in the [minor currency unit](https://www.checkout.com/docs/resources/calculating-the-amount).
Required when `source.type` is `blik`, `payment_plan.amount_variability` is `Fixed`, and the recurring agreement is created without an initial payment (`amount` set to `0`).
minimum: 1
example: 1234
PaymentSessionPaymentType:
description: Must be specified for card-not-present (CNP) payments. For example, a recurring mail order / telephone order (MOTO) payment.
default: Regular
type: string
enum:
- Regular
- Recurring
- MOTO
- Installment
- Unscheduled
PaymentSessionProcessingChannelId:
description: The processing channel to use for the payment.
type: string
pattern: "^(pc)_(\\w{26})$"
PaymentSessions3DS:
type: object
description: Information required for 3D Secure authentication payments.
anyOf:
- $ref: '#/components/schemas/PaymentSessions3DSIntegrated'
- $ref: '#/components/schemas/PaymentSessions3DSThirdParty'
PaymentSessions3DSAccountInfo:
type: object
title: AccountInfo
description: >
Additional information about the cardholder's account
properties:
purchase_count:
type: number
description: >
The number of purchases with this cardholder's account during the last six months
example: 10
minimum: 0
maximum: 9999
account_age:
type: string
description: >
The length of time that the payment account was enrolled in the cardholder's account
enum:
- no_account
- created_during_transaction
- less_than_thirty_days
- thirty_to_sixty_days
- more_than_sixty_days
add_card_attempts:
type: number
description: >
The number of _Add Card_ attempts in the last 24 hours
example: 10
minimum: 0
maximum: 999
shipping_address_age:
type: string
description: >
Indicates when the shipping address for this transaction was first used
enum:
- this_transaction
- less_than_thirty_days
- thirty_to_sixty_days
- more_than_sixty_days
account_name_matches_shipping_name:
type: boolean
description: >
Indicates if the cardholder name on the account is identical to the shipping name used for this transaction
example: true
suspicious_account_activity:
type: boolean
description: >
Indicates whether suspicious activity on the cardholder account has been observed
example: true
transactions_today:
type: number
description: >
The number of transactions (successful and abandoned) for the cardholder account across all payment accounts in the previous 24 hours
minimum: 0
maximum: 999
example: 10
authentication_method:
type: string
description: >
Information about how the cardholder was authenticated before or during the transaction
enum:
- no_authentication
- own_credentials
- federated_id
- issuer_credentials
- third_party_authentication
- fido
cardholder_account_age_indicator:
type: string
description: The length of time the cardholder has held the account with the 3DS Requestor
enum:
- no_account
- this_transaction
- less_than_thirty_days
- thirty_to_sixty_days
- more_than_sixty_days
account_change:
type: string
format: date-time
description: |
The UTC date and time the cardholder’s account with the 3DS Requestor was last changed, in ISO 8601 format.
Changes that affect this value include:
- updating the billing or shipping address
- adding a new payment account
- adding a new user
account_change_indicator:
type: string
description: |
The amount of time since the cardholder’s account information with the 3DS Requestor was last changed.
Changes that affect this value include:
- updating the billing or shipping address
- adding a new payment account
- adding a new user
enum:
- this_transaction
- less_than_thirty_days
- thirty_to_sixty_days
- more_than_sixty_days
account_date:
type: string
format: date-time
description: The UTC date and time the cardholder opened the account with the 3DS Requestor, in ISO 8601 format.
account_password_change:
type: string
format: date-time
description: The UTC date and time the cardholder’s account with the 3DS Requestor was last reset or had a password change, in ISO 8601 format.
account_password_change_indicator:
type: string
description: The amount of time since the cardholder’s account with the 3DS Requestor was last reset or had a password change.
enum:
- no_change
- this_transaction
- less_than_thirty_days
- thirty_to_sixty_days
- more_than_sixty_days
transactions_per_year:
type: integer
description: |
The number of transactions associated with the cardholder's account with the 3DS Requestor in the previous year. This value includes both successful and abandoned transactions, across all payment accounts.
Set this value to `999` if the number of transactions is `1000` or greater.
example: 2
maximum: 999
payment_account_age:
type: string
format: date-time
description: The UTC date and time the payment account was enrolled in the cardholder’s account with the 3DS Requestor, in ISO 8601 format.
shipping_address_usage:
type: string
format: date-time
description: The UTC date and time the shipping address used for the transaction was first used with the 3DS Requestor, in ISO 8601 format.
account_type:
type: string
description: The type of account, in the case of a card product with multiple accounts.
enum:
- not_applicable
- credit
- debit
account_id:
type: string
description: Additional information about the account optionally provided by the 3DS Requestor
maxLength: 64
PaymentSessions3DSIntegrated:
type: object
title: Integrated authentication
description: Required information to process a 3DS authentication with the payment request
discriminator:
propertyName: enabled
mapping:
'false': '#/components/schemas/PaymentSessions3DSIntegratedNonEnabled'
'true': '#/components/schemas/PaymentSessions3DSIntegratedEnabled'
required:
- enabled
properties:
enabled:
type: boolean
description: Whether to process this payment as a 3D Secure payment. Payments where `merchant_initiated` is `true` will be processed as 3DS Requestor Initiated.
example: true
challenge_indicator:
type: string
description: Indicates the preference for whether or not a 3DS challenge should be performed. The customer’s bank has the final say on whether or not the customer receives the challenge.
enum:
- no_preference
- no_challenge_requested
- challenge_requested
- challenge_requested_mandate
default: no_preference
PaymentSessions3DSIntegratedEnabled:
type: object
description: 3DS authentication enabled
required:
- enabled
allOf:
- $ref: '#/components/schemas/PaymentSessions3DSIntegrated'
- type: object
properties:
attempt_n3d:
type: boolean
description: |
Applies only when `3ds.enabled` is set to `true`. Set to `true` to attempt the payment without 3DS when the issuer, card, or network doesn’t support 3DS.
default: false
example: true
exemption:
type: string
enum:
- low_value
- trusted_listing
- trusted_listing_prompt
- transaction_risk_assessment
- data_share
description: Specifies an exemption reason so that the payment is not processed using 3D Secure authentication. Learn more about exemptions in our SCA compliance guide
example: 'low_value'
account_info:
type: object
description: Additional information about the cardholder's account
allOf:
- $ref: '#/components/schemas/PaymentSessions3DSAccountInfo'
PaymentSessions3DSIntegratedNonEnabled:
type: object
description: 3DS authentication not enabled
required:
- enabled
allOf:
- $ref: '#/components/schemas/PaymentSessions3DSIntegrated'
- type: object
properties:
allow_upgrade:
type: boolean
description: Indicates whether to process this payment as 3D Secure if the authorization was soft declined due to 3DS authentication required. For processing channels created before October 12, 2022, the value will default to `false`.
default: true
example: true
exemption:
type: string
enum:
- low_value
- trusted_listing
- trusted_listing_prompt
- transaction_risk_assessment
- 3ds_outage
- sca_delegation
- out_of_sca_scope
- low_risk_program
- recurring_operation
- data_share
- other
description: Specifies an exemption reason so that the payment is not processed using 3D Secure authentication. Learn more about exemptions in our SCA compliance guide
example: 'low_value'
PaymentSessions3DSThirdParty:
type: object
title: Third party authentication
description: Required information to process a payment that has been 3DS authenticated using a Third Party provider
required:
- enabled
- eci
- cryptogram
- xid
- version
properties:
enabled:
type: boolean
description: Whether to process this payment as a 3D Secure payment
enum: [true]
example: true
eci:
type: string
description: The Electronic Commerce Indicator security level associated with the 3D Secure enrollment result. Required if using a third-party merchant plug-in (MPI)
maxLength: 2
example: '05'
cryptogram:
type: string
description: A Base64 encoded cryptographic identifier (CAVV) used by the card schemes to validate the cardholder authentication result (3D Secure). Required if using an external MPI
maxLength: 100
example: AgAAAAAAAIR8CQrXcIhbQAAAAAA=
xid:
type: string
description: The 3D Secure transaction identifier. Required if using an external MPI with 3D Secure 2.X.X and a Mastercard card, or with 3D Secure 1.X.X for any supported card scheme
maxLength: 100
example: MDAwMDAwMDAwMDAwMDAwMzIyNzY=
version:
type: string
description: Indicates the version of 3D Secure that was used for authentication. Defaults to 1.0.0 if not provided
maxLength: 10
example: '2.0.1'
exemption:
type: string
enum:
- low_value
- secure_corporate_payment
- trusted_listing
- transaction_risk_assessment
- 3ds_outage
- sca_delegation
- out_of_sca_scope
- other
- low_risk_program
- recurring_operation
description: Specifies an exemption reason so that the payment is not processed using 3D Secure authentication. Learn more about exemptions in our SCA compliance guide
example: 'low_value'
01_PaymentSessionRequest_AccountHolderIndividual:
type: object
description: The account holder's details.
required:
- type
- first_name
- last_name
properties:
type:
type: string
description: |
The account holder type.
example: 'individual'
first_name:
type: string
description: |
The account holder's first name.
The combination of `first_name`, `middle_name`, and `last_name` should exceed 3 letters in length.
This must be a valid legal name. The following formats for the `first_name` value will return a [field validation error](https://www.checkout.com/docs/developer-resources/codes/error-codes#Field_validation_errors):
- a single character
- all non-alphabetic characters
maxLength: 35
middle_name:
type: string
description: |
The account holder's middle name.
The combination of `first_name`, `middle_name`, and `last_name` should exceed 3 letters in length.
This field is required if the `issuer_country` value returned in the [card metadata](https://api-reference.checkout.com/#operation/requestCardMetadata!c=200&path=issuer_country&t=response) response is `ZA`.
maxLength: 35
last_name:
type: string
description: |
The account holder's last name.
The combination of `first_name`, `middle_name`, and `last_name` should exceed 3 letters in length.
This must be a valid legal name. The following formats for the `last_name` value will return a [field validation error](https://www.checkout.com/docs/developer-resources/codes/error-codes#Field_validation_errors):
- a single character
- all non-alphabetic characters
maxLength: 35
account_name_inquiry:
type: boolean
description: |
Specifies whether to perform an account name inquiry (ANI) check with the scheme.
This is only valid for Visa and Mastercard payments.
02_PaymentSessionRequest_AccountHolderCorporate:
type: object
description: The account holder's details.
required:
- type
- company_name
properties:
type:
type: string
description: The account holder type.
example: 'corporate'
company_name:
type: string
description: |
The account holder's company name.
This must be a valid legal name. The following formats for the `company_name` value will return a [field validation error](https://www.checkout.com/docs/developer-resources/codes/error-codes#Field_validation_errors):
- a single character
- all non-alphabetic characters
maxLength: 35
account_name_inquiry:
type: boolean
description: |
Specifies whether to perform an account name inquiry (ANI) check with the scheme.
This is only valid for Visa and Mastercard payments.
03_PaymentSessionRequest_AccountHolderGovernment:
type: object
description: The account holder's details.
required:
- type
- company_name
properties:
type:
type: string
description: The account holder type.
example: 'government'
company_name:
type: string
description: |
The account holder's company name.
This must be a valid legal name. The following formats for the `company_name` value will return a [field validation error](https://www.checkout.com/docs/developer-resources/codes/error-codes#Field_validation_errors):
- a single character
- all non-alphabetic characters
maxLength: 35
account_name_inquiry:
type: boolean
description: |
Specifies whether to perform an account name inquiry (ANI) check with the scheme.
This is only valid for Visa and Mastercard payments.
PaymentSessionsAmount:
type: integer
description: |
The payment amount. Provide a value of `0` to perform a card verification.
The amount must be provided in the minor currency unit.
minimum: 0
example: 1000
PaymentSessionsBillingDescriptor:
description: A description of the purchase, which is displayed on the customer's statement.
type: object
properties:
name:
description: A description for the payment, which will be displayed on the customer's card statement. Only applicable for card payments.
maxLength: 25
type: string
city:
description: The city from which the payment originated. Only applicable for card payments.
minLength: 1
maxLength: 13
type: string
reference:
description: The reference to display on the customer's bank statement. Required for payouts to bank accounts.
maxLength: 50
type: string
required:
- name
- city
PaymentSessionSecret:
type: string
description: |
The secret used by Flow to authenticate payment session requests.
Do not log or store this value.
example: "pss_9823241e-2cec-4c98-b23d-7b29ow4e2e34"
PaymentSessionsFailureUrl:
format: uri
description: Overrides the default failure redirect URL configured on your account, for payment methods that require a redirect.
maxLength: 1024
example: https://example.com/payments/failure
type: string
PaymentSessionShipping:
type: object
description: The shipping details
properties:
address:
description: The shipping address
allOf:
- $ref: '#/components/schemas/Address'
phone:
description: The phone number associated with the shipping address.
allOf:
- $ref: '#/components/schemas/PaymentInterfacesPhoneNumber'
PaymentSessionsItems:
type: array
description: The line items in the order.
minItems: 1
maxItems: 1000
items:
type: object
properties:
reference:
description: The item reference or product stock keeping unit (SKU).
maxLength: 255
type: string
commodity_code:
description: A code identifying a commodity for value-added tax (VAT) purposes.
maxLength: 12
type: string
unit_of_measure:
description: The unit in which the item is measured, as a Unit of Measure (UoM) code.
maxLength: 12
type: string
total_amount:
type: integer
description: |
The total cost of the line item, in minor currency units. The value should include any tax and discounts applied using the formula: `value = (quantity x unit_price) - discount_amount`.
minimum: 0
example: 1000
tax_amount:
type: integer
description: The total amount of sales tax or value-added tax (VAT) on the total purchase amount. Tax should be included in the total purchase amount.
minimum: 0
example: 1000
discount_amount:
type: integer
description: The discount applied to each invoice line item.
minimum: 0
example: 1000
url:
description: Link to the line item's product page.
maxLength: 1024
type: string
image_url:
description: Link to the line item's product image.
maxLength: 1024
type: string
name:
description: The descriptive name of the line item.
example: Gold Necklace
maxLength: 255
type: string
quantity:
type: integer
description: The number of line items.
minimum: 1
example: 1
unit_price:
type: integer
description: The unit price of the item, in minor currency units.
minimum: 0
example: 1000
required:
- name
- quantity
- unit_price
PaymentSessionsPaymentMethodConfigurationBase:
description: Configurations for payment method-specific settings.
type: object
properties:
applepay:
description: Configuration options specific to Apple Pay payments.
type: object
properties:
store_payment_details:
$ref: '#/components/schemas/PaymentSessionsStorePaymentDetails'
card:
description: Configuration options specific to card payments.
type: object
properties:
store_payment_details:
$ref: '#/components/schemas/PaymentSessionsStorePaymentDetailsCard'
googlepay:
description: Configuration options specific to Google Pay payments.
type: object
properties:
store_payment_details:
$ref: '#/components/schemas/PaymentSessionsStorePaymentDetails'
PaymentSessionsSessionData:
type: string
description: |
A unique token representing the additional customer data captured by Flow, as received from the handleSubmit callback.
Do not log or store this value.
PaymentSessionsStorePaymentDetails:
description: |
Specifies whether you intend to store the cardholder's payment details.
If you set this field to `enabled`, you must:
- have obtained consent from the cardholder to store their payment details
- provide a customer ID or email address in the request
If the request's `payment_type` is set to one of the following values, you do not need to provide this field:
- `Installment`
- `Recurring`
- `Unscheduled`
default: disabled
type: string
enum:
- disabled
- enabled
PaymentSessionsStorePaymentDetailsCard:
description: |
Specifies whether you intend to store the cardholder's payment details.
If you set this field to `enabled` or `collect_consent`, you must:
- Have obtained consent from the cardholder to store their payment details
- Provide `customer.id` or `customer.email` in the request
You do not need to provide this field if `payment_type` is set to one of the following values:
- `Installment`
- `Recurring`
- `Unscheduled`
default: disabled
type: string
enum:
- disabled
- enabled
- collect_consent
PaymentSessionsSuccessUrl:
format: uri
description: Overrides the default success redirect URL configured on your account, for payment methods that require a redirect.
maxLength: 1024
example: https://example.com/payments/success
type: string
SubmitPaymentSessionsActionRequiredResponse:
type: object
required:
- id
- status
- type
- action
description: Response for an action required payment session payment.
properties:
id:
allOf:
- $ref: '#/components/schemas/PaymentId'
status:
type: string
description: The payment's status.
enum:
- Action Required
type:
type: string
description: The payment method name.
allOf:
- $ref: '#/components/schemas/PaymentInterfacesPaymentMethod'
action:
type: object
description: Instruction for further payment action.
SubmitPaymentSessionsProcessedResponse:
type: object
required:
- id
- status
- type
properties:
id:
allOf:
- $ref: '#/components/schemas/PaymentId'
status:
type: string
description: The payment's status.
enum:
- Approved
- Declined
type:
type: string
description: The payment method name.
allOf:
- $ref: '#/components/schemas/PaymentInterfacesPaymentMethod'
discriminator:
propertyName: status
mapping:
Approved: '#/components/schemas/SubmitPaymentSessionsProcessedResponseStatusApproved'
Declined: '#/components/schemas/SubmitPaymentSessionsProcessedResponseStatusDeclined'
SubmitPaymentSessionsProcessedResponseStatusApproved:
type: object
required:
- id
- status
- type
description: Response for an approved payment session payment.
allOf:
- $ref: '#/components/schemas/SubmitPaymentSessionsProcessedResponse'
- type: object
properties:
status:
type: string
enum: [Approved]
description: The payment was approved.
SubmitPaymentSessionsProcessedResponseStatusDeclined:
type: object
required:
- id
- status
- type
- decline_reason
description: Response for a declined payment session payment.
allOf:
- $ref: '#/components/schemas/SubmitPaymentSessionsProcessedResponse'
- type: object
properties:
status:
type: string
enum: [Declined]
description: The payment was declined.
decline_reason:
type: string
description: The reason for the payment decline.
SubmitPaymentSessionsRequest:
type: object
required:
- session_data
properties:
session_data:
allOf:
- $ref: '#/components/schemas/PaymentSessionsSessionData'
amount:
allOf:
- $ref: '#/components/schemas/PaymentSessionsAmount'
currency:
allOf:
- $ref: '#/components/schemas/PaymentSessionCurrency'
billing:
allOf:
- $ref: '#/components/schemas/PaymentSessionBilling'
success_url:
allOf:
- $ref: '#/components/schemas/PaymentSessionsSuccessUrl'
failure_url:
allOf:
- $ref: '#/components/schemas/PaymentSessionsFailureUrl'
payment_type:
allOf:
- $ref: '#/components/schemas/PaymentSessionPaymentType'
billing_descriptor:
allOf:
- $ref: '#/components/schemas/PaymentSessionsBillingDescriptor'
reference:
allOf:
- $ref: '#/components/schemas/PaymentInterfacesReference'
customer:
description: The customer's details.
allOf:
- $ref: '#/components/schemas/PaymentSessionCustomer'
shipping:
allOf:
- $ref: '#/components/schemas/PaymentSessionShipping'
items:
allOf:
- $ref: '#/components/schemas/PaymentSessionsItems'
3ds:
allOf:
- $ref: '#/components/schemas/PaymentSessions3DS'
ip_address:
deprecated: true
description: The Customer's IP address. Only IPv4 and IPv6 addresses are accepted.
allOf:
- $ref: '#/components/schemas/IPAddress'
payment_method_configuration:
allOf:
- $ref: '#/components/schemas/PaymentSessionsPaymentMethodConfigurationBase'
recipient:
allOf:
- $ref: '#/components/schemas/PaymentInterfacesRecipient'
instruction:
type: object
description: Details about the payment instruction.
properties:
purpose:
allOf:
- $ref: '#/components/schemas/Purpose'
processing_channel_id:
allOf:
- $ref: '#/components/schemas/PaymentSessionProcessingChannelId'
metadata:
allOf:
- $ref: '#/components/schemas/PaymentSessionMetadata'
sender:
description: The sender of the payment.
type: object
allOf:
- $ref: '#/components/schemas/PaymentInterfacesSender'
capture:
allOf:
- $ref: '#/components/schemas/PaymentSessionCapture/properties/capture'
capture_on:
allOf:
- $ref: '#/components/schemas/PaymentSessionCapture/properties/capture_on'
processing:
description: Use the processing object to influence or override the data sent during card processing
type: object
allOf:
- $ref: '#/components/schemas/PaymentInterfacesProcessingBase'
PhoneNumber:
type: object
description: A phone number
properties:
country_code:
type: string
description: The international country calling code. Required if `source.type` is `tamara`.
minLength: 1
maxLength: 7
example: '+1'
number:
type: string
description: The phone number. Required if `source.type` is `tamara`.
minLength: 6
maxLength: 25
example: 415 555 2671
EEACompanyFull2-0:
type: object
title: Create & Submit EEA Company (V2.0)
required:
- reference
- company
- contact_details
- profile
- documents
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
default_holding_currency:
title: Main currency
description: The default holding currency code (iso-4217)
format: iso-4217
holding_currencies:
title: Currencies
items:
title: Currency
type: string
enum:
- AED
- AUD
- CAD
- CHF
- CZK
- DKK
- EUR
- GBP
- HKD
- JPY
- NOK
- NZD
- PLN
- RON
- SEK
- SGD
- USD
- ZAR
description: The currency code (iso-4217)
description: Incoming funds are held in your selected currencies
default:
- EUR
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
required:
- phone
- email_addresses
type: object
properties:
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
instruments:
type: array
items:
type: object
readOnly: true
company:
title: Company
required:
- legal_name
- trading_name
- registered_address
- principal_address
- representatives
- business_registration_number
- business_type
- financial_details
type: object
properties:
legal_name:
title: Legal name
maxLength: 300
minLength: 2
type: string
description: The legal name of the sub-entity.
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
business_registration_number:
title: Registration Number
maxLength: 39
minLength: 2
description: The sub-entity's Business Registration Number. This can be a Commercial Registration or Ministry of Commerce certificate number, or any other equivalent registration number. For sub-entities based in France, this must be a SIRET number.
principal_address:
title: Principal Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The primary location of the company where business is performed.
registered_address:
title: Registered Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: EU Postal Code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9]+[-\s]?[a-zA-Z0-9]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The registered address of the company.
representatives:
title: Representative List
maxItems: 5
minItems: 1
type: array
items:
title: Representative
required:
- first_name
- last_name
- address
- date_of_birth
- place_of_birth
- roles
- documents
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: ^rep_[a-z0-9]{26}$
description: The representative's id.
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
address:
title: Address
required:
- country
- address_line1
- city
- zip
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The representative's address.
place_of_birth:
title: Place of Birth
required:
- country
properties:
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The place of birth of the person.
roles:
title: Roles within company
maxItems: 2
minItems: 1
uniqueItems: true
type: array
items:
title: Representative Role
enum:
- ubo
- legal_representative
type: string
description: The representative's roles within the company
description: The individual's roles within the company
documents:
title: Document
required:
- identity_verification
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
description: A legal document used to verify identity
description: Information about representatives of this company.
description: Information about representatives of this company.
financial_details:
title: Processing Details
required:
- annual_processing_volume
- average_transaction_value
- highest_transaction_value
type: object
properties:
annual_processing_volume:
title: Estimated annual processing volume
minimum: 0
type: integer
description: The estimated annual processing volume. In minor units without decimals.
average_transaction_value:
title: Average sales price
minimum: 0
type: integer
description: The expected average transaction value. In minor units without decimals.
highest_transaction_value:
title: Highest transaction value
minimum: 0
type: integer
description: The expected highest transaction value. In minor units without decimals.
currency:
title: Currency
enum:
- EUR
type: string
description: The currency used for the processing details provided.
description: Seller financial questions and supporting documents.
business_type:
title: Business structure
enum:
- general_partnership
- limited_partnership
- public_limited_company
- limited_company
- professional_association
- unincorporated_association
- auto_entrepreneur
type: string
description: The legal type of the company
date_of_incorporation:
title: Date of Incorporation
required:
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The day of the month the company was incorporated.
month:
maximum: 12
minimum: 1
type: integer
description: The month the company was incorporated.
year:
maximum: 2999
minimum: 1500
type: integer
description: The year the company was incorporated.
description: The date the company was incorporated.
description: Information about the company represented by the sub-entity.
documents:
title: Documents
required:
- company_verification
type: object
properties:
company_verification:
title: Company Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- incorporation_document
type: string
description: The type of document used for company verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Certified by a power of attorney within the last 3 months
bank_verification:
title: Bank Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- bank_statement
type: string
description: The type of document being used as bank verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: A document showing transactions from last 3 months
financial_verification:
title: Financial Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- financial_statement
type: string
description: The type of the file.
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Financial statement document becomes mandatory depending on the answer provided for annual_processing_volume. The status of your sub-entity will change to requirements_due stating when this is necessary.
description: The documents used to support the identity of a company.
EEACompanyFull3-0:
type: object
title: Create & Submit EEA Company (V3.0)
required:
- reference
- company
- profile
- documents
- processing_details
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
- default_holding_currency
- holding_currencies
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
default_holding_currency:
title: Main currency
description: The default holding currency code (iso-4217)
format: iso-4217
holding_currencies:
title: Currencies
type: array
minItems: 1
items:
title: Currency
type: string
enum:
- AED
- AUD
- CAD
- CHF
- CZK
- DKK
- EUR
- GBP
- HKD
- JPY
- NOK
- NZD
- PLN
- RON
- SEK
- SGD
- USD
- ZAR
description: The currency code (iso-4217)
description: Incoming funds are held in your selected currencies
default:
- EUR
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
type: object
properties:
phone:
title: Phone number
required:
- country_code
- number
type: object
properties:
country_code:
title: Country calling code
enum:
- GR
- NL
- BE
- FR
- ES
- PT
- LU
- IE
- IS
- MT
- CY
- FI
- BG
- HU
- LT
- LV
- EE
- AD
- HR
- SI
- IT
- RO
- CZ
- SK
- LI
- AT
- DK
- SE
- NO
- PL
- DE
type: string
description: The country code (iso-3166-1 alpha-2) where the phone number is registered
number:
title: Phone number
maxLength: 13
minLength: 6
pattern: ^[0-9]{6,13}$
type: string
description: The phone number without the country calling code
description: Phone number
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
message:
title: Message
type: string
description: A more descriptive message.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
company:
title: Company
required:
- legal_name
- trading_name
- business_registration_number
- date_of_incorporation
- principal_address
- registered_address
- representatives
- business_type
type: object
properties:
legal_name:
title: Legal name
maxLength: 300
minLength: 2
type: string
description: The legal name of the sub-entity.
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
business_registration_number:
title: Registration Number
maxLength: 39
minLength: 2
description: The sub-entity's Business Registration Number. This can be a Commercial Registration or Ministry of Commerce certificate number, or any other equivalent registration number. For sub-entities based in France, this must be a SIRET number.
date_of_incorporation:
title: Date of Incorporation
required:
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The day of the month the company was incorporated.
month:
maximum: 12
minimum: 1
type: integer
description: The month the company was incorporated.
year:
maximum: 2999
minimum: 1500
type: integer
description: The year the company was incorporated.
description: The date the company was incorporated.
regulatory_licence_number:
title: Regulatory Licence Number
maxLength: 32
minLength: 4
pattern: ^[a-zA-Z0-9\-]+$
description: The regulatory licence number of the company.
principal_address:
title: Principal Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: EU Postal Code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9]+[-\s]?[a-zA-Z0-9]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The primary location of the company where business is performed.
registered_address:
title: Registered Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: EU Postal Code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9]+[-\s]?[a-zA-Z0-9]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The registered address of the company.
representatives:
title: Representative List
maxItems: 25
minItems: 1
type: array
items:
title: Representative
type: object
oneOf:
- title: Person of Interest
required:
- individual
- roles
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: ^rep_[a-z0-9]{26}$
description: The representative's id.
individual:
title: Individual
type: object
allOf:
- title: Individual
required:
- first_name
- last_name
- date_of_birth
- place_of_birth
- address
type: object
properties:
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
place_of_birth:
title: Place of Birth
required:
- country
properties:
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The place of birth of the person.
national_id_number:
title: Social security number (SSN or ITIN) - US Residents Only
maxLength: 9
minLength: 9
pattern: ^\d{9}$
description: Social security number (SSN) or Individual Taxpayer Identification Number (ITIN) for non-US citizens
email_address:
title: Email
description: The main email address for this sub-entity.
format: email
phone:
title: Phone number
required:
- country_code
- number
type: object
properties:
country_code:
title: Country calling code
enum:
- AF
- AL
- DZ
- AS
- AD
- AO
- AI
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BA
- BW
- BR
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CO
- KM
- CD
- CG
- CK
- CR
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FO
- FJ
- FI
- FR
- GF
- PF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KP
- KR
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- MK
- MP
- NO
- OM
- PK
- PW
- PA
- PG
- PY
- PE
- PH
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- BQ
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- SS
- ES
- LK
- SD
- SR
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- US
- UY
- UZ
- VU
- VA
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
type: string
description: The country code (iso-3166-1 alpha-2) where the phone number is registered
number:
title: Phone number
maxLength: 16
minLength: 5
pattern: ^[0-9]{5,16}$
type: string
description: The phone number without the country calling code
description: Phone number
address:
title: Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The representative's address.
description: Information about the individual representing the sub-entity.
description: Information about the individual representing the sub-entity.
company_position:
title: Position within Company
enum:
- ceo
- cfo
- coo
- managing_member
- general_partner
- president
- vice_president
- treasurer
- other_senior_management
- other_executive_officer
- other_non_executive_non_senior
type: string
description: The position of the representative within the company.
roles:
title: Roles within company
maxItems: 10
minItems: 1
uniqueItems: true
type: array
items:
title: Representative Role
enum:
- ubo
- legal_representative
- authorised_signatory
- control_person
type: string
description: The representative's role
description: The individual's roles within the company
ownership_percentage:
title: Percentage of Ownership
maximum: 100
minimum: 25
type: integer
description: The percentage ownership of the UBO or controlling company (required when over 25%)
documents:
title: Documents
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
certified_authorised_signatory:
title: Certified Authorised Signatory Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- power_of_attorney
type: string
description: The type of document.
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Required when the legal representative or other role owner is not registered on certificate of incorporation
additionalProperties: false
description: Verification documents for the individual representative
description: Personal information about the individual representing the sub-entity.
- title: Controlling Company
required:
- company
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: ^rep_[a-z0-9]{26}$
description: The representative's id.
company:
required:
- legal_name
- trading_name
- registered_address
type: object
properties:
legal_name:
title: Legal name
maxLength: 300
minLength: 2
type: string
description: The legal name of the sub-entity.
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
registered_address:
title: Address
required:
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The representative's address.
ownership_percentage:
title: Percentage of Ownership
maximum: 100
minimum: 25
type: integer
description: The percentage ownership of the UBO or controlling company (required when over 25%)
description: Information about the controlling company
description: Information about representatives of this company.
business_type:
title: Business type
enum:
- individual_or_sole_proprietorship
- limited_company
- public_limited_company
- limited_partnership
- general_partnership
- government_agency
- non_profit_entity
- trust
- club_or_society
- unincorporated_association
type: string
description: The legal type of the company
description: Information about the company represented by the sub-entity.
processing_details:
type: object
allOf:
- title: Processing Details
required:
- settlement_country
- target_countries
- annual_processing_volume
- average_transaction_value
- highest_transaction_value
- currency
type: object
properties:
settlement_country:
title: Destination of funds
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2) where the settlement bank account is located
format: iso-3166-1-alpha-2
target_countries:
title: Target countries
maxItems: 10
minItems: 1
type: array
items:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: Target country codes (iso-3166-1 alpha-2) with more than 10% expected volume processing with Checkout
annual_processing_volume:
title: Estimated annual processing volume
minimum: 0
type: integer
description: The estimated annual processing volume. In minor units without decimals.
average_transaction_value:
title: Average sales price
minimum: 0
type: integer
description: The expected average transaction value. In minor units without decimals.
highest_transaction_value:
title: Highest transaction value
minimum: 0
type: integer
description: The expected highest transaction value. In minor units without decimals.
currency:
title: Currency
enum:
- EUR
type: string
description: The currency used for the processing details provided.
documents:
title: Documents
required:
- company_verification
- articles_of_association
- shareholder_structure
- bank_verification
type: object
properties:
company_verification:
title: Company Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- incorporation_document
type: string
description: The type of document used for company verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Certified by a power of attorney within the last 3 months
articles_of_association:
title: Memorandum or Articles of Association
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- memorandum_of_association
- articles_of_association
type: string
description: The type of document used for company verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Memorandum or Articles of Association document
bank_verification:
title: Bank Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- bank_statement
type: string
description: The type of document being used as bank verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: A document showing transactions from last 3 months
shareholder_structure:
title: Shareholder Structure
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- certified_shareholder_structure
type: string
description: The type of document.
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Shareholder structure chart (including % of shares) certified by a competent authority individual and dated within last 3 months
proof_of_legality:
title: Proof of Legality
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- proof_of_legality
type: string
description: The type of document used for proof of legality
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: A regulatory licence document required for the company to operate (when applicable)
proof_of_principal_address:
title: Address Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- proof_of_address
type: string
description: The type of document being used as address verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Proof of principal place of business
additional_document1:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
additional_document2:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
additional_document3:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
description: The documents used to support the verification of company details.
EEACompanyLite2-0:
type: object
allOf:
- title: Create & Submit regulated EEA Company (V2.0)
required:
- reference
- company
- contact_details
- profile
type: object
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
required:
- phone
- email_addresses
type: object
properties:
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
instruments:
type: array
items:
type: object
readOnly: true
company:
title: Company (V2.0)
required:
- legal_name
- trading_name
- registered_address
- principal_address
- representatives
type: object
properties:
legal_name:
title: Legal name
maxLength: 300
minLength: 2
type: string
description: The legal name of the sub-entity.
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
business_registration_number:
title: Registration Number
maxLength: 39
minLength: 2
description: The sub-entity's Business Registration Number. This can be a Commercial Registration or Ministry of Commerce certificate number, or any other equivalent registration number. For sub-entities based in France, this must be a SIRET number.
principal_address:
title: Principal Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: EU Postal Code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9]+[-\s]?[a-zA-Z0-9]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The primary location of the company where business is performed.
registered_address:
title: Registered Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: EU Postal Code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9]+[-\s]?[a-zA-Z0-9]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The registered address of the company.
representatives:
title: Representative List
maxItems: 5
minItems: 1
type: array
items:
title: Representative
required:
- first_name
- last_name
- address
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: ^rep_[a-z0-9]{26}$
description: The representative's id.
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
documents:
title: Document
required:
- identity_verification
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
description: A legal document used to verify identity
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
address:
title: Address
required:
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The representative's address.
place_of_birth:
title: Place of Birth
required:
- country
properties:
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The place of birth of the person.
roles:
title: Roles within company
maxItems: 2
minItems: 1
uniqueItems: true
type: array
items:
title: Representative Role
enum:
- ubo
- legal_representative
type: string
description: The representative's roles within the company
description: The individual's roles within the company
description: Information about representatives of this company.
description: Information about representatives of this company.
financial_details:
title: Processing Details
type: object
properties:
annual_processing_volume:
title: Estimated annual processing volume
minimum: 0
type: integer
description: The estimated annual processing volume. In minor units without decimals.
average_transaction_value:
title: Average sales price
minimum: 0
type: integer
description: The expected average transaction value. In minor units without decimals.
highest_transaction_value:
title: Highest transaction value
minimum: 0
type: integer
description: The expected highest transaction value. In minor units without decimals.
currency:
title: Currency
enum:
- EUR
type: string
description: The currency used for the processing details provided.
description: Seller financial questions and supporting documents.
business_type:
title: Business structure
enum:
- general_partnership
- limited_partnership
- public_limited_company
- limited_company
- professional_association
- unincorporated_association
- auto_entrepreneur
type: string
description: The legal type of the company
documents:
title: Documents
type: object
properties:
company_verification:
title: Company Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- incorporation_document
type: string
description: The type of document used for company verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Certified by a power of attorney within the last 3 months
bank_verification:
title: Bank Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- bank_statement
type: string
description: The type of document being used as bank verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: A document showing transactions from last 3 months
financial_verification:
title: Financial Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- financial_statement
type: string
description: The type of the file.
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Financial statement document becomes mandatory depending on the answer provided for annual_processing_volume. The status of your sub-entity will change to requirements_due stating when this is necessary.
description: The documents used to support the identity of a company.
EEASoleTraderFull2-0:
type: object
allOf:
- title: Create & Submit EEA Individual (V2.0)
required:
- reference
- individual
- contact_details
- profile
- documents
type: object
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
default_holding_currency:
title: Main currency
description: The default holding currency code (iso-4217)
format: iso-4217
holding_currencies:
title: Currencies
items:
title: Currency
type: string
enum:
- AED
- AUD
- CAD
- CHF
- CZK
- DKK
- EUR
- GBP
- HKD
- JPY
- NOK
- NZD
- PLN
- RON
- SEK
- SGD
- USD
- ZAR
description: The currency code (iso-4217)
description: Incoming funds are held in your selected currencies
default:
- EUR
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
required:
- phone
- email_addresses
type: object
properties:
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
instruments:
type: array
items:
type: object
readOnly: true
individual:
title: Individual
required:
- first_name
- last_name
- date_of_birth
- place_of_birth
- registered_address
- trading_name
type: object
properties:
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
registered_address:
title: Registered Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: EU Postal Code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9]+[-\s]?[a-zA-Z0-9]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The registered address of the company.
place_of_birth:
title: Place of Birth
required:
- country
properties:
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The place of birth of the person.
description: Information about the individual represented by the sub-entity.
documents:
title: Documents
required:
- identity_verification
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
description: A legal document used to verify identity.
EEASoleTraderFull3-0:
type: object
title: Create & Submit EEA Sole Trader (V3.0)
required:
- reference
- company
- profile
- contact_details
- documents
- processing_details
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
- default_holding_currency
- holding_currencies
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
default_holding_currency:
title: Main currency
description: The default holding currency code (iso-4217)
format: iso-4217
holding_currencies:
title: Currencies
minItems: 1
items:
title: Currency
type: string
enum:
- AED
- AUD
- CAD
- CHF
- CZK
- DKK
- EUR
- GBP
- HKD
- JPY
- NOK
- NZD
- PLN
- RON
- SEK
- SGD
- USD
- ZAR
description: The currency code (iso-4217)
description: Incoming funds are held in your selected currencies
default:
- EUR
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
type: object
properties:
phone:
title: Phone number
required:
- country_code
- number
type: object
properties:
country_code:
title: Country calling code
enum:
- GR
- NL
- BE
- FR
- ES
- PT
- LU
- IE
- IS
- MT
- CY
- FI
- BG
- HU
- LT
- LV
- EE
- AD
- HR
- SI
- IT
- RO
- CZ
- SK
- LI
- AT
- DK
- SE
- NO
- PL
- DE
type: string
description: The country code (iso-3166-1 alpha-2) where the phone number is registered
number:
title: Phone number
maxLength: 13
minLength: 6
pattern: ^[0-9]{6,13}$
type: string
description: The phone number without the country calling code
description: Phone number
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
message:
title: Message
type: string
description: A more descriptive message.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
company:
title: Business
required:
- trading_name
- date_of_incorporation
- principal_address
- representatives
- business_type
type: object
properties:
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
date_of_incorporation:
title: Date of Incorporation
required:
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The day of the month the company was incorporated.
month:
maximum: 12
minimum: 1
type: integer
description: The month the company was incorporated.
year:
maximum: 2999
minimum: 1500
type: integer
description: The year the company was incorporated.
description: The date the company was incorporated.
principal_address:
title: Principal Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: EU Postal Code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9]+[-\s]?[a-zA-Z0-9]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The primary location where business is performed.
representatives:
title: Representative List
maxItems: 1
minItems: 1
type: array
items:
title: Person of Interest
required:
- individual
- roles
- documents
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: ^rep_[a-z0-9]{26}$
description: The representative's id.
individual:
title: Individual
type: object
required:
- first_name
- last_name
- date_of_birth
- place_of_birth
- address
properties:
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
place_of_birth:
title: Place of Birth
required:
- country
properties:
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The place of birth of the person.
national_id_number:
title: Social security number (SSN or ITIN) - US Residents Only
maxLength: 9
minLength: 9
pattern: ^\d{9}$
description: Social security number (SSN) or Individual Taxpayer Identification Number (ITIN) for non-US citizens
email_address:
title: Email
description: The representative's personal email address.
format: email
phone:
title: Phone number
required:
- country_code
- number
type: object
properties:
country_code:
title: Country calling code
enum:
- AF
- AL
- DZ
- AS
- AD
- AO
- AI
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BA
- BW
- BR
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CO
- KM
- CD
- CG
- CK
- CR
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FO
- FJ
- FI
- FR
- GF
- PF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KP
- KR
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- MK
- MP
- NO
- OM
- PK
- PW
- PA
- PG
- PY
- PE
- PH
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- BQ
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- SS
- ES
- LK
- SD
- SR
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- US
- UY
- UZ
- VU
- VA
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
type: string
description: The country code (iso-3166-1 alpha-2) where the phone number is registered
number:
title: Phone number
maxLength: 16
minLength: 5
pattern: ^[0-9]{5,16}$
type: string
description: The phone number without the country calling code
description: Phone number
address:
title: Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The representative's address.
description: Information about the individual representing the sub-entity.
roles:
title: Roles within company
maxItems: 1
minItems: 1
uniqueItems: true
type: array
items:
title: Representative Role
enum:
- ubo
type: string
description: The representative's role
description: The individual's roles within the company
documents:
title: Documents
required:
- proof_of_residential_address
- proof_of_registration
- identity_verification
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
proof_of_residential_address:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- proof_of_address
type: string
description: The type of document being used as address verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Proof of residential address of the representative
proof_of_registration:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- extract_from_trade_register
- other
type: string
description: The type of document being used as proof of registration
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Proof of sole traders registration e.g. extract from a trade register
additionalProperties: false
description: Verification documents for the individual representative
description: Personal information about the individual representing the sub-entity.
description: Information about representatives of this company.
business_type:
title: Business type
enum:
- individual_or_sole_proprietorship
- limited_company
- public_limited_company
- limited_partnership
- general_partnership
- government_agency
- non_profit_entity
- trust
- club_or_society
- unincorporated_association
type: string
description: The legal type of the company
description: Information about the sole trader's business.
processing_details:
type: object
allOf:
- title: Processing Details
required:
- settlement_country
- target_countries
- annual_processing_volume
- average_transaction_value
- highest_transaction_value
- currency
type: object
properties:
settlement_country:
title: Destination of funds
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2) where the settlement bank account is located
format: iso-3166-1-alpha-2
target_countries:
title: Target countries
maxItems: 10
minItems: 1
type: array
items:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: Target country codes (iso-3166-1 alpha-2) with more than 10% expected volume processing with Checkout
annual_processing_volume:
title: Estimated annual processing volume
minimum: 0
type: integer
description: The estimated annual processing volume. In minor units without decimals.
average_transaction_value:
title: Average sales price
minimum: 0
type: integer
description: The expected average transaction value. In minor units without decimals.
highest_transaction_value:
title: Highest transaction value
minimum: 0
type: integer
description: The expected highest transaction value. In minor units without decimals.
currency:
title: Currency
enum:
- EUR
type: string
description: The currency used for the processing details provided.
documents:
title: Documents
required:
- bank_verification
type: object
properties:
bank_verification:
title: Bank Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- bank_statement
type: string
description: The type of document being used as bank verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: A document showing transactions from last 3 months
additional_document1:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
additional_document2:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
additional_document3:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
description: The documents used to support the verification of business details.
EEASoleTraderLite2-0:
type: object
allOf:
- title: Create & Submit regulated EEA Individual (V2.0)
required:
- reference
- individual
- contact_details
- profile
type: object
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
required:
- phone
- email_addresses
type: object
properties:
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
instruments:
type: array
items:
type: object
readOnly: true
documents:
title: Documents
required:
- identity_verification
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
description: A legal document used to verify identity.
individual:
title: Individual
required:
- first_name
- last_name
- date_of_birth
- place_of_birth
- registered_address
- trading_name
type: object
properties:
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
registered_address:
title: Registered Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: EU Postal Code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9]+[-\s]?[a-zA-Z0-9]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The registered address of the company.
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
place_of_birth:
title: Place of Birth
required:
- country
properties:
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The place of birth of the person.
description: Information about the individual represented by the sub-entity.
EntityBasicResponseV2:
title: Basic response
type: object
properties:
id:
type: string
description: The unique identifier of the entity.
example: ent_wxglze3wwywujg4nna5fb7ldli
reference:
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify this entity.
example: superhero1234
capabilities:
$ref: '#/components/schemas/EntityCapabilities'
requirements_due:
title: Requirements Due
type: array
items:
$ref: '#/components/schemas/EntityRequirementV2'
description: The requirements still due for this entity to unlock capabilities.
readOnly: true
EntityBasicResponseV3:
title: Basic response
type: object
properties:
id:
type: string
description: The unique identifier of the entity.
example: ent_wxglze3wwywujg4nna5fb7ldli
reference:
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify this entity.
example: superhero1234
requirements_due:
title: Requirements Due
type: array
items:
$ref: '#/components/schemas/EntityRequirementV3'
description: The requirements still due for this entity to unlock capabilities.
readOnly: true
EntityBasicResponseWithLinksV2:
title: Basic response with links
type: object
allOf:
- $ref: '#/components/schemas/EntityBasicResponseV2'
- $ref: '#/components/schemas/EntityLinks'
EntityBasicResponseWithLinksV3:
title: Basic response with links
type: object
allOf:
- $ref: '#/components/schemas/EntityBasicResponseV3'
- $ref: '#/components/schemas/EntityLinks'
EntityCapabilities:
title: Capabilities
type: object
properties:
payments:
type: object
properties:
available:
type: boolean
description: True if payments are available to the entity.
enabled:
type: boolean
description: True if payments are enabled.
description: Payment related capabilities of an entity.
example:
enabled: false
available: true
payouts:
type: object
properties:
available:
type: boolean
description: True if payouts are available to the entity.
enabled:
type: boolean
description: True if payouts are enabled.
description: Payout related capabilities of an entity.
example:
enabled: false
available: true
issuing:
type: object
properties:
available:
type: boolean
description: True if issuing is available to the entity.
enabled:
type: boolean
description: True if issuing is enabled.
description: Issuing related capabilities of an entity.
example:
enabled: false
available: true
EntityLinks:
title: Links
type: object
properties:
_links:
additionalProperties:
$ref: '#/components/schemas/Link'
example:
self:
href: https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli
EntityRequirementDetails:
title: Requirement details
type: object
description: Detailed information about a single requirement.
allOf:
- $ref: '#/components/schemas/EntityRequirementListItem'
- type: object
properties:
message:
type: string
description: A user-facing explanation of what is needed to resolve the requirement.
example: Please confirm your legal company name.
_schema:
type: object
nullable: true
description: >-
JSON Schema that the value supplied to `PUT /accounts/entities/{id}/requirements/{requirementId}`
must conform to. The shape varies by requirement type (for example: an identity document upload,
a free-text response, or a structured object). Validate the value client-side against this
schema before submitting. May be `null` if no schema is registered for the requirement's field.
additionalProperties: true
readOnly: true
EntityRequirementListItem:
title: Requirement summary
type: object
description: A pending requirement that the sub-entity must resolve to remain compliant or unlock capabilities.
properties:
id:
type: string
description: The unique identifier of the requirement.
example: req_5wmacwhrhbzhqkhx5hlqmzje44
resource:
type: string
description: The ID of the resource (sub-entity or representative) the requirement applies to.
example: ent_wxglze3wwywujg4nna5fb7ldli
resource_type:
type: string
description: >-
The type of resource the requirement applies to derived from the resource's URN. Common values
include `company`, `individual`, and `representative`. Defaults to `entity` if the URN cannot be
parsed.
example: company
reason:
type: string
description: The reason the requirement was raised.
enum:
- periodic_review
- attestation
example: periodic_review
priority:
type: string
description: Priority level of this requirement. "high" by default, "critical" if deadline is within 7 days.
enum:
- high
- critical
example: high
deadline:
type: string
format: date-time
description: The date and time, in ISO 8601 UTC format, by which the requirement must be resolved.
example: '2026-06-01T00:00:00Z'
urn:
type: string
description: >-
The schema-registry URN identifying the field this requirement applies to. Format:
`urn:object:{resource_type}#{resource_id}#field:{field_name}`.
example: 'urn:object:company#ent_wxglze3wwywujg4nna5fb7ldli#field:legal-name'
field_path:
type: string
nullable: true
description: >-
Dot-notation path of the field on the resource that needs to be supplied or updated. May be `null`
for ad-hoc requirements (such as additional documents or free-text responses) that do not map to
a specific field on the entity.
example: company.legal_name
field_urn:
type: string
nullable: true
description: The schema-registry URN of the field, from the public mapping definition. May be `null` if no mapping exists.
example: 'urn:field:companies/legal-name'
metadata:
type: object
nullable: true
description: Optional metadata from the property mapping definition. Shape varies by requirement.
additionalProperties: true
example:
purpose: company_verification
_links:
type: object
description: Links to related resources.
additionalProperties:
$ref: '#/components/schemas/Link'
example:
self:
href: 'https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements/req_5wmacwhrhbzhqkhx5hlqmzje44'
readOnly: true
EntityRequirementListResponse:
title: Requirements list
type: object
description: The list of pending requirements for a sub-entity.
properties:
data:
type: array
description: The list of pending requirements for the sub-entity. Empty when no requirements are outstanding.
items:
$ref: '#/components/schemas/EntityRequirementListItem'
readOnly: true
EntityRequirementUpdateRequest:
title: Resolve requirement request
type: object
description: Request body used to resolve a requirement. The shape of `value` is defined by the requirement's `_schema` (returned from `GET /accounts/entities/{id}/requirements/{requirementId}`).
required:
- value
properties:
value:
description: >-
The response to the requirement. The expected shape depends on the requirement and is defined
by the JSON Schema returned in the requirement details response. Common shapes include a file
reference (for document uploads), a primitive value, or a structured object.
oneOf:
- type: object
additionalProperties: true
- type: array
items: {}
- type: string
- type: number
- type: boolean
example:
file_id: file_6lbss42ezvoufcb2beo76rvwly
EntityRequirementUpdateResponse:
title: Resolve requirement response
type: object
description: Acknowledges that a requirement response has been accepted for processing.
properties:
id:
type: string
description: The unique identifier of the requirement.
example: req_5wmacwhrhbzhqkhx5hlqmzje44
status:
type: string
description: Processing status of the submitted response. While the response is processing, the requirement is no longer retrievable via the GET endpoints; if validation fails downstream the requirement may reappear.
enum:
- processing
example: processing
submitted_at:
type: string
format: date-time
description: The date and time, in ISO 8601 UTC format, the response was accepted.
example: '2026-05-05T10:15:30Z'
_links:
type: object
additionalProperties:
$ref: '#/components/schemas/Link'
example:
self:
href: 'https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements/req_5wmacwhrhbzhqkhx5hlqmzje44'
collection:
href: 'https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli/requirements'
readOnly: true
EntityRequirementV2:
title: Requirement
type: object
properties:
field:
type: string
description: The name of the field required.
example: individual.identification.document
reason:
type: string
description: The reason the field is required.
example: required
readOnly: true
EntityRequirementV3:
title: Requirement
type: object
properties:
field:
type: string
description: The name of the field required.
example: individual.identification.document
reason:
type: string
description: The reason the field is required.
example: required
message:
type: string
description: An additional text field for requirement reasoning.
example: required
readOnly: true
GBCompanyFull2-0:
type: object
allOf:
- title: Create & Submit GB Company (V2.0)
required:
- reference
- company
- contact_details
- profile
type: object
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
default_holding_currency:
title: Main currency
description: The default holding currency code (iso-4217)
format: iso-4217
holding_currencies:
title: Currencies
items:
title: Currency
type: string
enum:
- AED
- AUD
- CAD
- CHF
- CZK
- DKK
- EUR
- GBP
- HKD
- JPY
- KWD
- NOK
- NZD
- PLN
- RON
- SEK
- SGD
- USD
- ZAR
description: The currency code (iso-4217)
description: Incoming funds are held in your selected currencies
default:
- GBP
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
required:
- phone
- email_addresses
type: object
properties:
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
instruments:
type: array
items:
type: object
readOnly: true
company:
title: Company
required:
- legal_name
- trading_name
- registered_address
- principal_address
- representatives
- business_registration_number
type: object
properties:
legal_name:
title: Legal name
maxLength: 300
minLength: 2
type: string
description: The legal name of the sub-entity.
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
business_registration_number:
title: Registration number
maxLength: 8
minLength: 8
pattern: ^(([Aa][Cc]|[Cc][Ee]|[Ee][Nn]|[Ee][Ss]|[Ff][Cc]|[Gg][Ee]|[Gg][Nn]|[Gg][Ss]|[Ii][Cc]|[Ii][Pp]|[Ll][Pp]|[Nn][Aa]|[Nn][Cc]|[Nn][Ff]|[Nn][Ii]|[Nn][Ll]|[Nn][Oo]|[Nn][Pp]|[Nn][Rr]|[Nn][Vv]|[Nn][Zz]|[Oo][Cc]|[Rr][0]|[Rr][Cc]|[Ss][Aa]|[Ss][Cc]|[Ss][Ee]|[Ss][Ff]|[Ss][Ii]|[Ss][Ll]|[Ss][Oo]|[Ss][Pp]|[Ss][Rr]|[Ss][Zz]|[Zz][Cc]|\d{2})\d{6})$
description: The sub-entity's Business Registration Number. This can be a Commercial Registration or Ministry of Commerce certificate number, or any other equivalent registration number.
principal_address:
title: Principal Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: UK Postal Code
maxLength: 8
minLength: 5
pattern: ^[A-Za-z]{1,2}([0-9]{1,2}|[0-9][A-Za-z])\s?[0-9][A-Za-z]{2}$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The primary location of the company where business is performed.
registered_address:
title: Registered Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: UK Postal Code
maxLength: 8
minLength: 5
pattern: ^[A-Za-z]{1,2}([0-9]{1,2}|[0-9][A-Za-z])\s?[0-9][A-Za-z]{2}$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The registered address of the company.
representatives:
title: Representative List
maxItems: 5
minItems: 1
type: array
items:
title: Representative
required:
- first_name
- last_name
- address
- roles
- date_of_birth
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: ^rep_[a-z0-9]{26}$
description: The representative's id.
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
documents:
title: Document
required:
- identity_verification
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
description: A legal document used to verify identity
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
address:
title: Address
required:
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The representative's address.
roles:
title: Roles within company
maxItems: 2
minItems: 1
uniqueItems: true
type: array
items:
title: Representative Role
enum:
- ubo
- authorised_signatory
type: string
description: The representative's roles within the company
description: The individual's roles within the company
description: Information about representatives of this company.
description: Information about representatives of this company.
date_of_incorporation:
title: Date of Incorporation
required:
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The day of the month the company was incorporated.
month:
maximum: 12
minimum: 1
type: integer
description: The month the company was incorporated.
year:
maximum: 2999
minimum: 1500
type: integer
description: The year the company was incorporated.
description: The date the company was incorporated.
description: Information about the company represented by the sub-entity.
documents:
title: Documents
required:
- company_verification
type: object
properties:
company_verification:
title: Company Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- incorporation_document
type: string
description: The type of document used for company verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Certified by a power of attorney within the last 3 months
description: The documents used to support the verification of company details.
GBCompanyFull3-0:
type: object
title: Create & Submit GB Company (V3.0)
required:
- reference
- company
- profile
- contact_details
- documents
- processing_details
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
- default_holding_currency
- holding_currencies
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
default_holding_currency:
title: Main currency
description: The default holding currency code (iso-4217)
format: iso-4217
holding_currencies:
title: Currencies
minItems: 1
items:
title: Currency
type: string
enum:
- AED
- AUD
- CAD
- CHF
- CZK
- DKK
- EUR
- GBP
- HKD
- JPY
- KWD
- NOK
- NZD
- PLN
- RON
- SEK
- SGD
- USD
- ZAR
description: The currency code (iso-4217)
description: Incoming funds are held in your selected currencies
default:
- GBP
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
type: object
properties:
phone:
title: Phone number
required:
- country_code
- number
type: object
properties:
country_code:
title: Country calling code
enum:
- GI
- CH
- GG
- IM
- JE
- GB
type: string
description: The country code (iso-3166-1 alpha-2) where the phone number is registered
number:
title: Phone number
maxLength: 11
minLength: 7
pattern: ^[0-9]{7,11}$
type: string
description: The phone number without the country calling code
description: Phone number
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
message:
title: Message
type: string
description: A more descriptive message.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
company:
title: Company
required:
- legal_name
- trading_name
- business_registration_number
- date_of_incorporation
- principal_address
- registered_address
- representatives
- business_type
type: object
properties:
legal_name:
title: Legal name
maxLength: 300
minLength: 2
type: string
description: The legal name of the sub-entity.
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
business_registration_number:
title: Registration Number
maxLength: 8
minLength: 8
pattern: ^(((AC|CE|CS|FC|FE|GE|GS|IC|LP|NC|NF|NI|NL|NO|NP|OC|OE|PC|R0|RC|SA|SC|SE|SF|SG|SI|SL|SO|SR|SZ|ZC|\d{2})\d{6})|((IP|SP|RS)[A-Z\d]{6})|(SL\d{5}[\dA]))$
description: The sub-entity's Business Registration Number. This can be a Commercial Registration or Ministry of Commerce certificate number, or any other equivalent registration number.
date_of_incorporation:
title: Date of Incorporation
required:
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The day of the month the company was incorporated.
month:
maximum: 12
minimum: 1
type: integer
description: The month the company was incorporated.
year:
maximum: 2999
minimum: 1500
type: integer
description: The year the company was incorporated.
description: The date the company was incorporated.
principal_address:
title: Principal Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The primary location of the company where business is performed.
registered_address:
title: Registered Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: UK Postal Code
maxLength: 8
minLength: 5
pattern: ^[A-Za-z]{1,2}([0-9]{1,2}|[0-9][A-Za-z])\s?[0-9][A-Za-z]{2}$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The registered address of the company.
representatives:
title: Representative List
maxItems: 25
minItems: 1
type: array
items:
title: Representative
type: object
oneOf:
- title: Person of Interest
required:
- individual
- roles
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: ^rep_[a-z0-9]{26}$
description: The representative's id.
individual:
title: Individual
type: object
required:
- first_name
- last_name
- date_of_birth
- place_of_birth
- address
properties:
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
place_of_birth:
title: Place of Birth
required:
- country
properties:
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The place of birth of the person.
national_id_number:
title: Social security number (SSN or ITIN) - US Residents Only
maxLength: 9
minLength: 9
pattern: ^\d{9}$
description: Social security number (SSN) or Individual Taxpayer Identification Number (ITIN) for non-US citizens
email_address:
title: Email
description: The main email address for this sub-entity.
format: email
phone:
title: Phone number
required:
- country_code
- number
type: object
properties:
country_code:
title: Country calling code
enum:
- AF
- AL
- DZ
- AS
- AD
- AO
- AI
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BA
- BW
- BR
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CO
- KM
- CD
- CG
- CK
- CR
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FO
- FJ
- FI
- FR
- GF
- PF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KP
- KR
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- MK
- MP
- NO
- OM
- PK
- PW
- PA
- PG
- PY
- PE
- PH
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- SX
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- BQ
- SK
- SI
- SB
- SO
- ZA
- GS
- SS
- ES
- LK
- SD
- SR
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- US
- UY
- UZ
- VU
- VA
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
type: string
description: The country code (iso-3166-1 alpha-2) where the phone number is registered
number:
title: Phone number
maxLength: 16
minLength: 5
pattern: ^[0-9]{5,16}$
type: string
description: The phone number without the country calling code
description: Phone number
address:
title: Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The representative's address.
description: Information about the individual representing the sub-entity.
company_position:
title: Position within Company
enum:
- ceo
- cfo
- coo
- managing_member
- general_partner
- president
- vice_president
- treasurer
- other_senior_management
- other_executive_officer
- other_non_executive_non_senior
type: string
description: The position of the representative within the company.
roles:
title: Roles within company
maxItems: 10
minItems: 1
uniqueItems: true
type: array
items:
title: Representative Role
enum:
- ubo
- authorised_signatory
- director
- control_person
type: string
description: The representative's role
description: The individual's roles within the company
ownership_percentage:
title: Percentage of Ownership
maximum: 100
minimum: 25
type: integer
description: The percentage ownership of the UBO or controlling company (required when over 25%)
documents:
title: Documents
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
certified_authorised_signatory:
title: Certified Authorised Signatory Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- power_of_attorney
type: string
description: The type of document.
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Required when the legal representative or other role owner is not registered on certificate of incorporation
additionalProperties: false
description: Verification documents for the individual representative
description: Personal information about the individual representing the sub-entity.
- title: Controlling Company
required:
- company
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: ^rep_[a-z0-9]{26}$
description: The representative's id.
company:
required:
- legal_name
- trading_name
- registered_address
type: object
properties:
legal_name:
title: Legal name
maxLength: 300
minLength: 2
type: string
description: The legal name of the sub-entity.
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
registered_address:
title: Address
required:
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The representative's address.
ownership_percentage:
title: Percentage of Ownership
maximum: 100
minimum: 25
type: integer
description: The percentage ownership of the UBO or controlling company (required when over 25%)
description: Information about the controlling company
description: Information about representatives of this company.
business_type:
title: Business type
enum:
- individual_or_sole_proprietorship
- limited_company
- public_limited_company
- limited_partnership
- general_partnership
- scottish_limited_partnership
- government_agency
- non_profit_entity
- trust
- club_or_society
- unincorporated_association
type: string
description: The legal type of the company
description: Information about the company represented by the sub-entity.
processing_details:
type: object
title: Processing Details
required:
- settlement_country
- target_countries
- annual_processing_volume
- average_transaction_value
- highest_transaction_value
- currency
properties:
settlement_country:
title: Destination of funds
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2) where the settlement bank account is located
format: iso-3166-1-alpha-2
target_countries:
title: Target countries
maxItems: 10
minItems: 1
type: array
items:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: Target country codes (iso-3166-1 alpha-2) with more than 10% expected volume processing with Checkout
annual_processing_volume:
title: Estimated annual processing volume
minimum: 0
type: integer
description: The estimated annual processing volume. In minor units without decimals.
average_transaction_value:
title: Average sales price
minimum: 0
type: integer
description: The expected average transaction value. In minor units without decimals.
highest_transaction_value:
title: Highest transaction value
minimum: 0
type: integer
description: The expected highest transaction value. In minor units without decimals.
currency:
title: Currency
enum:
- GBP
type: string
description: The currency used for the processing details provided.
description: Seller processing details.
documents:
title: Documents
required:
- articles_of_association
- shareholder_structure
type: object
properties:
company_verification:
title: Company Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- incorporation_document
type: string
description: The type of document used for company verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Certified by a power of attorney within the last 3 months
articles_of_association:
title: Memorandum or Articles of Association
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- memorandum_of_association
- articles_of_association
type: string
description: The type of document used for company verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Memorandum or Articles of Association document
bank_verification:
title: Bank Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- bank_statement
type: string
description: The type of document being used as bank verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: A document showing transactions from last 3 months
shareholder_structure:
title: Shareholder Structure
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- certified_shareholder_structure
type: string
description: The type of document.
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Shareholder structure chart (including % of shares) certified by a competent authority individual and dated within last 3 months
proof_of_legality:
title: Proof of Legality
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- proof_of_legality
type: string
description: The type of document used for proof of legality
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: A regulatory licence document required for the company to operate (when applicable)
proof_of_principal_address:
title: Address Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- proof_of_address
type: string
description: The type of document being used as address verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Proof of principal place of business
additional_document1:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
additional_document2:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
additional_document3:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
description: The documents used to support the verification of company details.
GBCompanyLite2-0:
type: object
allOf:
- title: Create & Submit regulated GB Company (V2.0)
required:
- reference
- company
- contact_details
- profile
type: object
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
required:
- phone
- email_addresses
type: object
properties:
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
instruments:
type: array
items:
type: object
readOnly: true
company:
title: Company (V2.0)
required:
- legal_name
- trading_name
- registered_address
- principal_address
- representatives
type: object
properties:
legal_name:
title: Legal name
maxLength: 300
minLength: 2
type: string
description: The legal name of the sub-entity.
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
business_registration_number:
title: Registration number
maxLength: 8
minLength: 8
pattern: ^(([Aa][Cc]|[Cc][Ee]|[Ee][Nn]|[Ee][Ss]|[Ff][Cc]|[Gg][Ee]|[Gg][Nn]|[Gg][Ss]|[Ii][Cc]|[Ii][Pp]|[Ll][Pp]|[Nn][Aa]|[Nn][Cc]|[Nn][Ff]|[Nn][Ii]|[Nn][Ll]|[Nn][Oo]|[Nn][Pp]|[Nn][Rr]|[Nn][Vv]|[Nn][Zz]|[Oo][Cc]|[Rr][0]|[Rr][Cc]|[Ss][Aa]|[Ss][Cc]|[Ss][Ee]|[Ss][Ff]|[Ss][Ii]|[Ss][Ll]|[Ss][Oo]|[Ss][Pp]|[Ss][Rr]|[Ss][Zz]|[Zz][Cc]|\d{2})\d{6})$
description: The sub-entity's Business Registration Number. This can be a Commercial Registration or Ministry of Commerce certificate number, or any other equivalent registration number.
principal_address:
title: Principal Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: UK Postal Code
maxLength: 8
minLength: 5
pattern: ^[A-Za-z]{1,2}([0-9]{1,2}|[0-9][A-Za-z])\s?[0-9][A-Za-z]{2}$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The primary location of the company where business is performed.
registered_address:
title: Registered Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: UK Postal Code
maxLength: 8
minLength: 5
pattern: ^[A-Za-z]{1,2}([0-9]{1,2}|[0-9][A-Za-z])\s?[0-9][A-Za-z]{2}$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The registered address of the company.
representatives:
title: Representative List
maxItems: 5
minItems: 1
type: array
items:
title: Representative
required:
- first_name
- last_name
- address
- roles
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: ^rep_[a-z0-9]{26}$
description: The representative's id.
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
documents:
title: Document
required:
- identity_verification
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
description: A legal document used to verify identity
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
address:
title: Address
required:
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The representative's address.
roles:
title: Roles within company
maxItems: 2
minItems: 1
uniqueItems: true
type: array
items:
title: Representative Role
enum:
- ubo
- authorised_signatory
type: string
description: The representative's roles within the company
description: The individual's roles within the company
description: Information about representatives of this company.
description: Information about representatives of this company.
documents:
title: GB company documents (V2.0)
type: object
properties:
company_verification:
title: Company Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- incorporation_document
type: string
description: The type of document used for company verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Certified by a power of attorney within the last 3 months
GBSoleTraderFull2-0:
type: object
allOf:
- title: Create & Submit GB Individual (V2.0)
required:
- reference
- individual
- contact_details
- profile
type: object
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
default_holding_currency:
title: Main currency
description: The default holding currency code (iso-4217)
format: iso-4217
holding_currencies:
title: Currencies
items:
title: Currency
type: string
enum:
- AED
- AUD
- CAD
- CHF
- CZK
- DKK
- EUR
- GBP
- HKD
- JPY
- KWD
- NOK
- NZD
- PLN
- RON
- SEK
- SGD
- USD
- ZAR
description: The currency code (iso-4217)
description: Incoming funds are held in your selected currencies
default:
- GBP
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
required:
- phone
- email_addresses
type: object
properties:
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
instruments:
type: array
items:
type: object
readOnly: true
individual:
title: Individual
required:
- first_name
- last_name
- date_of_birth
- registered_address
- trading_name
type: object
properties:
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
registered_address:
title: Registered Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: UK Postal Code
maxLength: 8
minLength: 5
pattern: ^[A-Za-z]{1,2}([0-9]{1,2}|[0-9][A-Za-z])\s?[0-9][A-Za-z]{2}$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The registered address of the company.
description: Information about the individual represented by the sub-entity.
documents:
title: Document
required:
- identity_verification
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
description: A legal document used to verify identity.
GBSoleTraderFull3-0:
type: object
title: Create & Submit GB Sole Trader (V3.0)
required:
- reference
- company
- profile
- contact_details
- documents
- processing_details
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
- default_holding_currency
- holding_currencies
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
default_holding_currency:
title: Main currency
description: The default holding currency code (iso-4217)
format: iso-4217
holding_currencies:
title: Currencies
type: array
minItems: 1
items:
title: Currency
type: string
enum:
- AED
- AUD
- CAD
- CHF
- CZK
- DKK
- EUR
- GBP
- HKD
- JPY
- KWD
- NOK
- NZD
- PLN
- RON
- SEK
- SGD
- USD
- ZAR
description: The currency code (iso-4217)
description: Incoming funds are held in your selected currencies
default:
- GBP
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
type: object
properties:
phone:
title: Phone number
required:
- country_code
- number
type: object
properties:
country_code:
title: Country calling code
enum:
- GI
- CH
- GG
- IM
- JE
- GB
type: string
description: The country code (iso-3166-1 alpha-2) where the phone number is registered
number:
title: Phone number
maxLength: 11
minLength: 7
pattern: ^[0-9]{7,11}$
type: string
description: The phone number without the country calling code
description: Phone number
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
message:
title: Message
type: string
description: A more descriptive message.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
company:
title: Business
required:
- trading_name
- date_of_incorporation
- principal_address
- representatives
- business_type
type: object
properties:
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
date_of_incorporation:
title: Date of Incorporation
required:
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The day of the month the company was incorporated.
month:
maximum: 12
minimum: 1
type: integer
description: The month the company was incorporated.
year:
maximum: 2999
minimum: 1500
type: integer
description: The year the company was incorporated.
description: The date the company was incorporated.
principal_address:
title: Principal Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: UK Postal Code
maxLength: 8
minLength: 5
pattern: ^[A-Za-z]{1,2}([0-9]{1,2}|[0-9][A-Za-z])\s?[0-9][A-Za-z]{2}$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The primary location where business is performed.
representatives:
title: Representative List
maxItems: 1
minItems: 1
type: array
items:
title: Person of Interest
required:
- individual
- roles
- documents
type: object
properties:
id:
maxLength: 30
minLength: 30
pattern: ^rep_[a-z0-9]{26}$
description: The representative's id.
individual:
title: Individual
type: object
required:
- first_name
- last_name
- date_of_birth
- place_of_birth
- address
properties:
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
place_of_birth:
title: Place of Birth
required:
- country
properties:
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The place of birth of the person.
national_id_number:
title: Social security number (SSN or ITIN) - US Residents Only
maxLength: 9
minLength: 9
pattern: ^\d{9}$
description: Social security number (SSN) or Individual Taxpayer Identification Number (ITIN) for non-US citizens
email_address:
title: Email
description: The representative's personal email address.
format: email
phone:
title: Phone number
required:
- country_code
- number
type: object
properties:
country_code:
title: Country calling code
enum:
- AF
- AL
- DZ
- AS
- AD
- AO
- AI
- AG
- AR
- AM
- AW
- AU
- AT
- AZ
- BS
- BH
- BD
- BB
- BY
- BE
- BZ
- BJ
- BM
- BT
- BO
- BA
- BW
- BR
- BN
- BG
- BF
- BI
- CV
- KH
- CM
- CA
- KY
- CF
- TD
- CL
- CN
- CO
- KM
- CD
- CG
- CK
- CR
- HR
- CU
- CW
- CY
- CZ
- DK
- DJ
- DM
- DO
- EC
- EG
- SV
- GQ
- ER
- EE
- SZ
- ET
- FO
- FJ
- FI
- FR
- GF
- PF
- GA
- GM
- GE
- DE
- GH
- GI
- GR
- GL
- GD
- GP
- GU
- GT
- GG
- GN
- GW
- GY
- HT
- HN
- HK
- HU
- IS
- IN
- ID
- IR
- IQ
- IE
- IM
- IL
- IT
- JM
- JP
- JE
- JO
- KZ
- KE
- KI
- KP
- KR
- KW
- KG
- LA
- LV
- LB
- LS
- LR
- LY
- LI
- LT
- LU
- MO
- MG
- MW
- MY
- MV
- ML
- MT
- MH
- MQ
- MR
- MU
- MX
- FM
- MD
- MC
- MN
- ME
- MS
- MA
- MZ
- MM
- NA
- NR
- NP
- NL
- NC
- NZ
- NI
- NE
- NG
- NU
- NF
- MK
- MP
- NO
- OM
- PK
- PW
- PA
- PG
- PY
- PE
- PH
- PL
- PT
- PR
- QA
- RE
- RO
- RU
- RW
- BL
- SH
- KN
- LC
- PM
- VC
- WS
- SM
- ST
- SA
- SN
- RS
- SC
- SL
- SG
- BQ
- SX
- SK
- SI
- SB
- SO
- ZA
- GS
- SS
- ES
- LK
- SD
- SR
- SE
- CH
- SY
- TW
- TJ
- TZ
- TH
- TL
- TG
- TK
- TO
- TT
- TN
- TR
- TM
- TC
- TV
- UG
- UA
- AE
- GB
- US
- UY
- UZ
- VU
- VA
- VE
- VN
- VG
- VI
- WF
- EH
- YE
- ZM
- ZW
type: string
description: The country code (iso-3166-1 alpha-2) where the phone number is registered
number:
title: Phone number
maxLength: 16
minLength: 5
pattern: ^[0-9]{5,16}$
type: string
description: The phone number without the country calling code
description: Phone number
address:
title: Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: Postal code
maxLength: 16
minLength: 1
pattern: ^[a-zA-Z0-9-\s]+$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The representative's address.
description: Information about the individual representing the sub-entity.
roles:
title: Roles within company
maxItems: 1
minItems: 1
uniqueItems: true
type: array
items:
title: Representative Role
enum:
- ubo
type: string
description: The representative's role
description: The individual's roles within the company
documents:
title: Documents
required:
- identity_verification
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
additionalProperties: false
description: Verification documents for the individual representative
description: Personal information about the individual representing the sub-entity.
description: Information about representatives of this company.
business_type:
title: Business type
enum:
- individual_or_sole_proprietorship
- limited_company
- public_limited_company
- limited_partnership
- general_partnership
- scottish_limited_partnership
- government_agency
- non_profit_entity
- trust
- club_or_society
- unincorporated_association
type: string
description: The legal type of the company
description: Information about the sole trader's business.
processing_details:
type: object
allOf:
- title: Processing Details
required:
- settlement_country
- target_countries
- annual_processing_volume
- average_transaction_value
- highest_transaction_value
- currency
type: object
properties:
settlement_country:
title: Destination of funds
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2) where the settlement bank account is located
format: iso-3166-1-alpha-2
target_countries:
title: Target countries
maxItems: 10
minItems: 1
type: array
items:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: Target country codes (iso-3166-1 alpha-2) with more than 10% expected volume processing with Checkout
annual_processing_volume:
title: Estimated annual processing volume
minimum: 0
type: integer
description: The estimated annual processing volume. In minor units without decimals.
average_transaction_value:
title: Average sales price
minimum: 0
type: integer
description: The expected average transaction value. In minor units without decimals.
highest_transaction_value:
title: Highest transaction value
minimum: 0
type: integer
description: The expected highest transaction value. In minor units without decimals.
currency:
title: Currency
enum:
- GBP
type: string
description: The currency used for the processing details provided.
description: Seller processing details.
documents:
title: Documents
required:
- bank_verification
type: object
properties:
bank_verification:
title: Bank Verification
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- bank_statement
type: string
description: The type of document being used as bank verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: A document showing transactions from last 3 months
additional_document1:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
additional_document2:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
additional_document3:
title: Additional Documentation
required:
- front
type: object
properties:
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
description: Additional space for documents to be provided when requested
description: The documents used to support the verification of business details.
GBSoleTraderLite2-0:
type: object
allOf:
- title: Create & Submit regulated GB Individual (V2.0)
required:
- reference
- individual
- contact_details
- profile
type: object
properties:
reference:
title: Unique reference
maxLength: 50
minLength: 1
type: string
description: A unique reference you can later use to identify the sub-entity.
status:
type: string
readOnly: true
is_draft:
type: boolean
description: >-
Specifies whether the sub-entity details are in draft.
Marking a sub-entity as a draft allows sub-entity details to be updated, without triggering due diligence checks.
writeOnly: true
profile:
title: Profile
required:
- urls
- mccs
type: object
properties:
urls:
title: Website
maxItems: 100
type: array
items:
title: Company website URL
maxLength: 300
minLength: 4
pattern: ^(http|https):\//\S{2,293}$
type: string
description: The URL of the company's website.
format: uri
description: A collection of website URLs the sub-entity accepts payments on.
mccs:
title: Industry
maxItems: 5
minItems: 1
type: array
items:
title: Merchant category code
pattern: ^[0-9]{4}$
description: The merchant category code (4-digit ISO 18245).
description: Select the categories that most closely describe the business
description: Information about the profile of the sub-entity, primarily regarding the products/services offered.
contact_details:
title: Contact Details
required:
- phone
- email_addresses
type: object
properties:
phone:
title: Phone
required:
- number
type: object
properties:
number:
title: Phone number
maximum: 9999999999999999
minimum: 10000000
maxLength: 16
minLength: 8
pattern: ^[1-9][0-9]{7,15}$
description: "The phone number. This must only contain numeric characters and can't contain only zeros. (For US numbers: It cannot start with 0 or 1 and must be at least 10 characters in length.)"
description: The phone number of the sub-entity.
email_addresses:
required:
- primary
type: object
properties:
primary:
title: Email
description: The main email address for this sub-entity.
format: email
description: Email addresses for this sub-entity.
invitee:
title: Invitee
type: object
properties:
email:
title: Email
description: The main email address for this sub-entity.
format: email
description: The details of the user responsible for onboarding the sub-entity.
description: Contact details of this sub-entity.
capabilities:
title: Capabilities
type: object
description: The capabilities of the entity.
readOnly: true
requirements_due:
title: Requirements Due
minItems: 0
type: array
items:
title: Requirements due entry
type: object
properties:
field:
title: Field
type: string
description: The field that is needs to be addressed.
reason:
title: Reason
type: string
description: The reason behind the field needing attention.
description: A list of fields which require attention
readOnly: true
description: List of requirements due in order to be onboarded.
readOnly: true
instruments:
type: array
items:
type: object
readOnly: true
documents:
title: Document
required:
- identity_verification
type: object
properties:
identity_verification:
title: Document
required:
- type
- front
type: object
properties:
type:
title: Document type
enum:
- passport
- national_identity_card
- driving_license
- citizen_card
- residence_permit
- electoral_id
type: string
description: The type of document used for identity verification
front:
title: Front
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the front side of the document as represented within Checkout.com systems.
back:
title: Back
maxLength: 31
minLength: 31
pattern: ^file_[a-z2-7]{26}$
type: string
description: The ID of the back side of the document as represented within Checkout.com systems.
description: The document to use to confirm the individual's identity.
description: A legal document used to verify identity.
individual:
title: Individual
required:
- first_name
- last_name
- registered_address
- trading_name
type: object
properties:
trading_name:
title: Trading name
maxLength: 300
minLength: 2
type: string
description: The trading name of the sub-entity, also referred to as 'doing business as'.
first_name:
title: First name
maxLength: 50
minLength: 2
type: string
description: The representative's first name.
middle_name:
title: Middle name
maxLength: 50
minLength: 2
type: string
description: The representative's middle name. Required if appears in official docs
last_name:
title: Last name
maxLength: 50
minLength: 2
type: string
description: The representative's last name.
date_of_birth:
title: Date of birth
required:
- day
- month
- year
type: object
properties:
day:
maximum: 31
minimum: 1
type: integer
description: The calendar day of the month they were born.
month:
maximum: 12
minimum: 1
type: integer
description: The month of the year they were born.
year:
maximum: 2999
minimum: 1900
type: integer
description: The year they were born.
description: The date of birth of the person according to the Gregorian calendar.
registered_address:
title: Registered Address
required:
- address_line1
- city
- zip
- country
type: object
properties:
address_line1:
title: Address line 1
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The first line of the address.
address_line2:
title: Address line 2
maxLength: 300
description: The second line of the address.
city:
title: City
maxLength: 300
minLength: 2
type: string
description: The address city.
state:
title: State
maxLength: 300
minLength: 1
pattern: '\S'
type: string
description: The address state. This field is required for addresses based in the US and France. For US addresses, provide the state as an ISO 3166-1 code. For French addresses, provide the Department the address is located in.
zip:
title: UK Postal Code
maxLength: 8
minLength: 5
pattern: ^[A-Za-z]{1,2}([0-9]{1,2}|[0-9][A-Za-z])\s?[0-9][A-Za-z]{2}$
type: string
description: The address zip/postal code.
country:
title: Country
maxLength: 2
minLength: 2
pattern: '[a-zA-Z]{2}'
type: string
description: The country code (iso-3166-1 alpha-2)
format: iso-3166-1-alpha-2
description: The registered address of the company.
description: Information about the individual represented by the sub-entity.
GetScheduleResponse:
type: object
properties:
GBP:
description: The three-letter ISO currency code of the account's currency.
type: object
format: ISO 4217
minLength: 3
maxLength: 3
properties:
recurrence:
type: object
description: Information about how often the schedule takes place.
properties:
enabled:
type: boolean
default: false
description: Indicates the status of the payout schedule.
example: true
threshold:
type: number
description: Minimum available balance on the account to do a payout. If the balance is less than the threshold, then the payout instruction will not send.
example: 100
payment_instrument_id:
type: string
description: The ID of the platforms payment instrument used for payouts on this schedule.
example: ppi_w4jelhppmfiufdnatam37wrfc4
schedule:
type: object
discriminator:
propertyName: frequency
mapping:
weekly: '#/components/schemas/ScheduleFrequencyWeekly'
daily: '#/components/schemas/ScheduleFrequencyDaily'
monthly: '#/components/schemas/ScheduleFrequencyMonthly'
description: Details about the payout schedule. Required if `enabled` is set to `true`.
properties:
frequency:
type: string
enum:
- weekly
- daily
- monthly
description: Used to indicate how often funds should be paid out to a sub-entity.
example: 'weekly'
example:
frequency: 'weekly'
by_day: ['monday']
_links:
additionalProperties:
$ref: '#/components/schemas/Link'
example:
self:
href: 'https://{prefix}.api.checkout.com/accounts/entities/ent_wxglze3wwywujg4nna5fb7ldli'
PlatformsHostedOnboardGetMembers:
type: object
title: Sub-entity members response
properties:
data:
type: array
title: Data
description: The list of members of the sub-entity.
items:
type: object
title: Members
properties:
user_id:
type: string
title: User id
description: The unique ID used to identify a sub-entity member.
example: usr_eyk754cqieqexfh6u46no5nnha
links:
$ref: '#/components/schemas/EntityLinks'
PlatformsHostedOnboardInviteRequest:
type: object
title: Hosted Onboarding Invitation Request
description: |
Beta