Patch Invoice

Headers

Authorization

string

required

Bearer token for authentication

Path Parameters

string

required

Unique identifier of the invoice to be updated.

Body

application/json

Schema for creating a new invoice

data

object

required

Show child attributes

data.type

enum<string>

required

Resource type identifier

Available options:

invoice

data.attributes

object

Invoice attributes and data

Show child attributes

data.attributes.reference_number

string

required

Unique reference number for the invoice

Example:

"INV-2025-001"

data.attributes.document_type_code

string

required

Standard document type code (UN/EDIFACT)

Example:

"380"

data.attributes.local_currency

string

required

Currency code for the invoice (ISO 4217)

Example:

"EUR"

data.attributes.local_totals

object

required

Financial totals for the invoice

Show child attributes

data.attributes.local_totals.items_total

number

required

Subtotal before taxes or discounts

Example:

2500

data.attributes.local_totals.tax_total

number

default:0

Total tax amount

Example:

0

data.attributes.local_totals.grand_total

number

Total after tax/discounts

Example:

50

data.attributes.issue_date

string<date>

Date when the invoice was issued

Example:

"2025-01-15"

data.attributes.due_date

string<date>

Payment due date

Example:

"2025-02-15"

data.attributes.terms

string

Contractual payment terms

Example:

"Net 30"

data.attributes.billing_context

string

Billing context identifier

Example:

"subscription"

data.attributes.payment_status

object

Payment status and amounts

Show child attributes

data.attributes.payment_status.paid

boolean

required

Whether the invoice has been paid

Example:

true

data.attributes.payment_status.local_amount_paid

number

Amount paid in local currency

Example:

3000

data.attributes.payment_status.local_amount_remaining

number

Remaining unpaid amount in local currency

Example:

0

data.attributes.description

string

Invoice description or notes

Example:

"Professional services invoice for January 2025"

data.relationships

object

Relationships with other resources

Show child attributes

data.relationships.issuer

object

required

Company issuing the invoice

Show child attributes

data.relationships.issuer.data

object

required

Show child attributes

data.relationships.issuer.data.type

string

Allowed value: "company"

data.relationships.issuer.data.id

string

UUID of an existing company or temp-id that references a company defined in the included array

Example:

"company-uuid"

data.relationships.receiver

object

required

Company receiving the invoice

Show child attributes

data.relationships.receiver.data

object

required

Show child attributes

data.relationships.receiver.data.type

string

Allowed value: "company"

data.relationships.receiver.data.id

string

UUID of an existing company or temp-id that references a company defined in the included array

Example:

"company-uuid"

data.relationships.payment_means

object

Associated payment methods

Show child attributes

data.relationships.payment_means.data

object[]

Show child attributes

data.relationships.payment_means.data.type

string

Allowed value: "payment_means"

data.relationships.payment_means.data.id

string

UUID of an existing payment means or temp-id that references a payment means defined in the included array

Example:

"pm_1"

data.relationships.invoice_items

object

Line items included in the invoice

Show child attributes

data.relationships.invoice_items.data

object[]

Show child attributes

data.relationships.invoice_items.data.type

string

Allowed value: "invoice_item"

data.relationships.invoice_items.data.id

string

UUID of an existing invoice item or temp-id that references an invoice item defined in the included array

Example:

"pm_1"

data.relationships.documents

object

Supporting documents attached to the invoice

Show child attributes

data.relationships.documents.data

object[]

Show child attributes

data.relationships.documents.data.type

string

Allowed value: "document"

data.relationships.documents.data.id

string

UUID of an existing document or temp-id that references a document defined in the included array

Example:

"doc_original_invoice"

data.relationships.people

object

Show child attributes

data.relationships.people.data

object[]

Option 1
Option 2

Show child attributes

data.relationships.people.data.type

enum<string>

required

Available options:

workspace

data.relationships.people.data.external_workspace_id

string

required

External workspace identifier

data.included

object

Show child attributes

data.included.issuer

object

Show child attributes

data.included.issuer.data

