Skip to main content
GET
/
v1
/
payment-means
/
{id}
Get payment means by ID
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

Authorization
string
required

Bearer token for authentication

Path Parameters

id
string<uuid>
required

The unique identifier of the payment means to retrieve

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

Response

Payment means retrieved successfully

data
object