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
  • Use case
  • Sample API call
  • Sample request
  • Sample response
  • Result

Was this helpful?

Export as PDF
  1. LOANS

Accept loan offer

Accept loan offer endpoint automatically creates a loan contract

PreviousCreate loan offerNextFind person contracts

Last updated 1 year ago

Was this helpful?

Use case

In this example, we will review how to accept a loan offer:

Use case data
API parameters with values

Accepting the loan offer ID-1664282481

...offers/ID-1664282481/accept

The loan offer can be accepted only if the payment instructions are provided.

Sample API call

To accept a loan offer, make the following call:

https://loan-api.sandbox.tuumplatform.com/api/v2/offers/{offerId}/accept

To find more information about the endpoint, check the Tuum developer portal.

Sample request

Below is an example request of the API call for accepting a loan offer.

https://loan-api.sandbox.tuumplatform.com/api/v2/offers/ID-1664282481/accept
curl -L -X POST 'https://loan-api.sandbox.tuumplatform.com/api/v2/offers/ID-1664282481/accept' \
-H 'x-channel-code: system' \
-H 'x-auth-token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHBpcnlEVGltZSI6IjIwMjMtMDctMDNUMTM6Mjg6MTkiLCJyb2xlcyI6WyJBRE1JTiJdLCJuYW1lIjoiSm9obiBPZmZpY2VyIiwiZW1wbG95ZWVJZCI6IjEiLCJ0ZW5hbnRDb2RlIjoiTUIiLCJleHAiOjE2ODgzOTA4OTl9.ydUcxWiHRBYqynAXYt2Vnhu6JhX5hQDQTmmlm_HtiL4' \
-d ''

Sample response

Below you find an example response body to the API call above.