object[]

Show child attributes

data.included.issuer.data.type

string

required

Allowed value: "company"

data.included.issuer.data.id

string

required

Temp-id that references a company in the relationships

Example:

"company-2"

data.included.issuer.data.attributes

object

required

Show child attributes

data.included.issuer.data.attributes.registration

object

required

Option 1
Option 2

Show child attributes

data.included.issuer.data.attributes.registration.registered_name

string

required

Legal company name

Example:

"TechCorp AI Solutions LLC"

data.included.issuer.data.attributes.registration.trade_name

string

Commercial or branding name (if different from registered name).

Example:

"TechSol"

data.included.issuer.data.attributes.locale

string

Language settings.That’s the locale for the business relationship. Emails or documents can be used to identify the locale. Default EN.

Example:

"en-US"

data.included.issuer.data.attributes.domain_name_primary_link_url

string<uri>

The domain url from the website or email address of the company. Used as unique identifier in some cases.

Example:

"https://www.techcorp.com"

data.included.issuer.data.attributes.tax_id

object

Show child attributes

data.included.issuer.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

Example:

"DE123456789"

data.included.issuer.data.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.all tax id types See all available labels for complete list.

Example:

["VAT", "TVA", "IVA", "..."]

data.included.issuer.data.attributes.registration_number

object

Show child attributes

data.included.issuer.data.attributes.registration_number.business_type

enum<string>

Legal entity structure type. See all business entity types for complete list.

Available options:

Inc,

Corp,

LLC,

GmbH,

Ltd,

SA,

SAS

Example:

"GmbH"

data.included.issuer.data.attributes.registration_number.value

string

Official company registration number.

Example:

"HRB 123456"

data.included.issuer.data.attributes.registration_number.registry_name

string

Name of the official registration body. See all available registry name for complete list.

Example:

"Handelsregister Berlin"

data.included.issuer.data.attributes.registration_number.registry_country

string

Country of the registry authority. Must be valid ISO country code

Example:

"DE, FR, US, etc."

data.included.issuer.data.attributes.description

string

Company description explaining business purpose in max 2 sentences.

Required string length: 1 - 500

Example:

"An innovative technology company focused on AI solutions"

data.included.receiver

object

Show child attributes

data.included.receiver.data

object[]

Show child attributes

data.included.receiver.data.type

string

required

Allowed value: "company"

data.included.receiver.data.id

string

required

Temp-id that references a company in the relationships

Example:

"company-2"

data.included.receiver.data.attributes

object

required

Show child attributes

data.included.receiver.data.attributes.registration

object

required

Option 1
Option 2

Show child attributes

data.included.receiver.data.attributes.registration.registered_name

string

required

Legal company name

Example:

"TechCorp AI Solutions LLC"

data.included.receiver.data.attributes.registration.trade_name

string

Commercial or branding name (if different from registered name).

Example:

"TechSol"

data.included.receiver.data.attributes.locale

string

Language settings.That’s the locale for the business relationship. Emails or documents can be used to identify the locale. Default EN.

Example:

"en-US"

data.included.receiver.data.attributes.domain_name_primary_link_url

string<uri>

The domain url from the website or email address of the company. Used as unique identifier in some cases.

Example:

"https://www.techcorp.com"

data.included.receiver.data.attributes.tax_id

object

Show child attributes

data.included.receiver.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

Example:

"DE123456789"

data.included.receiver.data.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.all tax id types See all available labels for complete list.

Example:

["VAT", "TVA", "IVA", "..."]

data.included.receiver.data.attributes.registration_number

object

Show child attributes

data.included.receiver.data.attributes.registration_number.business_type

enum<string>

Legal entity structure type. See all business entity types for complete list.

Available options:

Inc,

Corp,

LLC,

GmbH,

Ltd,

SA,

SAS

Example:

"GmbH"

data.included.receiver.data.attributes.registration_number.value

string

Official company registration number.

Example:

"HRB 123456"

data.included.receiver.data.attributes.registration_number.registry_name

string

