Get Payment Means

Complex Usage Example

Advanced Payment Means Filtering with Full Context

This example demonstrates advanced filtering with multiple parameters, relationship inclusion, compliance filtering, and pagination for retrieving payment means:

curl -X GET "https://api.well.com/v1/payment-means?include=holder,account_location,bank,documents&filter[type]=account_details,card_details&filter[scheme]=SEPA,VISA&filter[status]=active&filter[holder_id]=550e8400-e29b-41d4-a716-446655440001&filter[currency]=EUR&filter[kyc_status]=verified&filter[aml_status]=compliant&filter[is_verified]=true&filter[created_at][from]=2025-01-01T00:00:00Z&filter[created_at][to]=2025-12-31T23:59:59Z&sort=-created_at&page[limit]=25&page[cursor]=eyJjcmVhdGVkX2F0IjoiMjAyNS0xMS0wMlQxMDozMDowMFoiLCJpZCI6InBtLXV1aWQifQ==" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Headers

Authorization

string

required

Bearer token for authentication

Query Parameters

include

string

Comma-separated list of related resources to include with detailed attributes. Available options: holder, account_location, holder_location, bank, intermediary_banks, ultimate_beneficiary, created_by, documents, transactions, linked_payment_means

created_at_from

string<date-time>

Filter payment means created on or after this datetime (ISO 8601 format)

created_at_to

string<date-time>

Filter payment means created on or before this datetime (ISO 8601 format)

updated_at_from

string<date-time>

Filter payment means updated on or after this datetime (ISO 8601 format)

updated_at_to

string<date-time>

Filter payment means updated on or before this datetime (ISO 8601 format)

type

enum<string>

Filter by payment means type. See payment means types for details.

Available options:

card_details,

account_details,

wallet_details,

cash_details,

check_details,

crypto_details,

other

scheme

enum<string>

Filter by 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

status

enum<string>

Filter by payment means status. See payment means status for details.

Available options:

active,

inactive,

pending_verification,

suspended,

expired,

blocked,

failed_verification,

pending_removal,

removed,

archived

currency

string

Filter by currency code (ISO 4217)

holder_id

string<uuid>

Filter by holder ID (company or person)

holder_type

enum<string>

Filter by holder type

Available options:

company,

people

bank_id

string<uuid>

Filter by banking institution ID

bank_name

string

Filter by bank name (partial match)

iban

string

Filter by IBAN (exact match)

bic

string

Filter by BIC/SWIFT code (exact match)

account_number

string

Filter by account number (partial match)

routing_number

string

Filter by routing number (US ACH)

card_brand

enum<string>

Filter by card brand

Available options:

visa,

mastercard,

amex,

discover,

diners,

jcb,

unionpay,

other

card_type

enum<string>

Filter by card type

Available options:

credit,

debit,

prepaid,

charge

wallet_provider

enum<string>

Filter by digital wallet provider

Available options:

paypal,

applepay,

googlepay,

stripe,

square,

venmo,

cashapp,

other

is_primary

boolean

Filter by primary payment means status

is_verified

boolean

Filter by verification status

kyc_status

enum<string>

Filter by KYC verification status

Available options:

pending,

in_progress,

completed,

failed,

not_required

aml_status

enum<string>

Filter by AML check status

Available options:

pending,

in_progress,

cleared,

flagged,

not_required

sanctions_check

enum<string>

Filter by sanctions screening status

Available options:

pending,

passed,

failed,

not_required

account_location_id

string<uuid>

Filter by account location ID

holder_location_id

string<uuid>

Filter by holder location ID

created_by_id

string<uuid>

Filter by creator user ID

workspace_id

string<uuid>

Filter by workspace ID

external_workspace_id

string

Filter by external workspace identifier

nickname

string

Filter by nickname (partial match)

Response

Payment means retrieved successfully

data

object

Show child attributes

data.type

string

Allowed value: "payment_means"

data.id

string<uuid>

data.attributes

object

Show child attributes

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.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.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.attributes.account_details

object

Bank account details for account_details type

Show child attributes

data.attributes.account_details.iban

string

International Bank Account Number

data.attributes.account_details.bic

string

Bank Identifier Code (SWIFT)

data.attributes.account_details.account_number

string

Local account number (alternative to IBAN)

data.attributes.account_details.routing_number

string

Bank routing number (US ACH)

data.attributes.account_details.currency

string

Currency code (ISO 4217)

data.attributes.bank_details

object

Additional bank information