Response
{
    "errors": null,
    "validationErrors": null,
    "data": {
        "offerId": "ID-1664282481",
        "applicationId": "ID-1664282445",
        "personId": "ID-3392",
        "coPersonId": null,
        "interestRate": 1.539,
        "loanToValue": null,
        "requestedMoney": {
            "amount": 10000.00,
            "currencyCode": "GBP"
        },
        "offeredMoney": {
            "amount": 10000.00,
            "currencyCode": "GBP"
        },
        "grossMoney": {
            "amount": 10000.00,
            "currencyCode": "GBP"
        },
        "netMoney": {
            "amount": 10000.00,
            "currencyCode": "GBP"
        },
        "loanPeriod": 10,
        "statusCode": "ACCEPTED",
        "offerDate": "2023-06-29",
        "statusDate": "2023-07-03",
        "statusComment": null,
        "loanTypeCode": "ANNUITY STANDARD",
        "paymentDay": 1,
        "servicingAccountId": null,
        "apr": 2.11,
        "scheduleTypeCode": "ANNUITY",
        "purpose": null,
        "loanGroupCode": "UNSECURED_LOAN",
        "monthlyRepaymentMoney": {
            "amount": 1032.86,
            "currencyCode": "GBP"
        },
        "monthlyRepaymentRate": null,
        "tenantCode": null,
        "statusCodeReason": null,
        "minimalWithdrawalTypeCode": null,
        "minimalWithdrawalMoney": null,
        "invoiceDay": 8,
        "invoiceDueDay": 3,
        "maxPeriod": 48,
        "maxMoney": {
            "amount": 12345.67,
            "currencyCode": "GBP"
        },
        "applicationScore": 123.45,
        "countryCode": "GB",
        "channelCode": "system",
        "paymentInstructions": [
            {
                "paymentInstructionId": "ID-1664282481",
                "personId": null,
                "beneficiaryName": "Trevor Harry Tuum",
                "beneficiaryIban": "GB72XXXX04030000000986",
                "beneficiaryAccountNumber": null,
                "beneficiaryAccountNumberCountryCode": null,
                "beneficiaryBankCode": null,
                "beneficiaryAccountId": null,
                "counterpartyBic": null,
                "money": {
                    "amount": 10000.00,
                    "currencyCode": "GBP"
                },
                "details": null,
                "referenceNumber": null,
                "processed": false,
                "source": {
                    "sourceName": "LOAN.OFFER",
                    "sourceRef": "ID-1664282481",
                    "sourceLink": null
                },
                "contractSource": {
                    "sourceName": "LOAN.CONTRACT_HEADER",
                    "sourceRef": null,
                    "sourceLink": null,
                    "contractNumber": null
                },
                "contractVersionNumber": null,
                "statusCode": "VALIDATED",
                "errorCode": null,
                "paymentChannelCode": "TRUSTLY",
                "onDemand": false,
                "scheduleRegenerationRule": null,
                "actionHistories": [
                    {
                        "actionHistoryId": null,
                        "employeeId": "1",
                        "sourceField": "STATUS_CODE",
                        "oldValue": null,
                        "newValue": "INSERTED",
                        "actionTypeCode": "INS",
                        "comment": "Created during offer change",
                        "reasonCode": null,
                        "insertedDTime": "2023-07-03T12:40:08",
                        "insertedBy": "John Officer",
                        "source": {
                            "sourceName": "LOAN.PAYMENT_INSTRUCTION",
                            "sourceRef": "ID-1664282481",
                            "sourceLink": null
                        }
                    },
                    {
                        "actionHistoryId": null,
                        "employeeId": "1",
                        "sourceField": "STATUS_CODE",
                        "oldValue": "INSERTED",
                        "newValue": "VALIDATING",
                        "actionTypeCode": null,
                        "comment": "Created during offer change",
                        "reasonCode": null,
                        "insertedDTime": "2023-07-03T12:40:08",
                        "insertedBy": "John Officer",
                        "source": {
                            "sourceName": "LOAN.PAYMENT_INSTRUCTION",
                            "sourceRef": "ID-1664282481",
                            "sourceLink": null
                        }
                    },
                    {
                        "actionHistoryId": null,
                        "employeeId": "4",
                        "sourceField": "STATUS_CODE",
                        "oldValue": "VALIDATING",
                        "newValue": "VALIDATED",
                        "actionTypeCode": null,
                        "comment": null,
                        "reasonCode": null,
                        "insertedDTime": "2023-07-03T12:40:08",
                        "insertedBy": "SYSTEM",
                        "source": {
                            "sourceName": "LOAN.PAYMENT_INSTRUCTION",
                            "sourceRef": "ID-1664282481",
                            "sourceLink": null
                        }
                    }
                ]
            }
        ],
        "numberOfPayments": 10,
        "annuityMoney": {
            "amount": 1032.86,
            "currencyCode": "GBP"
        },
        "validityRange": {
            "endDate": "2023-07-24",
            "startDate": "2023-06-29"
        },
        "additionalData": null,
        "feeMoney": {
            "amount": 25.00,
            "currencyCode": "GBP"
        },
        "interestMarginRate": 1.2,
        "interestBaseRate": 0.339,
        "interestTypeCode": "FLOATING",
        "rateBaseCode": "EURIBOR-6M",
        "paymentFreeMonths": null,
        "source": {
            "sourceName": "LOAN.APPLICATION",
            "sourceRef": "ID-1664282445",
            "sourceLink": null
        },
        "coBorrowers": [
            {
                "personId": "ID-3392",
                "borrowerTypeCode": "BORROWER"
            }
        ],
        "repaymentChannelCode": "TRUSTLY",
        "campaignIds": [],
        "limitUsageDate": null,
        "contractEndDate": null,
        "contractId": "ID-1664282473",
        "contractNumber": "321001",
        "activeVersionId": "ID-1664282483",
        "amortisationPeriod": null,
        "collateralRequired": false,
        "overdraft": false
    }
}

Result

A new loan contract ID-1664282473 is created.

accept loan offer