Name of the official registration body. See all available registry name for complete list.

Example:

"Handelsregister Berlin"

data.included.receiver.data.attributes.registration_number.registry_country

string

Country of the registry authority. Must be valid ISO country code

Example:

"DE, FR, US, etc."

data.included.receiver.data.attributes.description

string

Company description explaining business purpose in max 2 sentences.

Required string length: 1 - 500

Example:

"An innovative technology company focused on AI solutions"

data.included.payment_means

object

Show child attributes

data.included.payment_means.data

object[]

Show child attributes

data.included.payment_means.data.type

string

required

Allowed value: "payment_means"

data.included.payment_means.data.id

string

required

Temp-id that references a payment means in the relationships

Example:

"pm-1"

data.included.payment_means.data.attributes

object

required

Show child attributes

data.included.payment_means.data.attributes.type

enum<string>

required

Type of payment means. See payment means types for details.

Available options:

card_details,

account_details,

wallet_details,

...

data.included.payment_means.data.attributes.scheme

enum<string>

Payment scheme or network. See scheme types for details.

Available options:

SEPA,

SWIFT,

ACH,

...

data.included.payment_means.data.attributes.status

enum<string>

Current status of the payment means. See payment means status for details.

Available options:

active,

inactive,

pending_verification,

suspended,

expired,

blocked

data.included.payment_means.data.attributes.account_details

object

Bank account details for account_details type

Show child attributes

data.included.payment_means.data.attributes.account_details.iban

string

International Bank Account Number

data.included.payment_means.data.attributes.account_details.bic

string

Bank Identifier Code (SWIFT)

data.included.payment_means.data.attributes.account_details.sort_code

string

Bank sort code (UK)

data.included.payment_means.data.attributes.account_details.account_number

string

Local account number (alternative to IBAN)

data.included.payment_means.data.attributes.account_details.routing_number

string

Bank routing number (US ACH)

data.included.payment_means.data.attributes.account_details.currency

string

Currency code (ISO 4217)

data.included.payment_means.data.attributes.bank_details

object

Additional bank information

Show child attributes

data.included.payment_means.data.attributes.bank_details.bank_name

string

Name of the bank

data.included.payment_means.data.attributes.bank_details.bank_code

string

Bank code or identifier

data.included.payment_means.data.attributes.bank_details.branch_name

string

Bank branch name

data.included.payment_means.data.attributes.bank_details.branch_code

string

Bank branch code

data.included.payment_means.data.attributes.card_details

object

Credit/debit card details for card_details type

Show child attributes

data.included.payment_means.data.attributes.card_details.masked_pan

string

Masked Primary Account Number (PCI DSS compliant)

data.included.payment_means.data.attributes.card_details.brand

enum<string>

Card brand

Available options:

visa,

mastercard,

amex,

discover,

diners,

jcb,

unionpay,

other

data.included.payment_means.data.attributes.card_details.card_type

enum<string>

Type of card

Available options:

credit,

debit,

prepaid,

charge

data.included.payment_means.data.attributes.card_details.expiry_month

integer

Card expiry month

Required range: 1 <= x <= 12

data.included.payment_means.data.attributes.card_details.expiry_year

integer

Card expiry year

Required range: x >= 2024

data.included.payment_means.data.attributes.card_details.cardholder_name

string

Name as printed on card

data.included.payment_means.data.attributes.digital_wallet

object

Digital wallet details for wallet_details type

Show child attributes

data.included.payment_means.data.attributes.digital_wallet.provider

enum<string>

Digital wallet provider

Available options:

paypal,

applepay,

googlepay,

stripe,

square,

venmo,

cashapp,

other

data.included.payment_means.data.attributes.digital_wallet.wallet_id

string

Wallet identifier (email, phone, etc.)

data.included.payment_means.data.attributes.digital_wallet.wallet_type

enum<string>

Type of wallet account

Available options:

personal,

business,

merchant

data.included.payment_means.data.attributes.compliance

object

Compliance and verification status

Show child attributes