Show child attributes

data.attributes.bank_details.bank_name

string

Name of the bank

data.attributes.bank_details.bank_code

string

Bank code or identifier

data.attributes.bank_details.branch_name

string

Bank branch name

data.attributes.bank_details.branch_code

string

Bank branch code

data.attributes.card_details

object

Credit/debit card details for card_details type

Show child attributes

data.attributes.card_details.masked_pan

string

Masked Primary Account Number (PCI DSS compliant)

data.attributes.card_details.brand

enum<string>

Card brand

Available options:

visa,

mastercard,

amex,

discover,

diners,

jcb,

unionpay,

other

data.attributes.card_details.card_type

enum<string>

Type of card

Available options:

credit,

debit,

prepaid,

charge

data.attributes.card_details.expiry_month

integer

Card expiry month

data.attributes.card_details.expiry_year

integer

Card expiry year

data.attributes.card_details.cardholder_name

string

Name as printed on card

data.attributes.digital_wallet

object

Digital wallet details for wallet_details type

Show child attributes

data.attributes.digital_wallet.provider

enum<string>

Digital wallet provider

Available options:

paypal,

applepay,

googlepay,

stripe,

square,

venmo,

cashapp,

other

data.attributes.digital_wallet.wallet_id

string

Wallet identifier (email, phone, etc.)

data.attributes.digital_wallet.wallet_type

enum<string>

Type of wallet account

Available options:

personal,

business,

merchant

data.attributes.compliance

object

Compliance and verification status

Show child attributes

data.attributes.compliance.kyc_status

enum<string>

Know Your Customer verification status

Available options:

pending,

in_progress,

completed,

failed,

not_required

data.attributes.compliance.aml_status

enum<string>

Anti-Money Laundering check status

Available options:

pending,

in_progress,

cleared,

flagged,

not_required

data.attributes.compliance.sanctions_check

enum<string>

Sanctions screening status

Available options:

pending,

passed,

failed,

not_required

data.attributes.compliance.last_compliance_check

string<date-time>

Last compliance check timestamp

data.attributes.metadata

object

System metadata

Show child attributes

data.attributes.metadata.source

enum<string>

How the payment means was created

Available options:

api,

dashboard,

import,

connector

data.attributes.metadata.external_id

string

External system identifier

data.attributes.nickname

string

User-friendly name for the payment means

data.attributes.description

string

Additional description of the payment means

data.attributes.tags

string[]

Tags for categorization

data.attributes.created_at

string<date-time>

Creation timestamp

data.attributes.updated_at

string<date-time>

Last update timestamp

data.relationships

object

Show child attributes

data.relationships.holder

object

Account/payment method owner

Show child attributes

data.relationships.holder.data

object

Show child attributes

data.relationships.holder.data.type

enum<string>

Available options:

company,

people

data.relationships.holder.data.id

string<uuid>

data.relationships.account_location

object

Bank branch or account location

Show child attributes

data.relationships.account_location.data

object

Show child attributes

data.relationships.account_location.data.type

string

Allowed value: "location"

data.relationships.account_location.data.id

string<uuid>

data.relationships.holder_location

object

Account holder's address

Show child attributes

data.relationships.holder_location.data

object

Show child attributes

data.relationships.holder_location.data.type

string

Allowed value: "location"

data.relationships.holder_location.data.id

string<uuid>

data.relationships.bank

object

Banking institution

Show child attributes

data.relationships.bank.data

object

Show child attributes

data.relationships.bank.data.type

string

Allowed value: "company"

data.relationships.bank.data.id

string<uuid>

data.relationships.intermediary_banks

object

Correspondent/intermediary banks for routing

Show child attributes

data.relationships.intermediary_banks.data

object[]

Show child attributes

data.relationships.intermediary_banks.data.type

string

Allowed value: "company"

data.relationships.intermediary_banks.data.id

string<uuid>

data.relationships.ultimate_beneficiary

object

Ultimate beneficial owner if different from holder

Show child attributes

data.relationships.ultimate_beneficiary.data

object

Show child attributes

data.relationships.ultimate_beneficiary.data.type

enum<string>

Available options:

company,

people

data.relationships.ultimate_beneficiary.data.id

string<uuid>

data.relationships.created_by

object

User who created this record

Show child attributes

data.relationships.created_by.data

object

Show child attributes

data.relationships.created_by.data.type

string

Allowed value: "people"

data.relationships.created_by.data.id

string<uuid>

data.relationships.documents

