Main Resources
Atomic Resources
System
curl --request GET \
--url https://api.wellapp.ai/v1/payment-means/{id} \
--header 'Authorization: <authorization>'{
"data": {
"type": "payment_means",
"id": "550e8400-e29b-41d4-a716-446655440010",
"attributes": {
"type": "account_details",
"scheme": "SEPA",
"status": "active",
"currency": "EUR",
"is_primary": true,
"is_verified": true,
"nickname": "Main Business Account",
"account_details": {
"iban": "FR14**********************5678",
"bic": "BNPAFRPP",
"account_holder_name": "ACME Corporation",
"bank_name": "BNP Paribas"
},
"compliance": {
"kyc_status": "verified",
"aml_status": "compliant",
"sanctions_check": "passed",
"last_compliance_check": "2024-06-01T10:00:00Z"
},
"verification": {
"verified_at": "2024-05-15T09:30:00Z",
"verification_method": "bank_statement",
"next_verification_due": "2025-05-15T09:30:00Z"
},
"usage_stats": {
"total_transactions": 156,
"total_amount": 45620.89,
"last_used": "2024-06-14T16:45:00Z"
},
"tags": [
"business",
"primary",
"verified"
],
"created_at": "2024-05-15T08:30:00Z",
"updated_at": "2024-06-01T10:00:00Z"
},
"relationships": {
"holder": {
"data": {
"type": "companies",
"id": "holder-company-uuid"
}
},
"account_location": {
"data": {
"type": "locations",
"id": "location-france-uuid"
}
},
"bank": {
"data": {
"type": "companies",
"id": "bnp-paribas-uuid"
}
},
"documents": {
"data": [
{
"type": "documents",
"id": "bank-statement-uuid"
},
{
"type": "documents",
"id": "kyc-document-uuid"
}
]
}
}
},
"included": [
{
"type": "companies",
"id": "holder-company-uuid",
"attributes": {
"name": "ACME Corporation",
"registration_number": "123456789",
"country": "France"
}
},
{
"type": "locations",
"id": "location-france-uuid",
"attributes": {
"country": "France",
"city": "Paris",
"address": "123 Rue de la Paix"
}
},
{
"type": "companies",
"id": "bnp-paribas-uuid",
"attributes": {
"name": "BNP Paribas",
"bic": "BNPAFRPP",
"country": "France"
}
}
]
}Get Payment Mean by id
Retrieve a specific payment method or account by its unique identifier.
curl --request GET \
--url https://api.wellapp.ai/v1/payment-means/{id} \
--header 'Authorization: <authorization>'{
"data": {
"type": "payment_means",
"id": "550e8400-e29b-41d4-a716-446655440010",
"attributes": {
"type": "account_details",
"scheme": "SEPA",
"status": "active",
"currency": "EUR",
"is_primary": true,
"is_verified": true,
"nickname": "Main Business Account",
"account_details": {
"iban": "FR14**********************5678",
"bic": "BNPAFRPP",
"account_holder_name": "ACME Corporation",
"bank_name": "BNP Paribas"
},
"compliance": {
"kyc_status": "verified",
"aml_status": "compliant",
"sanctions_check": "passed",
"last_compliance_check": "2024-06-01T10:00:00Z"
},
"verification": {
"verified_at": "2024-05-15T09:30:00Z",
"verification_method": "bank_statement",
"next_verification_due": "2025-05-15T09:30:00Z"
},
"usage_stats": {
"total_transactions": 156,
"total_amount": 45620.89,
"last_used": "2024-06-14T16:45:00Z"
},
"tags": [
"business",
"primary",
"verified"
],
"created_at": "2024-05-15T08:30:00Z",
"updated_at": "2024-06-01T10:00:00Z"
},
"relationships": {
"holder": {
"data": {
"type": "companies",
"id": "holder-company-uuid"
}
},
"account_location": {
"data": {
"type": "locations",
"id": "location-france-uuid"
}
},
"bank": {
"data": {
"type": "companies",
"id": "bnp-paribas-uuid"
}
},
"documents": {
"data": [
{
"type": "documents",
"id": "bank-statement-uuid"
},
{
"type": "documents",
"id": "kyc-document-uuid"
}
]
}
}
},
"included": [
{
"type": "companies",
"id": "holder-company-uuid",
"attributes": {
"name": "ACME Corporation",
"registration_number": "123456789",
"country": "France"
}
},
{
"type": "locations",
"id": "location-france-uuid",
"attributes": {
"country": "France",
"city": "Paris",
"address": "123 Rue de la Paix"
}
},
{
"type": "companies",
"id": "bnp-paribas-uuid",
"attributes": {
"name": "BNP Paribas",
"bic": "BNPAFRPP",
"country": "France"
}
}
]
}Headers
Bearer token for authentication
Path Parameters
The unique identifier of the payment means to retrieve
Query Parameters
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
Response
Payment means retrieved successfully
Show child attributes
Show child attributes
"payment_means"Show child attributes
Show child attributes
Type of payment means. See payment means types for details.
card_details, account_details, wallet_details, cash_details, check_details, crypto_details, other Payment scheme or network. See scheme types for details.
SEPA, SWIFT, ACH, FASTER_PAYMENTS, VISA, MASTERCARD, AMEX, PAYPAL, APPLEPAY, GOOGLEPAY, STRIPE, LOCAL, OTHER Current status of the payment means. See payment means status for details.
active, inactive, pending_verification, suspended, expired, blocked Bank account details for account_details type
Show child attributes
Show child attributes
International Bank Account Number
Bank Identifier Code (SWIFT)
Local account number (alternative to IBAN)
Bank routing number (US ACH)
Currency code (ISO 4217)
Additional bank information
Credit/debit card details for card_details type
Show child attributes
Show child attributes
Masked Primary Account Number (PCI DSS compliant)
Card brand
visa, mastercard, amex, discover, diners, jcb, unionpay, other Type of card
credit, debit, prepaid, charge Card expiry month
Card expiry year
Name as printed on card
Digital wallet details for wallet_details type
Show child attributes
Show child attributes
Digital wallet provider
paypal, applepay, googlepay, stripe, square, venmo, cashapp, other Wallet identifier (email, phone, etc.)
Type of wallet account
personal, business, merchant Compliance and verification status
Show child attributes
Show child attributes
Know Your Customer verification status
pending, in_progress, completed, failed, not_required Anti-Money Laundering check status
pending, in_progress, cleared, flagged, not_required Sanctions screening status
pending, passed, failed, not_required Last compliance check timestamp
User-friendly name for the payment means
Additional description of the payment means
Tags for categorization
Creation timestamp
Last update timestamp
Show child attributes
Show child attributes
Ultimate beneficial owner if different from holder
Show child attributes
Show child attributes
Account/payment method owner (required)
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"people"UUID of the person
Show child attributes
Show child attributes
The person's first name
The person's last name
The person's full name (typically first_name + last_name)
Timestamp when the person was created
Timestamp when the person was last updated
Locations/addresses associated of the account
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"location"ID of the location
Show child attributes
Show child attributes
Complete formatted address
Primary address line
Secondary address line
City name
State, province, or region
Postal or ZIP code
Two-letter ISO country code
Geographic latitude coordinate
Geographic longitude coordinate
Whether this is the primary location
Whether this is a registered business address
Custom label for the location
Date and time when the location was created
Date and time when the location was last updated
Locations/addresses associated of the holder
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"location"ID of the location
Show child attributes
Show child attributes
Complete formatted address
Primary address line
Secondary address line
City name
State, province, or region
Postal or ZIP code
Two-letter ISO country code
Geographic latitude coordinate
Geographic longitude coordinate
Whether this is the primary location
Whether this is a registered business address
Custom label for the location
Date and time when the location was created
Date and time when the location was last updated
bank
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"company"UUID of the parent company
Show child attributes
Show child attributes
The domain url from the website or email address of the company. Used as unique identifier in some cases.
500Show child attributes
Show child attributes
Legal entity structure type.
Official company registration number.
Name of the official registration body.
Country of the registry authority. (string (ISO 3166-1 alpha-2))
UUID of the workspace associated with this company
Correspondent/intermediary banks for routing (optional)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"company"UUID of the parent company
Show child attributes
Show child attributes
The domain url from the website or email address of the company. Used as unique identifier in some cases.
500Show child attributes
Show child attributes
Legal entity structure type.
Official company registration number.
Name of the official registration body.
Country of the registry authority. (string (ISO 3166-1 alpha-2))
UUID of the workspace associated with this company
Ultimate beneficial owner if different from holder (optional)
- Option 1
- Option 2
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"people"UUID of the person
Show child attributes
Show child attributes
The person's first name
The person's last name
The person's full name (typically first_name + last_name)
Timestamp when the person was created
Timestamp when the person was last updated
Person who created this company
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"people"UUID of the person
Show child attributes
Show child attributes
The person's first name
The person's last name
The person's full name (typically first_name + last_name)
Timestamp when the person was created
Timestamp when the person was last updated
Supporting documents (statements, verifications) (optional)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"document"UUID of the document
Show child attributes
Show child attributes
Supporting documents (statements, verifications) (optional)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"document"UUID of the document
Show child attributes
Show child attributes
Payment scheme used for the transaction
sepa, swift, ach, faster_payments, instant_credit_transfer Show child attributes
Show child attributes
External transaction identifier from payment provider
Payment request identifier
End-to-end reference for tracing the transaction
Date when transaction execution was requested
Timestamp when transaction was executed
Date when transaction was booked
Value date of the transaction
Show child attributes
Show child attributes
Exchange rate applied
Currency pair (e.g., EURUSD)
Source of the exchange rate
Timestamp when exchange rate was applied
Type of transaction. See transaction types documentation for complete list.
payment, transfer, deposit, withdrawal, card_payment, direct_debit, refund, fee, interest, other Current status of the transaction
pending, completed, failed, cancelled, rejected ISO 20022 category purpose code
ISO 20022 purpose code
Show child attributes
Show child attributes
Unstructured remittance information
Structured creditor reference
Type of structured reference. See remittance reference types for details.
SCOR, RADM, RPIN, FXDR, DISP, PUOR, SCNR Show child attributes
Show child attributes
Type of fee. See banking transaction fees for details.
transfer_fee, exchange_fee, processing_fee, commission Fee amount
x >= 0ISO 4217 currency code
Timestamp when transaction was created
Timestamp when transaction was last updated
Supporting documents (statements, verifications) (optional)
Show child attributes
Show child attributes
Show child attributes
Show child attributes
"document"UUID of the document
Show child attributes
Show child attributes
Type of payment means. See payment means types for details.
card_details, account_details, wallet_details, cash_details, check_details, crypto_details, other Payment scheme or network. See scheme types for details.
SEPA, SWIFT, ACH, FASTER_PAYMENTS, VISA, MASTERCARD, AMEX, PAYPAL, APPLEPAY, GOOGLEPAY, STRIPE, LOCAL, OTHER Current status of the payment means. See payment means status for details.
active, inactive, pending_verification, suspended, expired, blocked Bank account details for account_details type
Show child attributes
Show child attributes
International Bank Account Number
Bank Identifier Code (SWIFT)
Local account number (alternative to IBAN)
Bank routing number (US ACH)
Currency code (ISO 4217)
Additional bank information
Show child attributes
Show child attributes
Name of the bank
Bank code or identifier
Bank branch name
Bank branch code
Credit/debit card details for card_details type
Show child attributes
Show child attributes
Masked Primary Account Number (PCI DSS compliant)
Card brand
visa, mastercard, amex, discover, diners, jcb, unionpay, other Type of card
credit, debit, prepaid, charge Card expiry month
Card expiry year
Name as printed on card
Digital wallet details for wallet_details type
Show child attributes
Show child attributes
Digital wallet provider
paypal, applepay, googlepay, stripe, square, venmo, cashapp, other Wallet identifier (email, phone, etc.)
Type of wallet account
personal, business, merchant Compliance and verification status
Show child attributes
Show child attributes
Know Your Customer verification status
pending, in_progress, completed, failed, not_required Anti-Money Laundering check status
pending, in_progress, cleared, flagged, not_required Sanctions screening status
pending, passed, failed, not_required Last compliance check timestamp
System metadata
User-friendly name for the payment means
Additional description of the payment means
Tags for categorization
Creation timestamp
Last update timestamp