data.included.payment_means.data.attributes.compliance.kyc_status

enum<string>

Know Your Customer verification status

Available options:

pending,

in_progress,

completed,

failed,

not_required

data.included.payment_means.data.attributes.compliance.aml_status

enum<string>

Anti-Money Laundering check status

Available options:

pending,

in_progress,

cleared,

flagged,

not_required

data.included.payment_means.data.attributes.nickname

string

User-friendly name for the payment means

Maximum string length: 100

data.included.payment_means.data.attributes.description

string

Additional description of the payment means

Maximum string length: 500

data.included.payment_means.data.attributes.tags

string[]

Tags for categorization

data.included.invoice_items

object

Show child attributes

data.included.invoice_items.data

object[]

Show child attributes

data.included.invoice_items.data.type

string

required

Allowed value: "invoice_item"

data.included.invoice_items.data.id

string

required

Temp-id that references an invoice item in the relationships

Example:

"item-1"

data.included.invoice_items.data.attributes

object

required

Show child attributes

data.included.invoice_items.data.attributes.line_id

string

required

Line identifier within the invoice

Example:

"1"

data.included.invoice_items.data.attributes.name

string

required

Product or service name

Example:

"Wireless Mouse"

data.included.invoice_items.data.attributes.unit_price

number<decimal>

required

Unit price in local currency

Required range: x >= 0

Example:

25

data.included.invoice_items.data.attributes.currency

string

required

ISO 4217 currency code

Example:

"EUR"

data.included.invoice_items.data.attributes.sku

string

Stock Keeping Unit identifier

Example:

"WM-1001"

data.included.invoice_items.data.attributes.description

string

Detailed description of the item

Example:

"Ergonomic wireless mouse with USB receiver"

data.included.invoice_items.data.attributes.unit

enum<string>

Unit of measurement. See all available units for complete list.

Available options:

EA,

HUR,

KGM,

...

Example:

"EA"

data.included.invoice_items.data.attributes.min_quantity

integer

Minimum quantity allowed

Required range: x >= 0

Example:

1

data.included.invoice_items.data.attributes.max_quantity

integer

Maximum quantity allowed

Required range: x >= 1

Example:

500

data.included.invoice_items.data.attributes.tax

object

Show child attributes

data.included.invoice_items.data.attributes.tax.rate

number<decimal>

Tax rate as percentage

Required range: 0 <= x <= 100

Example:

20

data.included.invoice_items.data.attributes.tax.category

enum<string>

Tax category classification. See all tax categories for complete list.

Available options:

standard,

reduced,

exempt,

...

Example:

"standard"

data.included.invoice_items.data.attributes.tax.scheme

enum<string>

Tax scheme classification. See all tax schemes for complete list.

Available options:

VAT,

EU_VAT,

UK_VAT,

...

Example:

"VAT"

data.included.invoice_items.data.attributes.period

object

Show child attributes

data.included.invoice_items.data.attributes.period.start

string<date>

Service period start date

Example:

"2025-06-26"

data.included.invoice_items.data.attributes.period.end

string<date>

Service period end date

Example:

"2025-06-27"

data.included.documents

object

Show child attributes

data.included.documents.data

object[]

Show child attributes

data.included.documents.data.type

string

required

Allowed value: "document"

data.included.documents.data.id

string

required

Temp-id that references a document in the relationships

Example:

"doc-1"

data.included.documents.data.attributes

object

required

Show child attributes

data.included.documents.data.attributes.file_name

string

data.included.documents.data.attributes.status

string

data.included.documents.data.attributes.file_type

string

data.included.documents.data.attributes.size_bytes

integer

data.included.people

object

Show child attributes

data.included.people.data

object[]

Show child attributes

data.included.people.data.type

string

required

Allowed value: "people"

data.included.people.data.id

string

required

Temp-id that references a person in the relationships

Example:

"person-1"

data.included.people.data.attributes

object

required

Show child attributes

data.included.people.data.attributes.first_name

string

required

First name of the person

Required string length: 1 - 50