object

Supporting documents (statements, verifications)

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>

data.relationships.transactions

object

Related transactions using this payment means

Show child attributes

data.relationships.transactions.data

object[]

Show child attributes

data.relationships.transactions.data.type

string

Allowed value: "transaction"

data.relationships.transactions.data.id

string<uuid>

data.relationships.linked_payment_means

object

Related payment methods (e.g., cards linked to account)

Show child attributes

data.relationships.linked_payment_means.data

object[]

Show child attributes

data.relationships.linked_payment_means.data.type

string

Allowed value: "payment_means"

data.relationships.linked_payment_means.data.id

string<uuid>

data.included

object

Show child attributes

data.included.holder

object

Account/payment method owner (required)

Option 1
Option 2

Show child attributes

data.included.holder.data

object

Show child attributes

data.included.holder.data.type

string

Allowed value: "people"

data.included.holder.data.id

string<uuid>

UUID of the person

data.included.holder.data.attributes

object

Show child attributes

data.included.holder.data.attributes.first_name

string

The person's first name

data.included.holder.data.attributes.last_name

string

The person's last name

data.included.holder.data.attributes.full_name

string

The person's full name (typically first_name + last_name)

data.included.holder.data.attributes.created_at

string<date-time>

Timestamp when the person was created

data.included.holder.data.attributes.updated_at

string<date-time>

Timestamp when the person was last updated

data.included.account_location

object

Locations/addresses associated of the account

Show child attributes

data.included.account_location.data

object[]

Show child attributes

data.included.account_location.data.type

string

Allowed value: "location"

data.included.account_location.data.id

string<uuid>

ID of the location

data.included.account_location.data.attributes

object

Show child attributes

data.included.account_location.data.attributes.full_address

string

Complete formatted address

data.included.account_location.data.attributes.address_line1

string

Primary address line

data.included.account_location.data.attributes.address_line2

string

Secondary address line

data.included.account_location.data.attributes.city

string

City name

data.included.account_location.data.attributes.region

string

State, province, or region

data.included.account_location.data.attributes.postal_code

string

Postal or ZIP code

data.included.account_location.data.attributes.country

string

Two-letter ISO country code

data.included.account_location.data.attributes.latitude

number<float>

Geographic latitude coordinate

data.included.account_location.data.attributes.longitude

number<float>

Geographic longitude coordinate

data.included.account_location.data.attributes.is_primary

boolean

Whether this is the primary location

data.included.account_location.data.attributes.is_registered

boolean

Whether this is a registered business address

data.included.account_location.data.attributes.label

string

Custom label for the location

data.included.account_location.data.attributes.created_at

string<date-time>

Date and time when the location was created

data.included.account_location.data.attributes.updated_at

string<date-time>

Date and time when the location was last updated

data.included.holder_location

object

Locations/addresses associated of the holder

Show child attributes

data.included.holder_location.data

object[]

Show child attributes

data.included.holder_location.data.type

string

Allowed value: "location"

data.included.holder_location.data.id

string<uuid>

ID of the location

data.included.holder_location.data.attributes

object

Show child attributes

data.included.holder_location.data.attributes.full_address

string

Complete formatted address

data.included.holder_location.data.attributes.address_line1

string

Primary address line

data.included.holder_location.data.attributes.address_line2

string

Secondary address line

data.included.holder_location.data.attributes.city

string

City name

data.included.holder_location.data.attributes.region

string

State, province, or region

data.included.holder_location.data.attributes.postal_code

string

Postal or ZIP code

data.included.holder_location.data.attributes.country

string

Two-letter ISO country code

data.included.holder_location.data.attributes.latitude

number<float>

Geographic latitude coordinate

data.included.holder_location.data.attributes.longitude

number<float>

Geographic longitude coordinate

data.included.holder_location.data.attributes.is_primary

boolean

Whether this is the primary location

data.included.holder_location.data.attributes.is_registered

boolean

Whether this is a registered business address

data.included.holder_location.data.attributes.label

string

Custom label for the location

data.included.holder_location.data.attributes.created_at

string<date-time>

Date and time when the location was created

data.included.holder_location.data.attributes.updated_at

string<date-time>

Date and time when the location was last updated

data.included.bank

object

bank

Show child attributes

data.included.bank.data

object

Show child attributes

data.included.bank.data.type

string

Allowed value: "company"

data.included.bank.data.id

string<uuid>

UUID of the parent company

data.included.bank.data.attributes

object

