Cashplus APIs
Account Request URL
https://developer.cashplus.com/developer-guides/api/applicationsBase Endpoint
-
Accounts
Retrieves a single account.
accounts/{account number}
account_number
Accounts
Retrieves all accounts of the current user.
accounts
Accounts
Creates a new account.
accounts
type, initial_credit, alias, default_item, default_cost_centre
Alias
Retrieves the list of all aliases associated with the account.
accounts/{account number}/aliases
account_number
Alias
Creates a new alias associated with the account.
accounts/{account number}/aliases
account_number, name, sort_code, account_number
Alias
Updates an alias of the account.
accounts/{account number}/aliases/{alias id}
account_number, alias_id, name, sort_code, account_number
Alias
Updates an alias of the account.
accounts/{account number}/aliases/{alias id}
account_number, alias_id, name, sort_code, account_number
Alias
Deletes an alias.
accounts/{account number}/aliases/{alias id}
account_number, alias_id
ApiKeys
Retrieves the API keys belonging to the current user.
apikeys
ApiKeys
Creates a new API key that can be used by a specific user or client.
apikeys
description, read_access, write_access, token_expiry
ApiKeys
Deletes an API key.
apikeys/{api_key_id}
api_key_id
Balance
Retrieves the current balance of the account specified.
accounts/{account number}/balance
account_number
Balance
Retrieves the balance history of the account specified.
accounts/{account number}/balance/history
account_number, start_date, end_date
Bills
Retrieves invoices to be paid.
accounts/{account number}/bills
account_number
Bills
Retrieves a single bill.
accounts/{account number}/bills/{invoice number}
account_number, invoice_number
Bills
Retrieves all invoices paid within a date range.
accounts/{account number}/bills/paid
account_number, from_date, to_date
Bills
Creates a new bill.
accounts/{account number}/bills
account_number, recipient, invoice_number, invoice_date, due_date, amount, transaction_reference, paid
Bills
Updates a bill.
accounts/{account number}/bills/{bill_id}
account_number, bill_id, amount, due_date
BulkPayments
Initiates a bulk payment run.
bulk-payments/runs
file
BulkPayments
Retrieves all not submitted bulk payment runs.
bulk-payments/runs
BulkPayments
Retrieves a single bulk payment run.
bulk-payments/runs/{run_id}
run_id
BulkPayments
Updates a bulk payment run.
bulk-payments/runs/{run_id}
run_id, status
BulkPayments
Deletes a bulk payment run.
bulk-payments/runs/{run_id}
run_id
BulkPayments
Retrieves all payments belonging to a bulk payment run.
bulk-payments/runs/{run_id}/payments
run_id
BusinessInfo
Retrieves business information.
business
BusinessInfo
Updates business information.
business
legal_name, trading_name, registration_number, vat_number, sic_code, registration_date, incorporation_date, industry_type, registered_address
Cards
Retrieves cards belonging to the current user.
cards
Cards
Retrieves a single card belonging to the current user.
cards/{card number}
card_number
Cards
Creates a new card belonging to the current user.
cards
type, name, alias, cardholder_name, billing_address, delivery_address, design, pin
Cards
Deactivates a card belonging to the current user.
cards/{card number}
card_number
Cards
Updates a card belonging to the current user.
cards/{card number}
card_number, type, name, alias, cardholder_name, billing_address, delivery_address, design, active
Charges
Retrieve charge information.
charges
Charges
Charges an account.
accounts/{account number}/charges
account_number, amount, currency, description, date
Charges
Update a charge.
charges/{charge_id}
charge_id, amount, currency, description, date
Charges
Cancels a charge.
charges/{charge_id}
charge_id
Cheques
Orders a cheque to be sent to a specified address.
accounts/{account number}/cheques
account_number, recipient_name, address_line1, address_line2, address_city, address_postcode, cheque_amount, delivery_method
CostCentres
Retrieves cost centres belonging to the current authenticated user.
cost-centres
CostCentres
Retrieves a single cost centre.
cost-centres/{cost_centre_number}
cost_centre_number
CostCentres
Creates a new cost centre.
cost-centres
type, name, alias
CostCentres
Deletes a cost centre.
cost-centres/{cost_centre_number}
cost_centre_number
DirectDebit
Creates a direct debit.
direct-debits
account_number, sort_code, account_number, mandate_reference, mandate_date, direct_debit_description
DirectDebit
Retrieves a direct debit.
direct-debits/{direct_debit_id}
direct_debit_id
DirectDebit
Updates a direct debit.
direct-debits/{direct_debit_id}
direct_debit_id, sort_code, account_number, mandate_reference, direct_debit_description
DirectDebit
Cancels a direct debit.
direct-debits/{direct_debit_id}
direct_debit_id
Documents
Retrieves a document.
documents/{document_id}
document_id
Documents
Deletes a document.
documents/{document_id}
document_id
Documents
Creates a document.
documents
file
Expenses
Retrieves expenses belonging to the current user.
expenses
Expenses
Retrieves a single expense belonging to the current user.
expenses/{expense_id}
expense_id
Expenses
Creates a new expense.
expenses
account_number, cost_centre_number, supplier_name, invoice_number, invoice_date, due_date, amount, paid, description, line_items
Expenses
Updates an expense.
expenses/{expense_id}
expense_id, account_number, cost_centre_number, supplier_name, invoice_number, invoice_date, due_date, amount, paid, description, line_items
Expenses
Deletes an expense.
expenses/{expense_id}
expense_id
Files
Retrieves a file.
files/{file_id}
file_id
Files
Deletes a file.
files/{file_id}
file_id
Files
Uploads a file.
files
file
Funds
Retrieves the funds of the account specified.
accounts/{account number}/funds
account_number
Funds
Deposits funds into the account specified.
accounts/{account number}/funds
account_number, amount, currency, description
Insights
Retrieves all insights for an account.
insights/accounts/{account number}
account_number
Insights
Retrieves a single insight for an account.
insights/accounts/{account number}/{insight id}
account_number, insight_id
Items
Retrieves items belonging to the current authenticated user.
items
Items
Retrieves a single item belonging to the current authenticated user.
items/{item_id}
item_id
Items
Creates a new item.
items
name, description, quantity, unit, unit_price, cost_centre_number
Items
Updates an item belonging to the current authenticated user.
items/{item_id}
item_id, name, description, quantity, unit, unit_price, cost_centre_number
Items
Deletes an item belonging to the current authenticated user.
items/{item_id}
item_id
LineItems
Creates a line item in an expense.
expenses/{expense_id}/line-items
expense_id, name, description, quantity, unit, unit_price, amount
LineItems
Deletes a line item.
line-items/{line_item_id}
line_item_id
Mandates
Retrieves a mandate.
mandates/{mandate_reference}
mandate_reference
Mandates
Cancels a mandate.
mandates/{mandate_reference}
mandate_reference
Messages
Retrieves messages belonging to the current authenticated user.
messages
Messages
Retrieves a single message belonging to the current authenticated user.
messages/{message_id}
message_id
Messages
Deletes a message.
messages/{message_id}
message_id
Payments
Retrieves payments from the account specified.
accounts/{account number}/payments
account_number, payee, start_date, end_date, amount, currency
Payments
Retrieves a single payment from the account specified.
accounts/{account number}/payments/{payment_id}
account_number, payment_id
Payments
Details
Provider
Country HQ
API Type
Categories
Alternatives
Important URLs
Last Updated on
Created At
Other Apps
Upskill for a better future
Want to start tracking API at scale?
Get updates about your favorite APIs and SDKs
We do our best to ensure that the data we release is complete, accurate, and useful. However, because we are not able to verify all the data, and because the processing required to make the data useful is complex, we cannot be held liable for omissions or inaccuracies.
