LogoLogo
Developer portal
  • Welcome
    • About cookbooks
  • 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 by ID
    • 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 group
    • Create person representation
    • Close person representation
    • Create person financial data
    • Inactivate person
    • Reactivate person
    • Reactivate person
    • Forget person
    • Remove person restoration key
  • ACCOUNTS
    • 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
    • Reports
    • Request to generate account transactions report
      • Account transactions report parameters
  • Check report generation status
  • Download requested report
  • 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
      • Create deposit offer
      • Find deposit offer
      • Edit deposit offer
      • Accept 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 payments
      • 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 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
    • 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 card design
    • Create debit card product
    • Activate card product
    • Create debit card application
    • Create credit product
    • Create credit card offer
    • Accept credit card offer
  • 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 processes
      • 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
Powered by GitBook

© Tuum 2024

On this page
  • Initial POST request
  • Create account
  • Duplicated POST request
  • Duplicated POST request with changed data
  • Summary for using the same request ID

Was this helpful?

Export as PDF
  1. Header parameters
  2. Optional parameters

Requests with same request ID

PreviousOptional parametersNextRequests without request ID

Last updated 1 year ago

Was this helpful?

Initial POST request

We will create a new account for a person by making the following API call.

Create account

POST https://account-api.sandbox.tuumplatform.com/api/v4/persons/ID-3419/accounts

See more about the in the Tuum developer portal.

Below is an example request body of the API call for creating an account.

{
  "accountTypeCode": "CURRENCY",
  "personName": "Eleanor Rigby",
  "customerGroupCode": "GROUP_A",
  "priceListTypeCode": "STANDARD",
  "residencyCountryCode": "GB",
  "currencyCode": "GBP"
}
curl 'https://account-api.sandbox.tuumplatform.com/api/v4/persons/ID-3419/accounts' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMDRUMTE6MjM6MjUiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTExNDgyMDV9.1lnY03GWnnGdki0uJlkNNSMydwiWv_jsdII10PKPUkA' \
-H 'x-request-id: eb1d4135-bca1-4612-aa83-29637830fe37' \
-H 'Content-Type: application/json' \
-d '{
  "accountTypeCode": "CURRENCY",
  "personName": "Eleanor Rigby",
  "customerGroupCode": "GROUP_A",
  "priceListTypeCode": "STANDARD",
  "residencyCountryCode": "GB",
  "currencyCode": "GBP"
}'

As a result, a new account with accountId: ID-1292 was created and activated.

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "accountId": "ID-1292",
        "personId": "ID-3419",
        "accountTypeCode": "CURRENCY",
        "activationDate": "2023-08-04",
        "accountName": null,
        "personName": "Eleanor Rigby",
        "statusCode": "ACTIVE",
        "iban": "GB76XXXX04030000001011",
        "bic": "LHVBGB2LXXX",
        "defaultCurrencyCode": "GBP",
        "tenantCode": "MB",
        "residencyCode": "GB",
        "customerGroupCode": "GROUP_A",
        "personTypeCode": null,
        "intraOrgCode": null,
        "accountTypeSetupCode": "STANDARD",
        "serviceProviderCode": "TUUM",
        "interestMethodAssignmentCode": null,
        "accountClassCode": null,
        "balances": [
            {
                "balanceId": "ID-1221",
                "accountId": "ID-1292",
                "currencyCode": "GBP",
                "balanceAmount": 0.00,
                "reservedAmount": 0.00,
                "overdraftLimitAmount": 0.00,
                "defaultCurrencyCode": "GBP",
                "availableBalanceInDefaultCcy": 0.00,
                "negativeBalanceStartDate": null,
                "availableBalanceAmount": 0.00
            }
        ],
        "masterAccountId": null,
        "accountNumbers": [
            {
                "accountNumber": {
                    "value": "00001011",
                    "type": "BBAN"
                },
                "countryCode": "GB",
                "financialInstitutionId": {
                    "value": "040300",
                    "type": "SORT_CODE"
                },
                "defaultCurrencyCode": "GBP",
                "accountNumberId": "ID-1147",
                "accountId": "ID-1292",
                "financialInstitutionIdTypeCode": null,
                "statusCode": "ENABLED"
            }
        ],
        "taxResidencyCountryCode": "GB",
        "jurisdictionCountryCode": "GB"
    }
}

Duplicated POST request

We will make the API call again without changing the request ID and using the same request data.