Example:

"John"

data.included.people.data.attributes.last_name

string

required

Last name of the person (required)

Required string length: 1 - 50

Example:

"Doe"

Response

Invoice updated successfully

data

object

Response schema for successfully created invoice

Show child attributes

data.data

object

Show child attributes

data.data.type

enum<string>

Resource type identifier

Available options:

invoice

data.data.id

string<uuid>

Unique identifier for the created invoice

Example:

"invoice_550e8400-e29b-41d4-a716-446655440000"

data.data.attributes

object

Show child attributes

data.data.attributes.reference_number

string

Unique reference number for the invoice

Example:

"INV-2025-001"

data.data.attributes.document_type

string

Type of invoice document

Example:

"commercial_invoice"

data.data.attributes.document_type_code

string

Standard document type code

Example:

"380"

data.data.attributes.issue_date

string<date>

Date when the invoice was issued

Example:

"2025-01-15"

data.data.attributes.due_date

string<date>

Payment due date

Example:

"2025-02-15"

data.data.attributes.local_currency

string

Currency code for the invoice

Example:

"EUR"

data.data.attributes.local_totals

object

Show child attributes

data.data.attributes.local_totals.subtotal

string

Subtotal before taxes and discounts

Example:

"1000.00"

data.data.attributes.local_totals.tax_total

string

Total tax amount

Example:

"200.00"

data.data.attributes.local_totals.total_amount

string

Final total amount

Example:

"1200.00"

data.data.attributes.terms

string

Contractual payment terms

data.data.attributes.billing_context

string

Billing context identifier

Example:

"subscription"

data.data.attributes.payment_status

object

Show child attributes

data.data.attributes.payment_status.paid

boolean

data.data.attributes.payment_status.amount_paid

number

data.data.attributes.payment_status.amount_remaining

number

data.data.attributes.status

enum<string>

Invoice lifecycle status

Available options:

draft,

sent,

viewed,

accepted,

rejected,

cancelled

Example:

"draft"

data.data.attributes.description

string

Invoice description or notes

Example:

"Professional services invoice for January 2025"

data.data.attributes.created_at

string<date-time>

Timestamp when the invoice was created

Example:

"2025-01-15T10:30:00Z"

data.data.attributes.updated_at

string<date-time>

Timestamp when the invoice was last updated

Example:

"2025-01-15T10:30:00Z"

data.data.relationships

object

Relationships with other resources

Show child attributes

data.data.relationships.issuer

object

Company issuing the invoice

Show child attributes

data.data.relationships.issuer.data

object

Show child attributes

data.data.relationships.issuer.data.type

string

Allowed value: "company"

data.data.relationships.issuer.data.id

string

uuid of company

Example:

"company-uuid"

data.data.relationships.receiver

object

Company receiving the invoice

Show child attributes

data.data.relationships.receiver.data

object

Show child attributes

data.data.relationships.receiver.data.type

string

Allowed value: "company"

data.data.relationships.receiver.data.id

string

uuid of company

Example:

"company-uuid"

data.data.relationships.payment_means

object

Associated payment methods

Show child attributes

data.data.relationships.payment_means.data

object[]

Show child attributes

data.data.relationships.payment_means.data.type

string

Allowed value: "payment_means"

data.data.relationships.payment_means.data.id

string

Example:

"pm_1"

data.data.relationships.invoice_items

object

Line items included in the invoice

Show child attributes

data.data.relationships.invoice_items.data

object[]

Show child attributes

data.data.relationships.invoice_items.data.type

string

Allowed value: "payment_means"

data.data.relationships.invoice_items.data.id

string

Example:

"pm_1"

data.data.relationships.documents

object

Supporting documents attached to the invoice

Show child attributes

data.data.relationships.documents.data

object[][]

Show child attributes

data.data.relationships.documents.data.type

string

Allowed value: "document"

data.data.relationships.documents.data.id

string

Example:

"doc_original_invoice"

data.data.relationships.people

object

Show child attributes

data.data.relationships.people.data

object[]

