All pages
Powered by GitBook
1 of 1

Loading...

About cookbooks

Getting started

We have organised API cookbooks by grouping them per business domain. So, for example, you can find detailed instructions about authentication-related use cases in the authentication group, account-related ones in the account group and payment-related in the payment group. Just proceed to any cookbook to get the left-hand menu with all cookbooks displayed to find the one of your interest.

If you are unsure which group to find the topic of interest, please use the search function on the top right corner of the page.

Shortcuts to cookbooks

Here you can find the shortcuts to the API recipes:

Person
Accounts
Reports
Deposits
Payments
Loans
Cards
Interest base rates
Interest rate caps
Webhooks
Lookups
Custom Fields
Holidays

Hello, and welcome to the Tuum API cookbooks. Here you can get detailed instructions on how to use Tuum API endpoints to achieve your desired outcome. It is a complementary page to the .

Authentication
Header parameters
Employee

Tuum developer portal
About authentication
Authenticate employee
Create customer credentials
Authenticate customer
Refresh JSON Web Token
Invalidate customer credentials
Export-import roles and privileges
About header parameters
Mandatory parameters
Optional parameters
Create employee
Find employee
Find employee by username
Create private person
Create legal person
Activate person
Find person
Create person document
Update personal info
Update person address
Create customer group
Assign person to customer group
Create person representation
Close person representation
Inactivate person
Reactivate person
Forget person
Remove person restoration key
Create currency account
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
Request to generate account transactions report
Account transactions report parameters
Check report generation status
Download requested report
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
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
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
Create price list
Create price for the price list
Add BIN
Create upper limit group
Create upper usage group
Create card design
Create debit card product
Activate card product
Create debit card application
Create credit product
Create credit card offer
Accept credit card offer
Add interest base rate type - periodic
Add interest base rate type - instant
Add interest rate cap type
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
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
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
Create holiday
Search existing holidays
Search holiday by ID
Delete holiday