Show child attributes

data.included.bank.data.attributes.description

string

data.included.bank.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.included.bank.data.attributes.tax_id

object

Show child attributes

data.included.bank.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.included.bank.data.attributes.tax_id.type

string

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

data.included.bank.data.attributes.registration

object

Show child attributes

data.included.bank.data.attributes.registration.trade_name

string

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

data.included.bank.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.included.bank.data.attributes.registration_number

object

Show child attributes

data.included.bank.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.included.bank.data.attributes.registration_number.value

string

Official company registration number.

data.included.bank.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.included.bank.data.attributes.registration_number.registry_country

string

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

data.included.bank.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.included.bank.data.attributes.created_at

string<date-time>

data.included.bank.data.attributes.updated_at

string<date-time>

data.included.intermediary_banks

object

Correspondent/intermediary banks for routing (optional)

Show child attributes

data.included.intermediary_banks.data

object

Show child attributes

data.included.intermediary_banks.data.type

string

Allowed value: "company"

data.included.intermediary_banks.data.id

string<uuid>

UUID of the parent company

data.included.intermediary_banks.data.attributes

object

Show child attributes

data.included.intermediary_banks.data.attributes.description

string

data.included.intermediary_banks.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.included.intermediary_banks.data.attributes.tax_id

object

Show child attributes

data.included.intermediary_banks.data.attributes.tax_id.value

string

Tax ID issued by local or national tax authority.

data.included.intermediary_banks.data.attributes.tax_id.type

string

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

data.included.intermediary_banks.data.attributes.registration

object

Show child attributes

data.included.intermediary_banks.data.attributes.registration.trade_name

string

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

data.included.intermediary_banks.data.attributes.registration.registered_name

string

Legal company name.

Required string length: 1 - 100

data.included.intermediary_banks.data.attributes.registration_number

object

Show child attributes

data.included.intermediary_banks.data.attributes.registration_number.business_type

string

Legal entity structure type.

data.included.intermediary_banks.data.attributes.registration_number.value

string

Official company registration number.

data.included.intermediary_banks.data.attributes.registration_number.registry_name

string

Name of the official registration body.

data.included.intermediary_banks.data.attributes.registration_number.registry_country

string

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

data.included.intermediary_banks.data.attributes.workspace_id

string<uuid>

UUID of the workspace associated with this company

data.included.intermediary_banks.data.attributes.created_at

string<date-time>

data.included.intermediary_banks.data.attributes.updated_at

string<date-time>

data.included.ultimate_beneficiary

object

Ultimate beneficial owner if different from holder (optional)

Option 1
Option 2

Show child attributes

data.included.ultimate_beneficiary.data

object

Show child attributes

data.included.ultimate_beneficiary.data.type

string

Allowed value: "people"

data.included.ultimate_beneficiary.data.id

string<uuid>

UUID of the person

data.included.ultimate_beneficiary.data.attributes

object

Show child attributes

data.included.ultimate_beneficiary.data.attributes.first_name

string

The person's first name

data.included.ultimate_beneficiary.data.attributes.last_name

string

The person's last name

data.included.ultimate_beneficiary.data.attributes.full_name

string

The person's full name (typically first_name + last_name)

data.included.ultimate_beneficiary.data.attributes.created_at

string<date-time>

Timestamp when the person was created

data.included.ultimate_beneficiary.data.attributes.updated_at

string<date-time>

Timestamp when the person was last updated

data.included.created_by

object

Person who created this company

Show child attributes

data.included.created_by.data

object

Show child attributes

data.included.created_by.data.type

string

Allowed value: "people"

data.included.created_by.data.id

string<uuid>

UUID of the person

data.included.created_by.data.attributes

object

Show child attributes

data.included.created_by.data.attributes.first_name

string

The person's first name

data.included.created_by.data.attributes.last_name

string

The person's last name

data.included.created_by.data.attributes.full_name

string

The person's full name (typically first_name + last_name)

data.included.created_by.data.attributes.created_at

string<date-time>

Timestamp when the person was created

data.included.created_by.data.attributes.updated_at

string<date-time>

Timestamp when the person was last updated

data.included.documents

object

Supporting documents (statements, verifications) (optional)

Show child attributes

data.included.documents.data

object[]

Show child attributes

data.included.documents.data.type

string

Allowed value: "document"

data.included.documents.data.id

string<uuid>

UUID of the document

data.included.documents.data.attributes

object

Show child attributes

data.included.documents.data.attributes.file_name