Show child attributes

data.data.relationships.people.data.type

string

required

Allowed value: "people"

data.data.relationships.people.data.id

string<uuid>

required

UUID of the person

data.data.relationships.people.data.attributes

object

Show child attributes

data.data.relationships.people.data.attributes.first_name

string

data.data.relationships.people.data.attributes.last_name

string

data.data.relationships.people.data.attributes.full_name

string

data.data.relationships.people.data.attributes.email

string<email>

data.data.relationships.people.data.attributes.created_at

string<date-time>

data.data.included

object

Show child attributes

data.data.included.documents

object

Correspondent/intermediary banks for routing (optional)

Show child attributes

data.data.included.documents.data

object

Show child attributes

data.data.included.documents.data.type

string

Allowed value: "company"

data.data.included.documents.data.id

string<uuid>

UUID of the parent company

data.data.included.documents.data.attributes

object

Show child attributes

data.data.included.documents.data.attributes.file_name

string

data.data.included.documents.data.attributes.status

string

data.data.included.documents.data.attributes.uploaded_at

string<date-time>

data.data.included.documents.data.attributes.processed_at

string<date-time>

data.data.included.documents.data.attributes.file_type

string

data.data.included.documents.data.attributes.size_bytes

integer

data.data.included.invoice_items

object

Correspondent/intermediary banks for routing (optional)

Show child attributes

data.data.included.invoice_items.data

object

Show child attributes

data.data.included.invoice_items.data.type

string

Allowed value: "company"

data.data.included.invoice_items.data.id

string<uuid>

UUID of the parent company

data.data.included.invoice_items.data.attributes

object

Show child attributes

data.data.included.invoice_items.data.attributes.line_id

string

Line identifier within the invoice

Example:

"1"

data.data.included.invoice_items.data.attributes.sku

string

Stock Keeping Unit identifier

Example:

"WM-1001"

data.data.included.invoice_items.data.attributes.name

string

Product or service name

Example:

"Wireless Mouse"

data.data.included.invoice_items.data.attributes.description

string

Detailed description of the item

Example:

"Ergonomic wireless mouse with USB receiver"

data.data.included.invoice_items.data.attributes.unit_price

number<decimal>

Unit price in local currency

Required range: x >= 0

Example:

25

data.data.included.invoice_items.data.attributes.currency

string

ISO 4217 currency code

Example:

"EUR"

data.data.included.invoice_items.data.attributes.unit

string

Unit of measurement

Example:

"EA"

data.data.included.invoice_items.data.attributes.min_quantity

integer

Minimum quantity allowed

Required range: x >= 0

Example:

1

data.data.included.invoice_items.data.attributes.max_quantity

integer

Maximum quantity allowed

Required range: x >= 1

Example:

500

data.data.included.invoice_items.data.attributes.tax

object

Show child attributes

data.data.included.invoice_items.data.attributes.tax.rate

number<decimal>

Tax rate as percentage

Required range: 0 <= x <= 100

Example:

20

data.data.included.invoice_items.data.attributes.tax.category

string

Tax category

Example:

"standard"

data.data.included.invoice_items.data.attributes.tax.scheme

string

Tax scheme identifier

Example:

"VAT"

data.data.included.invoice_items.data.attributes.period

object

Show child attributes

data.data.included.invoice_items.data.attributes.period.start

string<date>

Service period start date

Example:

"2025-06-26"

data.data.included.invoice_items.data.attributes.period.end

string<date>

Service period end date

Example:

"2025-06-27"

data.data.included.invoice_items.data.attributes.created_at

string<date-time>

Creation timestamp

Example:

"2025-05-11T13:42:12Z"

data.data.included.invoice_items.data.attributes.updated_at

string<date-time>

Last update timestamp

Example:

"2025-05-11T13:45:20Z"

data.data.included.payment_means

object

Correspondent/intermediary banks for routing (optional)

Show child attributes

data.data.included.payment_means.data

object

Show child attributes

data.data.included.payment_means.data.type

string

Allowed value: "company"

