All pages
Powered by GitBook
1 of 1

Loading...

Accept loan offer

Accept loan offer endpoint automatically creates a loan contract

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:

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.

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

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

accept loan offer