Skip to main content
POST
/
management
/
clients
/
{clientId}
/
banks
/
fps
curl -X POST "https://api.cryptomate.me/management/clients/client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d/banks/fps" \
  -H "x-api-key: $CRYPTOMATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "bank_name": "Barclays",
    "account_alias": "Primary UK Account",
    "bank_holder_first_name": "John",
    "bank_holder_last_name": "Smith",
    "sort_code": "123456",
    "account_number": "12345678",
    "address": {
      "streetLine1": "Great Russell Street",
      "city": "London",
      "postal_code": "WC1B 3DG",
      "state": "GBR-CMD",
      "country": "GBR"
    }
  }'

{
  "id": "ba_mno345",
  "company_id": "comp_6f1e2a30-4a3c-4b2e-9a1d-5e8c9b7a1f23",
  "client_id": "client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "bank_name": "Barclays",
  "bank_holder_first_name": "John",
  "bank_holder_last_name": "Smith",
  "account_alias": "Primary UK Account",
  "type": "FPS",
  "currency": "GBP",
  "sort_code": "123456",
  "account_number": "12345678"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cryptomate.me/llms.txt

Use this file to discover all available pages before exploring further.

Creates a new UK Faster Payments (FPS) bank account for the specified client. Requires an API key with access level 3 or higher.

​
Path parameters

​
clientId
string
required
Unique identifier of the client.

​
Body

​
bank_name
string
Name of the bank.
​
account_alias
string
User-friendly alias for the account.
​
bank_holder_first_name
string
Account holder’s first name.
​
bank_holder_last_name
string
Account holder’s last name.
​
sort_code
string
UK bank sort code (6 digits).
​
account_number
string
UK bank account number (8 digits).
​
address
object
Account holder’s address with street_line_1, street_line_2, city, postal_code, state, country.state uses ISO 3166-2 codes that identify country subdivisions in the format {COUNTRY}-{SUBDIVISION} (e.g., USA-CA for California).

​
Response

​
id
string
Bank account identifier.
​
company_id
string
Company identifier.
​
client_id
string
Client identifier.
​
bank_name
string
Bank name.
​
bank_holder_first_name
string
Account holder’s first name.
​
bank_holder_last_name
string
Account holder’s last name.
​
account_alias
string
User-friendly alias.
​
type
string
Payment rail. FPS for UK accounts.
​
currency
string
Account currency. GBP for FPS accounts.
​
sort_code
string
UK sort code.
​
account_number
string
UK account number.
curl -X POST "https://api.cryptomate.me/management/clients/client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d/banks/fps" \
  -H "x-api-key: $CRYPTOMATE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "bank_name": "Barclays",
    "account_alias": "Primary UK Account",
    "bank_holder_first_name": "John",
    "bank_holder_last_name": "Smith",
    "sort_code": "123456",
    "account_number": "12345678",
    "address": {
      "streetLine1": "Great Russell Street",
      "city": "London",
      "postal_code": "WC1B 3DG",
      "state": "GBR-CMD",
      "country": "GBR"
    }
  }'

{
  "id": "ba_mno345",
  "company_id": "comp_6f1e2a30-4a3c-4b2e-9a1d-5e8c9b7a1f23",
  "client_id": "client_a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
  "bank_name": "Barclays",
  "bank_holder_first_name": "John",
  "bank_holder_last_name": "Smith",
  "account_alias": "Primary UK Account",
  "type": "FPS",
  "currency": "GBP",
  "sort_code": "123456",
  "account_number": "12345678"
}