string

data.included.documents.data.attributes.status

string

data.included.documents.data.attributes.uploaded_at

string<date-time>

data.included.documents.data.attributes.processed_at

string<date-time>

data.included.documents.data.attributes.file_type

string

data.included.documents.data.attributes.size_bytes

integer

data.included.transaction

object

Supporting documents (statements, verifications) (optional)

Show child attributes

data.included.transaction.data

object[]

Show child attributes

data.included.transaction.data.type

string

Allowed value: "document"

data.included.transaction.data.id

string<uuid>

UUID of the document

data.included.transaction.data.attributes

object

Show child attributes

data.included.transaction.data.attributes.scheme

enum<string>

Payment scheme used for the transaction

Available options:

sepa,

swift,

ach,

faster_payments,

instant_credit_transfer

data.included.transaction.data.attributes.external_ids

object

Show child attributes

data.included.transaction.data.attributes.external_ids.transaction_id

string

External transaction identifier from payment provider

data.included.transaction.data.attributes.external_ids.payment_request_id

string

Payment request identifier

data.included.transaction.data.attributes.external_ids.end_to_end_id

string

End-to-end reference for tracing the transaction

data.included.transaction.data.attributes.requested_execution_date

string<date>

Date when transaction execution was requested

data.included.transaction.data.attributes.executed_at

string<date-time>

Timestamp when transaction was executed

data.included.transaction.data.attributes.booking_date

string<date>

Date when transaction was booked

data.included.transaction.data.attributes.value_date

string<date>

Value date of the transaction

data.included.transaction.data.attributes.instructed_amount

object

Show child attributes

data.included.transaction.data.attributes.instructed_amount.currency

string

ISO 4217 currency code

data.included.transaction.data.attributes.instructed_amount.amount

number

Amount instructed for the transaction

Required range: x >= 0

data.included.transaction.data.attributes.settlement_amount

object

Show child attributes

data.included.transaction.data.attributes.settlement_amount.currency

string

ISO 4217 currency code

data.included.transaction.data.attributes.settlement_amount.amount

number

Amount settled for the transaction

Required range: x >= 0

data.included.transaction.data.attributes.foreign_exchange

object

Show child attributes

data.included.transaction.data.attributes.foreign_exchange.currency_rate

string

Exchange rate applied

data.included.transaction.data.attributes.foreign_exchange.currency_pair

string

Currency pair (e.g., EURUSD)

data.included.transaction.data.attributes.foreign_exchange.currency_rate_source

string

Source of the exchange rate

data.included.transaction.data.attributes.foreign_exchange.currency_rate_at

string<date-time>

Timestamp when exchange rate was applied

data.included.transaction.data.attributes.transaction_type

enum<string>

Type of transaction. See transaction types documentation for complete list.

Available options:

payment,

transfer,

deposit,

withdrawal,

card_payment,

direct_debit,

refund,

fee,

interest,

other

data.included.transaction.data.attributes.status

enum<string>

Current status of the transaction

Available options:

pending,

completed,

failed,

cancelled,

rejected

data.included.transaction.data.attributes.category_purpose

string

ISO 20022 category purpose code

data.included.transaction.data.attributes.purpose_code

string

ISO 20022 purpose code

data.included.transaction.data.attributes.remittance_information

object

Show child attributes

data.included.transaction.data.attributes.remittance_information.unstructured

string

Unstructured remittance information

data.included.transaction.data.attributes.remittance_information.structured_reference

string

Structured creditor reference

data.included.transaction.data.attributes.remittance_information.reference_type

enum<string>

Type of structured reference. See remittance reference types for details.

Available options:

SCOR,

RADM,

RPIN,

FXDR,

DISP,

PUOR,

SCNR

data.included.transaction.data.attributes.fees

object[]

Show child attributes

data.included.transaction.data.attributes.fees.type

enum<string>

Type of fee. See banking transaction fees for details.

Available options:

transfer_fee,

exchange_fee,

processing_fee,

commission

data.included.transaction.data.attributes.fees.amount

number

Fee amount

Required range: x >= 0

data.included.transaction.data.attributes.fees.currency

string

ISO 4217 currency code

data.included.transaction.data.attributes.created_at

string<date-time>

Timestamp when transaction was created

data.included.transaction.data.attributes.updated_at

string<date-time>

Timestamp when transaction was last updated

data.included.linked_payment_means

object

Supporting documents (statements, verifications) (optional)

Show child attributes