data.data.included.payment_means.data.id

string<uuid>

UUID of the parent company

data.data.included.payment_means.data.attributes

object

Show child attributes

data.data.included.payment_means.data.attributes.type

enum<string>

Type of payment means. See payment means types for details.

Available options:

card_details,

account_details,

wallet_details,

cash_details,

check_details,

crypto_details,

other

data.data.included.payment_means.data.attributes.scheme

enum<string>

Payment scheme or network. See scheme types for details.

Available options:

SEPA,

SWIFT,

ACH,

FASTER_PAYMENTS,

VISA,

MASTERCARD,

AMEX,

PAYPAL,

APPLEPAY,

GOOGLEPAY,

STRIPE,

LOCAL,

OTHER

data.data.included.payment_means.data.attributes.status

enum<string>

Current status of the payment means. See payment means status for details.

Available options:

active,

inactive,

pending_verification,

suspended,

expired,

blocked

data.data.included.payment_means.data.attributes.account_details

object

Bank account details for account_details type

Show child attributes

data.data.included.payment_means.data.attributes.account_details.iban

string

International Bank Account Number

data.data.included.payment_means.data.attributes.account_details.bic

string

Bank Identifier Code (SWIFT)

data.data.included.payment_means.data.attributes.account_details.account_number

string

Local account number (alternative to IBAN)

data.data.included.payment_means.data.attributes.account_details.routing_number

string

Bank routing number (US ACH)

data.data.included.payment_means.data.attributes.account_details.currency

string

Currency code (ISO 4217)

data.data.included.payment_means.data.attributes.bank_details

object

Additional bank information

Show child attributes

data.data.included.payment_means.data.attributes.bank_details.bank_name

string

Name of the bank

data.data.included.payment_means.data.attributes.bank_details.bank_code

string

Bank code or identifier

data.data.included.payment_means.data.attributes.bank_details.branch_name

string

Bank branch name

data.data.included.payment_means.data.attributes.bank_details.branch_code

string

Bank branch code

data.data.included.payment_means.data.attributes.card_details

object

Credit/debit card details for card_details type

Show child attributes

data.data.included.payment_means.data.attributes.card_details.masked_pan

string

Masked Primary Account Number (PCI DSS compliant)

data.data.included.payment_means.data.attributes.card_details.brand

enum<string>

Card brand

Available options:

visa,

mastercard,

amex,

discover,

diners,

jcb,

unionpay,

other

data.data.included.payment_means.data.attributes.card_details.card_type

enum<string>

Type of card

Available options:

credit,

debit,

prepaid,

charge

data.data.included.payment_means.data.attributes.card_details.expiry_month

integer

Card expiry month

data.data.included.payment_means.data.attributes.card_details.expiry_year

integer

Card expiry year

data.data.included.payment_means.data.attributes.card_details.cardholder_name

string

Name as printed on card

data.data.included.payment_means.data.attributes.digital_wallet

object

Digital wallet details for wallet_details type

Show child attributes

data.data.included.payment_means.data.attributes.digital_wallet.provider

enum<string>

Digital wallet provider

Available options:

paypal,

applepay,

googlepay,

stripe,

square,

venmo,

cashapp,

other

data.data.included.payment_means.data.attributes.digital_wallet.wallet_id

string

Wallet identifier (email, phone, etc.)

data.data.included.payment_means.data.attributes.digital_wallet.wallet_type

enum<string>

Type of wallet account

Available options:

personal,

business,

merchant

data.data.included.payment_means.data.attributes.compliance

object

Compliance and verification status

Show child attributes

data.data.included.payment_means.data.attributes.compliance.kyc_status

enum<string>

Know Your Customer verification status

Available options:

pending,

in_progress,

completed,

failed,

not_required

data.data.included.payment_means.data.attributes.compliance.aml_status

enum<string>

Anti-Money Laundering check status

Available options:

pending,

in_progress,

cleared,

flagged,

not_required

data.data.included.payment_means.data.attributes.compliance.sanctions_check

