Create Payment Mean
post
/v1/payment-meansCreate a new payment method or account for financial transactions. This endpoint supports various payment means types including bank accounts (IBAN/SWIFT), credit/debit cards, digital wallets, and other payment instruments.
Requires a bearer token: Authorization: Bearer <token>.
Request
cURL
curl -X POST https://api.wellapp.ai/v1/payment-means \
-H "Authorization: Bearer $WELL_API_TOKEN"Responses
201 — Payment means created successfully
{
"data": {
"type": "payment_means",
"id": "pm-550e8400-e29b-41d4-a716-446655440099",
"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",
"sanctions_check": "passed",
"last_compliance_check": "2025-01-15T10:00:00.000Z"
},
"metadata": {
"source": "api",
"external_id": null,
"last_used_at": null,
"usage_count": 0
},
"nickname": "US Operating Account",
"description": "Primary USD account for US operations",
"tags": [
"usd",
"operating",
"us",
"primary"
],
"is_primary": true,
"is_verified": true,
"created_at": "2025-01-15T10:00:00.000Z",
"updated_at": "2025-01-15T10:00:00.000Z"
},
"relationships": {
"holder": {
"data": {
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440001"
}
},
"account_location": {
"data": {
"type": "location",
"id": "550e8400-e29b-41d4-a716-446655440101"
}
},
"holder_location": {
"data": {
"type": "location",
"id": "550e8400-e29b-41d4-a716-446655440102"
}
},
"bank": {
"data": {
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440103"
}
},
"intermediary_banks": {
"data": [
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440104"
}
]
},
"ultimate_beneficiary": {
"data": {
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440201"
}
},
"created_by": {
"data": {
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440202"
}
},
"documents": {
"data": [
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440301"
},
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440302"
}
]
},
"transactions": {
"data": [
{
"type": "transaction",
"id": "550e8400-e29b-41d4-a716-446655440401"
}
]
},
"linked_payment_means": {
"data": [
{
"type": "payment_means",
"id": "550e8400-e29b-41d4-a716-446655440501"
}
]
}
},
"included": [
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440001",
"attributes": {
"name": "ACME Corporation",
"description": "Technology solutions provider",
"registration": {
"registered_name": "ACME Corporation Inc.",
"trade_name": "ACME"
},
"tax_id": {
"value": "12-3456789",
"type": "EIN"
},
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2025-01-15T10:00:00.000Z"
}
},
{
"type": "location",
"id": "550e8400-e29b-41d4-a716-446655440101",
"attributes": {
"street": "270 Park Avenue",
"city": "New York",
"state": "NY",
"postal_code": "10017",
"country": "US",
"is_primary": true,
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2025-01-15T10:00:00.000Z"
}
},
{
"type": "location",
"id": "550e8400-e29b-41d4-a716-446655440102",
"attributes": {
"street": "123 Business Avenue",
"city": "New York",
"state": "NY",
"postal_code": "10001",
"country": "US",
"is_primary": true,
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2025-01-15T10:00:00.000Z"
}
},
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440103",
"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"
},
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2025-01-15T10:00:00.000Z"
}
},
{
"type": "company",
"id": "550e8400-e29b-41d4-a716-446655440104",
"attributes": {
"name": "Wells Fargo Bank",
"description": "Intermediary bank for routing",
"registration": {
"registered_name": "Wells Fargo Bank, N.A."
},
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2025-01-15T10:00:00.000Z"
}
},
{
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440201",
"attributes": {
"first_name": "Jane",
"last_name": "Doe",
"full_name": "Jane Doe",
"date_of_birth": "1980-05-15",
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2025-01-15T10:00:00.000Z"
}
},
{
"type": "people",
"id": "550e8400-e29b-41d4-a716-446655440202",
"attributes": {
"first_name": "John",
"last_name": "Smith",
"full_name": "John Smith",
"created_at": "2024-01-01T00:00:00.000Z",
"updated_at": "2025-01-15T10:00:00.000Z"
}
},
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440301",
"attributes": {
"name": "Bank Statement January 2025.pdf",
"file_size": 245678,
"content_type": "application/pdf",
"created_at": "2025-01-15T09:00:00.000Z",
"updated_at": "2025-01-15T09:00:00.000Z"
}
},
{
"type": "document",
"id": "550e8400-e29b-41d4-a716-446655440302",
"attributes": {
"name": "Account Verification Letter.pdf",
"file_size": 123456,
"content_type": "application/pdf",
"created_at": "2025-01-15T09:30:00.000Z",
"updated_at": "2025-01-15T09:30:00.000Z"
}
},
{
"type": "transaction",
"id": "550e8400-e29b-41d4-a716-446655440401",
"attributes": {
"amount": {
"value": 5000,
"currency": "USD"
},
"description": "Monthly supplier payment",
"transaction_date": "2025-01-15T00:00:00.000Z",
"status": "completed",
"created_at": "2025-01-15T08:00:00.000Z",
"updated_at": "2025-01-15T08:30:00.000Z"
}
},
{
"type": "payment_means",
"id": "550e8400-e29b-41d4-a716-446655440501",
"attributes": {
"type": "card",
"scheme": "visa",
"status": "active",
"card_details": {
"last_four": "1234",
"expiry_month": 12,
"expiry_year": 2026,
"cardholder_name": "ACME CORPORATION",
"nickname": "Corporate Visa Card",
"is_primary": false,
"created_at": "2024-06-01T00:00:00.000Z",
"updated_at": "2025-01-15T10:00:00.000Z"
}
}
}
]
}
}400 — Bad request - invalid payment means data
401 — Unauthorized - invalid API key
{
"errors": [
{
"id": "unauthorized",
"status": "401",
"code": "UNAUTHORIZED",
"title": "Unauthorized",
"detail": "Valid authentication credentials are required"
}
]
}404 — Not found - related entity does not exist
{
"errors": [
{
"id": "holder_not_found",
"status": "404",
"code": "HOLDER_NOT_FOUND",
"title": "Holder Not Found",
"detail": "The specified holder company or person does not exist",
"source": {
"pointer": "/data/relationships/holder/data/id"
}
}
]
}