Create Credit Application Request

Credit Application Initialisation

Create an online application link which you can give to the customer or redirect the customer to.

Required Parameter Fields

POST Field

Type

Required

Notes

action

STRING

Yes

This should be 'credit_application_link' in lower case.

Identification[api_key]

STRING

Yes

Your unique account identifier

Identification[RetailerUniqueRef]

STRING

Yes

The merchant unique reference to tie applications to their system

Identification[InstallationID]

INTEGER

Yes

The installation associated with this credit request. Installations enable you to associate credit requests with different sales channels and/or websites. Each installation can have a unique configuration (logo, return URL’s, CSN URL’s etc…)

Goods[Description]

STRING

Yes

Description of order contents

Goods[Price]

INTEGER

Yes

The overall total order value expressed in pennies

Finance[Code]

STRING

Yes

Specifies the finance product, please refer to product codes for a full list of our lender product codes

Finance[Deposit]

INTEGER

Yes

The deposit amount expressed in pennies

Optional Parameter Fields

POST Field

Type

Required

Notes

Consumer[Title]

STRING

No

The title of the customer

Consumer[Forename]

STRING

No

The forename of the customer

Consumer[Surname]

STRING

No

The surname of the customer

Consumer[DateOfBirthDay]

INTEGER

No

The day of the month for the customer's birth date (i.e 24)

Consumer[DateOfBirthMonth]

INTEGER

No

The month the customer's birth date (i.e. 7)

Consumer[DateOfBirthYear]

INTEGER

No

The year of birth for the customer (i.e 1978)

Consumer[Gender]

STRING

No

The customer's gender
M=Male
F=Female

Consumer[MaritalStatus]

STRING

No

The customer's martial status
M=Married
S=Single
C=Cohabiting
D=Divorced
P=Seperated
W=Widowed

Consumer[MobileNumber]

STRING

No

The mobile phone number of the customer. Not required, but if set, must match the following regex: /(^+[0-9]{2}|^+[0-9]{2}(0)|^(+[0-9]{2})(0)|^00[0-9]{2}|^0)([0-9]{9}$|[0-9-\s]{10}$)/

It will match local and both international formats: 07123456789 00447123456789 +447123456789

Consumer[EmailAddress]

STRING

No

The customer's email address

Consumer[ResidentialStatus]

STRING

No

The customer's residential status
H=Homeowner
T=Tenant
L=Living with parents
R=Renting
C=Council Renting
O=Other

Consumer[Employment][Status]

STRING

No

The customer's employment status
P=Employed Full Time
PT=Employed Part Time
S=Self Employed
M=Military
R=Retired
H=Houseperson

Consumer[Employment][Occupation]

STRING

No

The customer's occupation

Consumer[Employment][EmployerName]

STRING

No

The customer's employer name

Consumer[Employment][Years]

STRING

No

How long the customer has worked for the employer

Consumer[Employment][Salary]

STRING

No

The customer's current salary

Consumer[Bank][AccountName]

STRING

No

The owner's of the customer's bank account name

Consumer[Bank][AccountNumber]

STRING

No

The customer's bank account number

Consumer[Bank][SortCode]

STRING

No

The customer's bank branch sort code

Consumer[Bank][Years]

STRING

No

How long the customer has been using the bank account, years 0-9 to be passed though as a string of 0-9 in order to populate the field, a value of 10 needs to be passed across in order to display more then 10 years on the application form.

Example Successful Response

https://secure.dekopay.com/s-e37hrteuxa3kyfkuexw6cxc2wg5tb8jv

Did this page help you?