enum<string>

Sanctions screening status

Available options:

pending,

passed,

failed,

not_required

data.data.included.payment_means.data.attributes.compliance.last_compliance_check

string<date-time>

Last compliance check timestamp

data.data.included.payment_means.data.attributes.metadata

object

System metadata

Show child attributes

data.data.included.payment_means.data.attributes.metadata.source

enum<string>

How the payment means was created

Available options:

api,

dashboard,

import,

connector

data.data.included.payment_means.data.attributes.metadata.external_id

string

External system identifier

data.data.included.payment_means.data.attributes.nickname

string

User-friendly name for the payment means

data.data.included.payment_means.data.attributes.description

string

Additional description of the payment means

data.data.included.payment_means.data.attributes.tags

string[]

Tags for categorization

data.data.included.payment_means.data.attributes.created_at

string<date-time>

Creation timestamp

data.data.included.payment_means.data.attributes.updated_at

string<date-time>

Last update timestamp

data.data.included.receiver

object

Correspondent/intermediary banks for routing (optional)

Show child attributes

data.data.included.receiver.data

object

Show child attributes

data.data.included.receiver.data.type

string

Allowed value: "company"

data.data.included.receiver.data.id

string<uuid>

UUID of the parent company

data.data.included.receiver.data.attributes

object

Show child attributes

data.data.included.receiver.data.attributes.description

string

data.data.included.receiver.data.attributes.domain_name_primary_link_url

string<url>

The domain url from the website or email address of the company. Used as unique identifier in some cases.

Maximum string length: 500

data.data.included.receiver.data.attributes.tax_id

object

Show child attributes

data.data.included.receiver.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.data.included.receiver.data.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.

data.data.included.receiver.data.attributes.registration

object

Show child attributes

data.data.included.receiver.data.attributes.registration.trade_name

string

Commercial or branding name (if different from registered name).

data.data.included.receiver.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.data.included.receiver.data.attributes.registration_number

object

Show child attributes

data.data.included.receiver.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.data.included.receiver.data.attributes.registration_number.value

string

Official company registration number.

data.data.included.receiver.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.data.included.receiver.data.attributes.registration_number.registry_country

string

Country of the registry authority. (string (ISO 3166-1 alpha-2))

data.data.included.receiver.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.data.included.receiver.data.attributes.created_at

string<date-time>

data.data.included.receiver.data.attributes.updated_at

string<date-time>

data.data.included.issuer

object

Correspondent/intermediary banks for routing (optional)

Show child attributes

data.data.included.issuer.data

object

Show child attributes

data.data.included.issuer.data.type

string

Allowed value: "company"

data.data.included.issuer.data.id

string<uuid>

UUID of the parent company

data.data.included.issuer.data.attributes

object

Show child attributes

data.data.included.issuer.data.attributes.description

string

data.data.included.issuer.data.attributes.domain_name_primary_link_url

string<url>

The domain url from the website or email address of the company. Used as unique identifier in some cases.

Maximum string length: 500

data.data.included.issuer.data.attributes.tax_id

object

Show child attributes

data.data.included.issuer.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.data.included.issuer.data.attributes.tax_id.type

string

Type of tax ID, useful for applying formatting and validation rules.

data.data.included.issuer.data.attributes.registration

object

Show child attributes

data.data.included.issuer.data.attributes.registration.trade_name

string

Commercial or branding name (if different from registered name).

data.data.included.issuer.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.data.included.issuer.data.attributes.registration_number

object

Show child attributes

data.data.included.issuer.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.data.included.issuer.data.attributes.registration_number.value

string

Official company registration number.

data.data.included.issuer.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.data.included.issuer.data.attributes.registration_number.registry_country

string

Country of the registry authority. (string (ISO 3166-1 alpha-2))

data.data.included.issuer.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.data.included.issuer.data.attributes.created_at

string<date-time>

data.data.included.issuer.data.attributes.updated_at

string<date-time>

Main Resources

Atomic Resources

System

Headers

Path Parameters

Body

Response