Schemas

Refer to the tables below for a summary.

Schema	Description	Type	Example
KeySignature	An HMAC signature header provided on Deko callbacks to verify it is from Deko	String	M4wYp1MKvDpQtVOnN7LVt9L8or4pKyVLhfUFVJxHemU=
AccessTokenRequest	An object representing the request for an Access Token.	Object	You need to supply a client_id and client_secret
AccessTokenResponse	An object representing an OAuth Access Token	Object	See Access Token Example
AccessToken	A valid access token	String	See Access Token Example
AccessTokenExpires	A number of seconds before the token is due to expire	Number	86400
AccessTokenType	Access Token Type	String	Bearer
CheckoutRequest	A request sent by a merchant to Deko to authorise it	Object	The request must include: customer basket products callbackUri
MerchantUniqueReference	A unique merchant reference for a customer checkout	String	'd290f1ee-6c54-4b01-90e6-d701748f0851'
MerchantCustomer	Additional data describing the customer	Object	You can include: billingAddress shippingAddress phone email birthDate
Address	A customer address (e.g. billing address)	Object	The following fields are mandatory: firstName lastName address1 town county postcode country
Amount	A positive numeric amount with 2 decimals represented as string	String	1345.23
Currency	An ISO3 currency code	String	GBP
MerchantBasket	A representation of all the items that the customer is attempting to purchase	Object	The following fields are mandatory: currency total items
LineItem	A specific item in the customer basket. Includes the description, price, and quantity	Object	The following fields are mandatory: description quantity price type
LineItemType	Type of line item (e.g. "sku", "discount", "shipping", "tax")	String	Valid values are: sku discount shipping tax
Product	One of the existing Deko products (e.g. "split")	String	Valid values are: split monthly revolving_credit
InitToken	A JWT token containing the products available to the merchant	String	See Token Example
CheckoutAuthorizationCertificate	A base-64 encoded certificate to authorise the customer to checkout	String	See Token Example
CheckoutResult	The result of a processed Checkout	Object	The following fields are mandatory: links basket product status created last_updated
CheckoutId	A UUID of a customer checkout	String	d81fc604-f089-455e-b7c4-43b43399f211
CheckoutStatus	The status of the customer checkout	String	Valid values are: success failed cancelled initialised
ClientId	A valid client ID API consumers receive when onboarded	String	vL0ZsEN9j5NT4VP3cFKBp1jF94sm5C8v
ClientSecret	Client secret merchants receive when onboarded; used to obtain authentication token	String	jTQKBCmoMyvrWGSwIwyNJVG3_APoftqb ynyU61hScV1nCnj0gLAvMCocsOTT44xj
MerchantCallbackUri	The callback URL to send success or failure to on the Merchant integration	String	https://merchant-platform.fake/deko/callback
Application	The current application	Object	Consists of: links id
ApplicationId	Credit application Unique identifier generated by Deko.	String	f7210019-2e4a-49f7-bd7b-b167285c5424
ApplicationStatus	The current status of the customer application. Used to pass information to frontend clients, such as Deko Wallet	Object	Consists of: last_updated state links
PollInterval	The interval (in seconds) it is recommended to poll the application status. Failure to adhere to the poll recommendation (ie, polling too rapidly) may lead to rate limiting	Integer	5
PublicSigningKey	A Deko public key used to verify signatures from Deko	Object	Consists of: links key public expiry
SigningKeyHeader	An object describing the key used to sign the payload	Object	Consists of: description key:public key:verify
SigningKeyUri	URL to the signing key	Object	href object example: /key/32b76dab-1e49-41f0-a802-219cccc0ce54/verify
SigningKeyVerifierUri	URL to the signing key verifier	Object	href object example: /key/32b76dab-1e49-41f0-a802-219cccc0ce54/verify
SigningKeyId	A key ID used to denote a particular public key used for signing payloads from Deko	String	n/a

Access Token Example

eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6Imp6SXZmaU1HNkJqVEpUWGxkRlVwZSJ9.eyJpc3MiOiJodHRwczovL2Rla29wYXktbWVyY2hhbnQtZGV2LmV1LmF1dGgwLmNvbS8iLCJzdWIiOiJ2TDBac0VOOWo1TlQ0VlAzY0ZLQnAxakY5NHNtNUM4dkBjbGllbnRzIiwiYXVkIjoiaHR0cDovL2xvY2FsaG9zdDo4MDgxL2FwaS9jaGVja291dCIsImlhdCI6MTYxNjU5MTU4NywiZXhwIjoxNjE2Njc3OTg3LCJhenAiOiJ2TDBac0VOOWo1TlQ0VlAzY0ZLQnAxakY5NHNtNUM4diIsImd0eSI6ImNsaWVudC1jcmVkZW50aWFscyJ9.F-dzPkJVF0ub2kGiWn1As5PSMnIiqAriOhyux47t7lbNk0tD9Wu655JGHmjuAqqQ3uWyqXx9-feuYjv61xufgBfxH17OkIqBB9lVJzEONoVqF5uIzsnaTD2z0FTzcvOuH8RXzA-_q7vFZwvbboE9iZCFd-JN8vI_1jjWDUpdKFWzGk0-AmID9F7qgNnyC2WEb6DK4Ky5VttXPXcGfnIGD2ybOgkg1dOlBhzabJBT9jU_UQuBoKjqQoNqVm1ovhFJzzSWMsHqDIDOb7r-0zXRB33ka4_oKoVnVrvxL2hGblgC-2Jg6gfB7uuVPdbM5FIBFx8Cbt4T83KxXbpJy5hQbg