data.included.linked_payment_means.data

object[]

Show child attributes

data.included.linked_payment_means.data.type

string

Allowed value: "document"

data.included.linked_payment_means.data.id

string<uuid>

UUID of the document

data.included.linked_payment_means.data.attributes

object

Show child attributes

data.included.linked_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.included.linked_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.included.linked_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.linked_payment_means.data.attributes.account_details

object

Bank account details for account_details type

Show child attributes

data.included.linked_payment_means.data.attributes.account_details.iban

string

International Bank Account Number

data.included.linked_payment_means.data.attributes.account_details.bic

string

Bank Identifier Code (SWIFT)

data.included.linked_payment_means.data.attributes.account_details.account_number

string

Local account number (alternative to IBAN)

data.included.linked_payment_means.data.attributes.account_details.routing_number

string

Bank routing number (US ACH)

data.included.linked_payment_means.data.attributes.account_details.currency

string

Currency code (ISO 4217)

data.included.linked_payment_means.data.attributes.bank_details

object

Additional bank information

Show child attributes

data.included.linked_payment_means.data.attributes.bank_details.bank_name

string

Name of the bank

data.included.linked_payment_means.data.attributes.bank_details.bank_code

string

Bank code or identifier

data.included.linked_payment_means.data.attributes.bank_details.branch_name

string

Bank branch name

data.included.linked_payment_means.data.attributes.bank_details.branch_code

string

Bank branch code

data.included.linked_payment_means.data.attributes.card_details

object

Credit/debit card details for card_details type

Show child attributes

data.included.linked_payment_means.data.attributes.card_details.masked_pan

string

Masked Primary Account Number (PCI DSS compliant)

data.included.linked_payment_means.data.attributes.card_details.brand

enum<string>

Card brand

Available options:

visa,

mastercard,

amex,

discover,

diners,

jcb,

unionpay,

other

data.included.linked_payment_means.data.attributes.card_details.card_type

enum<string>

Type of card

Available options:

credit,

debit,

prepaid,

charge

data.included.linked_payment_means.data.attributes.card_details.expiry_month

integer

Card expiry month

data.included.linked_payment_means.data.attributes.card_details.expiry_year

integer

Card expiry year

data.included.linked_payment_means.data.attributes.card_details.cardholder_name

string

Name as printed on card

data.included.linked_payment_means.data.attributes.digital_wallet

object

Digital wallet details for wallet_details type

Show child attributes

data.included.linked_payment_means.data.attributes.digital_wallet.provider

enum<string>

Digital wallet provider

Available options:

paypal,

applepay,

googlepay,

stripe,

square,

venmo,

cashapp,

other

data.included.linked_payment_means.data.attributes.digital_wallet.wallet_id

string

Wallet identifier (email, phone, etc.)

data.included.linked_payment_means.data.attributes.digital_wallet.wallet_type

enum<string>

Type of wallet account

Available options:

personal,

business,

merchant

data.included.linked_payment_means.data.attributes.compliance

object

Compliance and verification status

Show child attributes

data.included.linked_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.linked_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.linked_payment_means.data.attributes.compliance.sanctions_check

enum<string>

Sanctions screening status

Available options:

pending,

passed,

failed,

not_required

data.included.linked_payment_means.data.attributes.compliance.last_compliance_check

string<date-time>

Last compliance check timestamp

data.included.linked_payment_means.data.attributes.metadata

object

System metadata

Show child attributes

data.included.linked_payment_means.data.attributes.metadata.source

enum<string>

How the payment means was created

Available options:

api,

dashboard,

import,

connector

data.included.linked_payment_means.data.attributes.metadata.external_id

string

External system identifier

data.included.linked_payment_means.data.attributes.nickname

string

User-friendly name for the payment means

data.included.linked_payment_means.data.attributes.description

string

Additional description of the payment means

data.included.linked_payment_means.data.attributes.tags

string[]

Tags for categorization

data.included.linked_payment_means.data.attributes.created_at

string<date-time>

Creation timestamp

data.included.linked_payment_means.data.attributes.updated_at

string<date-time>

Last update timestamp

Main Resources

Atomic Resources

System

Complex Usage Example

Advanced Payment Means Filtering with Full Context

Headers

Query Parameters

Response

Main Resources

Atomic Resources

System

​Complex Usage Example

​Advanced Payment Means Filtering with Full Context

Headers

Query Parameters

Response

Complex Usage Example

Advanced Payment Means Filtering with Full Context