About cookbooks

Tuum's developer documentation includes API cookbooks with detailed instructions on how to use Tuum API endpoints to achieve your goals.

Our API cookbooks are organised by business domain. Shortcuts to the content of each business domain are provided below.

Authentication

• About authentication

• Authenticate employee

• Create customer credentials

• Authenticate customer

• Refresh JSON Web Token

• Invalidate customer credentials

• Export-import roles

  • Export selected roles

  • Import selected roles

  • Import all roles

Header parameters

• About header parameters

• Mandatory parameters

• Optional parameters

  • Requests with same request ID

  • Requests without request ID

Employee

• Create employee

• Find employee

• Find employee by username

Person

• Create private person

• Create legal person

• Activate person

• Find person

  • Find person details

  • Find person addresses

• Create person document

• Update personal info

• Update person address

• Create customer group

• Create additional contact

• Assign person to customer group

• Create person representation

• Close person representation

• Create person financial data

• Inactivate person

• Reactivate person

• Forget person

• Remove person restoration key

Accounts

• Create currency account

• Savings accounts

  • Create savings account

  • Find savings ID for savings account

  • Create savings order

• Create internal account

• Create virtual account

• Create account application

• Set account access rights

• Create account limit code

• Create account limit type

• Create account limit

• Create account class code

• Create account type class rule

• Find person accounts

• Search account transactions

Reports

• About reports

  • Account transactions report

    • Request to generate account transactions report

      • Account transactions report parameters

    • Check account transactions report generation status

    • Download requested account transactions report

  • QMR - Quarterly Mastercard report

    • Request to generate QMR manually

    • Check QMR generation status

    • Export requested QMR as PDF

Deposits

• Deposit product management

  • Create deposit class code

  • Create deposit product

  • Update deposit product

  • Activate deposit product

  • Find deposit product

  • Inactivate deposit product

• Deposit flow

  • Create deposit application

  • Find deposit application

  • Find deposit offer

  • Accept deposit offer

  • Create deposit offer

  • Edit deposit offer

  • Decline deposit offer

  • Find deposit contract

• Deposit contract management

  • Change payout details

  • Change contract prolongation status

  • Update contract header

  • Adjust deposit contract interest

  • Make premature termination

Payments

• Create outgoing payment

  • Create SEPA payment

  • Create SWIFT payment

  • Create domestic UK payment

  • Create domestic US payment

• Change payment

• Cancel payment

• Confirm payment

• Find AML information of a payment

• Find the settled SEPA transaction

• Create payment template

• Initialise FX quote request

• Get FX quote response

• Initiate FX order

Loans

• Create loan application

• Accept loan application

• Find loan application offers

• Create loan offer for a person

• Accept loan offer

• Find person contracts

• Accept loan contract

• Disburse loan contract

• Create contract fee booking

• Default loan contract

Cards

• Create price list

• Create price for the price list

• Card counting and summing groups

  • Create counting group

  • Create summing group

  • Find counting values for card

  • Find summing values for account

• Add BIN

• Create upper limit group

• Create upper usage group

• Create debit card product

• Activate card product

• Card account operation

  • Create card transaction without reservation

  • Create a card transaction through the reservation

  • Create card custom booking

  • Calculate fee quotation for transaction

    • Test future price list

    • Calculate fee for specific account

  • Find card account details

• Create debit card application with internal account

• Accept card application

• Create debit card application

• Create physical debit card application with Tuum core account

• Create supplementary debit card application

• Find card application by ID

• Create credit product

• Create credit card offer

• Accept credit card offer

• Card designs

  • Search card designs

  • Create card design

  • Change card design description

  • Delete card design

• Find card history

  • Find card status history

  • Find card settings history

  • Find card limits history

  • Find card price list history

  • Find card usage group history

  • Find card limit group history

• Search card network transactions

• Export card network transactions as CSV

• Replace the servicing account for card credit contracts

• Replace virtual card

• Replace physical card

• Change card usage group

• Change card settings

  • Card service codes

• Enable card authorisation type

• Disable card authorisation type

• Change card limit group

• Change card limits

Interest base rates

• Add interest base rate type - periodic

• Add interest base rate type - instant

Interest rate caps

• Add interest rate cap type

Webhooks

• About webhooks

• Find available webhooks

• Enable or disable notification for webhook

  • Enable with notification type and channel code

  • Enable with notification ID

  • Disable with notification type and channel code

  • Disable with notification ID

• Search subscribed webhooks

• Subscribe webhook

• Update webhook subscription

• Unsubscribe webhook

• Webhooks with payloads

  • Person

  • Account

  • Deposit

  • Payments

  • AML

  • Loan

  • Card

  • Debt

  • Finance

  • Reports

  • Processes

Lookups

• About lookups

• Find existing lookup groups

• Find lookup values

  • Find entities

  • Find lookup type codes

  • Find lookup types

  • Find translation of lookup type

• Create lookup values

  • Create lookup type and codes

  • Create lookup code for existing type

  • Create lookup translation

• Manage lookup values

  • Mark lookup code as default

  • Remove default lookup code

  • Delete lookup code

Custom Fields

• About custom fields

• Create custom fields

  • Create field set

  • Create fields

  • Create fields with copied values

• Find custom fields

  • Find field sets

  • Find fields

  • Search custom field sources

  • Get custom field value

• Update custom fields

  • Update field set

  • Update field

  • Update custom field value

• Manage custom fields

  • Insert custom field values

  • Copy custom field values

  • Deactivate field

  • Delete custom field value

Holidays

• Create holiday

• Search existing holidays

• Search holiday by ID

• Delete holiday