Skip to main content
GET
/
v1
/
payment-means
List payment means
curl --request GET \
  --url https://api.wellapp.ai/v1/payment-means \
  --header 'Authorization: <authorization>'
{
  "data": [
    {
      "type": "payment_means",
      "attributes": {
        "type": "account_details",
        "scheme": "ACH",
        "status": "active",
        "account_details": {
          "account_number": "1234567890",
          "routing_number": "021000021",
          "account_type": "checking",
          "currency": "USD"
        },
        "bank_details": {
          "bank_name": "JPMorgan Chase Bank, N.A.",
          "bank_code": "CHASUS33",
          "branch_name": "New York Main Branch",
          "branch_code": "NY001"
        },
        "compliance": {
          "kyc_status": "verified",
          "aml_status": "cleared"
        },
        "nickname": "US Operating Account",
        "description": "Primary USD account for US operations",
        "tags": [
          "usd",
          "operating",
          "us",
          "primary"
        ]
      },
      "relationships": {
        "holder": {
          "data": {
            "type": "company",
            "id": "holder-company-1"
          }
        },
        "account_location": {
          "data": {
            "type": "location",
            "id": "bank-location-1"
          }
        },
        "holder_location": {
          "data": {
            "type": "location",
            "id": "holder-location-1"
          }
        },
        "bank": {
          "data": {
            "type": "company",
            "id": "bank-company-1"
          }
        },
        "intermediary_banks": {
          "data": [
            {
              "type": "company",
              "id": "intermediary-bank-1"
            }
          ]
        },
        "ultimate_beneficiary": {
          "data": {
            "type": "people",
            "id": "beneficiary-person-1"
          }
        },
        "created_by": {
          "data": {
            "type": "people",
            "id": "creator-person-1"
          }
        },
        "documents": {
          "data": [
            {
              "type": "document",
              "id": "bank-statement-1"
            },
            {
              "type": "document",
              "id": "verification-letter-1"
            }
          ]
        },
        "transactions": {
          "data": [
            {
              "type": "transaction",
              "id": "recent-transaction-1"
            }
          ]
        },
        "linked_payment_means": {
          "data": [
            {
              "type": "payment_means",
              "id": "corporate-card-1"
            }
          ]
        }
      },
      "included": [
        {
          "type": "company",
          "id": "holder-company-1",
          "attributes": {
            "name": "ACME Corporation",
            "description": "Technology solutions provider",
            "registration": {
              "registered_name": "ACME Corporation Inc.",
              "trade_name": "ACME"
            },
            "tax_id": {
              "value": "12-3456789",
              "type": "EIN"
            }
          }
        },
        {
          "type": "location",
          "id": "bank-location-1",
          "attributes": {
            "street": "270 Park Avenue",
            "city": "New York",
            "state": "NY",
            "postal_code": "10017",
            "country": "US",
            "is_primary": true
          }
        },
        {
          "type": "location",
          "id": "holder-location-1",
          "attributes": {
            "street": "123 Business Avenue",
            "city": "New York",
            "state": "NY",
            "postal_code": "10001",
            "country": "US",
            "is_primary": true
          }
        },
        {
          "type": "company",
          "id": "bank-company-1",
          "attributes": {
            "name": "JPMorgan Chase Bank",
            "description": "Major US financial institution",
            "registration": {
              "registered_name": "JPMorgan Chase Bank, N.A."
            },
            "tax_id": {
              "value": "13-2624428",
              "type": "EIN"
            }
          }
        },
        {
          "type": "company",
          "id": "intermediary-bank-1",
          "attributes": {
            "name": "Wells Fargo Bank",
            "description": "Intermediary bank for routing",
            "registration": {
              "registered_name": "Wells Fargo Bank, N.A."
            }
          }
        },
        {
          "type": "people",
          "id": "beneficiary-person-1",
          "attributes": {
            "first_name": "Jane",
            "last_name": "Doe",
            "full_name": "Jane Doe",
            "date_of_birth": "1980-05-15"
          }
        },
        {
          "type": "people",
          "id": "creator-person-1",
          "attributes": {
            "first_name": "John",
            "last_name": "Smith",
            "full_name": "John Smith"
          }
        },
        {
          "type": "document",
          "id": "bank-statement-1",
          "attributes": {
            "name": "Bank Statement January 2025.pdf",
            "file_size": 245678,
            "content_type": "application/pdf"
          }
        },
        {
          "type": "document",
          "id": "verification-letter-1",
          "attributes": {
            "name": "Account Verification Letter.pdf",
            "file_size": 123456,
            "content_type": "application/pdf"
          }
        },
        {
          "type": "transaction",
          "id": "recent-transaction-1",
          "attributes": {
            "amount": {
              "value": 5000,
              "currency": "USD"
            },
            "description": "Monthly supplier payment",
            "transaction_date": "2025-01-15T00:00:00.000Z",
            "status": "completed"
          }
        },
        {
          "type": "payment_means",
          "id": "corporate-card-1",
          "attributes": {
            "type": "card",
            "nickname": "Corporate Visa Card",
            "scheme": "visa",
            "status": "active",
            "card_details": {
              "last_four": "1234",
              "expiry_month": 12,
              "expiry_year": 2026,
              "cardholder_name": "ACME CORPORATION"
            }
          }
        }
      ]
    }
  ],
  "meta": {
    "pagination": {
      "total": 1,
      "count": 1,
      "per_page": 25,
      "current_page": 1,
      "total_pages": 1
    }
  }
}

​
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)

​
tags
string

Filter by tags (comma-separated)

​
sort
string
default:-created_at

Sort payment means by fields. Prefix with '-' for descending order. Available fields: created_at, updated_at, nickname, status, scheme, type

​
page[limit]
integer
default:20

Number of payment means to return per page (1-100)

Required range: 1 <= x <= 100
​
page[cursor]
string

Cursor for pagination to get the next page of results

Response

Payment means retrieved successfully

​
data
object