The response we received is identical to the initial call, confirming the creation of the account with the ID-1292. No new account was created.

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "accountId": "ID-1292",
        "personId": "ID-3419",
        "accountTypeCode": "CURRENCY",
        "activationDate": "2023-08-04",
        "accountName": null,
        "personName": "Eleanor Rigby",
        "statusCode": "ACTIVE",
        "iban": "GB76XXXX04030000001011",
        "bic": "LHVBGB2LXXX",
        "defaultCurrencyCode": "GBP",
        "tenantCode": "MB",
        "residencyCode": "GB",
        "customerGroupCode": "GROUP_A",
        "personTypeCode": null,
        "intraOrgCode": null,
        "accountTypeSetupCode": "STANDARD",
        "serviceProviderCode": "TUUM",
        "interestMethodAssignmentCode": null,
        "accountClassCode": null,
        "balances": [
            {
                "balanceId": "ID-1221",
                "accountId": "ID-1292",
                "currencyCode": "GBP",
                "balanceAmount": 0.00,
                "reservedAmount": 0.00,
                "overdraftLimitAmount": 0.00,
                "defaultCurrencyCode": "GBP",
                "availableBalanceInDefaultCcy": 0.00,
                "negativeBalanceStartDate": null,
                "availableBalanceAmount": 0.00
            }
        ],
        "masterAccountId": null,
        "accountNumbers": [
            {
                "accountNumber": {
                    "value": "00001011",
                    "type": "BBAN"
                },
                "countryCode": "GB",
                "financialInstitutionId": {
                    "value": "040300",
                    "type": "SORT_CODE"
                },
                "defaultCurrencyCode": "GBP",
                "accountNumberId": "ID-1147",
                "accountId": "ID-1292",
                "financialInstitutionIdTypeCode": null,
                "statusCode": "ENABLED"
            }
        ],
        "taxResidencyCountryCode": "GB",
        "jurisdictionCountryCode": "GB"
    }
}

Duplicated POST request with changed data

We will repeat the API call using the same request ID but with updated request data. We will change the currency from GBP to USD.

Below is an example request body for creating an account with the updated currency.

{
  "accountTypeCode": "CURRENCY",
  "personName": "Eleanor Rigby",
  "customerGroupCode": "GROUP_A",
  "priceListTypeCode": "STANDARD",
  "residencyCountryCode": "GB",
  "currencyCode": "USD"
}
curl 'https://account-api.sandbox.tuumplatform.com/api/v4/persons/ID-3419/accounts' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDgtMDRUMTE6MjM6MjUiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2OTExNDgyMDV9.1lnY03GWnnGdki0uJlkNNSMydwiWv_jsdII10PKPUkA' \
-H 'x-request-id: eb1d4135-bca1-4612-aa83-29637830fe37' \
-H 'Content-Type: application/json' \
-d '{
  "accountTypeCode": "CURRENCY",
  "personName": "Eleanor Rigby",
  "customerGroupCode": "GROUP_A",
  "priceListTypeCode": "STANDARD",
  "residencyCountryCode": "GB",
  "currencyCode": "USD"
}'

As a result, no new account is created. However, the account currency on the existing account ID-1292is updated to USD as requested.

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "accountId": "ID-1292",
        "personId": "ID-3419",
        "accountTypeCode": "CURRENCY",
        "activationDate": "2023-08-04",
        "accountName": null,
        "personName": "Eleanor Rigby",
        "statusCode": "ACTIVE",
        "iban": "GB76XXXX04030000001011",
        "bic": "LHVBGB2LXXX",
        "defaultCurrencyCode": "GBP",
        "tenantCode": "MB",
        "residencyCode": "GB",
        "customerGroupCode": "GROUP_A",
        "personTypeCode": null,
        "intraOrgCode": null,
        "accountTypeSetupCode": "STANDARD",
        "serviceProviderCode": "TUUM",
        "interestMethodAssignmentCode": null,
        "accountClassCode": null,
        "balances": [
            {
                "balanceId": "ID-1221",
                "accountId": "ID-1292",
                "currencyCode": "GBP",
                "balanceAmount": 0.00,
                "reservedAmount": 0.00,
                "overdraftLimitAmount": 0.00,
                "defaultCurrencyCode": "GBP",
                "availableBalanceInDefaultCcy": 0.00,
                "negativeBalanceStartDate": null,
                "availableBalanceAmount": 0.00
            }
        ],
        "masterAccountId": null,
        "accountNumbers": [
            {
                "accountNumber": {
                    "value": "00001011",
                    "type": "BBAN"
                },
                "countryCode": "GB",
                "financialInstitutionId": {
                    "value": "040300",
                    "type": "SORT_CODE"
                },
                "defaultCurrencyCode": "GBP",
                "accountNumberId": "ID-1147",
                "accountId": "ID-1292",
                "financialInstitutionIdTypeCode": null,
                "statusCode": "ENABLED"
            }
        ],
        "taxResidencyCountryCode": "GB",
        "jurisdictionCountryCode": "GB"
    }
}

Summary for using the same request ID

If you make multiple POST calls to the same API endpoint using the same value for the x-request-id header parameter, all subsequent calls will receive the same response as the initial call. This principle also holds even if you use different data in the request body of a repeated request.

endpoint