Consumer Level Lending
Reference
/3ds/create-payment-link/{checkoutId}/{applicationId}
/account/{checkoutToken}
/account/{checkoutToken}/{accountToken}
/account/{checkoutToken}/{accountToken}/address
/account/{checkoutToken}/{accountToken}/address/{addressToken}
/account/{checkoutToken}/{accountToken}/identity
/account/{checkoutToken}/{accountToken}/income-expense
/account/{checkoutToken}/{accountToken}/validation
/account/{checkoutToken}/{accountToken}/wallet
/account/{checkoutToken}/{accountToken}/wallet/{walletToken}
/account/{checkoutToken}/{accountToken}/wallet/{walletToken}/primary
/app/{checkoutToken}/{applicationToken}
/app/{checkoutToken}/{applicationToken}/documents
/app/{checkoutToken}/{applicationToken}/payments
/app/{checkoutToken}/{applicationToken}/payments/{paymentID}
/checkout/create
/checkout/{CheckoutToken}
/checkout/{CheckoutToken}/meta
/checkout/{checkoutToken}/discount
/dispersal/{dispersalToken}
/offers/{checkoutToken}
/offers/{checkoutToken}/{offerToken}
/utils/offers
/utils/search

API Error handling

Any errors thrown by the server will always result in a HTTP CODE 500 with the error details in a format displayed here.

object
code
object

Failure types are objects with a key code that will represent the failure code, it might have one or many additional variables available, see context for more clearance.

In the table below, when refering to a variable, the variable will be added as additional peace of information together with the code indicator.

Example:

{
  "code": 114,
  "count": 2
}
Code Section Description
401 Common Internal server error.
402 Common This application is no longer editable due to cancellation taking place.
901 Authorisation Provided authorisation barrier token is not valid.
902 Authorisation Provided authorisation barrier token has not been authorised via IP address IP.
903 Authorisation You are not permitted to perform this action. Please contact your account manager to acquire permission to use this endpoint.
1001 Checkout (Create) Reference code is not valid
1002 Checkout (Create) Currency code is not valid
1003 Checkout (Create) Country code is not valid
1003 Checkout (Create) Country code is not valid
1004 Checkout (Create) Your merchant account is not permitted to create checkout in requested jurisdiction.
1005 Checkout (Create) Your merchant account is not permitted to create checkout in requested currency.
1006 Checkout (Create) The provided integrationToken was not found, please refer to merchant portal.
1201 Itinerary The provided checkoutToken was not found.
1202 Itinerary Provided itinerary type is not valid.
1203 Itinerary Provided balance is not valid.
1204 Itinerary Your merchant account is not permitted to use requested itinerary type.
1205 Itinerary (Flight) Flight departure country provided is not valid.
1206 Itinerary (Flight) Flight arrival country provided is not valid.
1207 Itinerary (Flight) Flight departure date provided is not valid.
1208 Itinerary (Flight) Flight arrival date provided is not valid.
1209 Itinerary (Flight) The dob format for one of the passengers is not valid.
1210 Itinerary (Flight) The IATA code provided for departure flight is not valid.
1211 Itinerary (Flight) The IATA code provided for arrival flight is not valid.
1212 Itinerary (Hotel) The check-in date provided is not valid.
1213 Itinerary (Hotel) The check-out date provided is not valid.
1214 Itinerary (Hotel) The name of the hotel provided is not valid.
1215 Itinerary (Hotel) The country code of the hotel location provided is not valid.
1216 Itinerary (Hotel) The room count provided is not valid.
1217 Itinerary (Hotel) The dob format for one of the persons is not valid.
1218 Itinerary (Rent) The rentable period start date provided is not valid.
1219 Itinerary (Rent) The rentable period end date provided is not valid.
1220 Itinerary (Rent) The rentable element name provided is not valid.
1221 Itinerary (Rent) The country code of the rentable element location provided is not valid.
1222 Itinerary (Rent) The dob format for one of the persons is not valid.
1223 Itinerary Update The called checkoutToken does not have a valid itinerary registered against it.
1224 Itinerary Update The related checkout already has a dispersal token assigned to it, itinerary is locked.
1401 Offer (Status) The provided checkoutToken was not found.
1402 Offer (Status) There is no itinerary submitted against the checkout.
1601 Offer (Info) The provided checkoutToken was not found.
1602 Offer (Info) The provided offerToken was not found.
1801 Offer (Select) The provided checkoutToken was not found.
1802 Offer (Select) The provided offerToken is not valid.
1803 Offer (Select) The provided term is not valid.
1804 Offer (Select) The provided offerToken was not found.
1805 Offer (Select) The related checkout already has a dispersal token assigned to it, itinerary is locked.
2001 Account (Connect) The provided checkoutToken was not found.
2002 Account (Connect) The provided email is not valid.
2003 Account (Connect) The provided pin code was not valid.
2004 Account (Connect) The provided pin code is valid but has expired past its 12 hour expiry margin.
2005 Account (Conenct) The related checkout already has a dispersal token assigned to it, itinerary is locked.
2201 Account (Read Information) The provided checkoutToken was not found.
2202 Account (Read Information) There is no account connected with the checkout.
2203 Account (Read Information) Provided account token is not valid.
2401 Account (Update information) The provided checkoutToken was not found.
2402 Account (Update information) There is no account connected with the checkout.
2403 Account (Update information) Account token provided is not valid or does not match the token connected with the checkout.
2404 Account (Update information) Gender type provided is not valid.
2405 Account (Update information) Full name provided is not valid.
2406 Account (Update information) First names provided is not valid.
2407 Account (Update information) Middle names provided is not valid.
2408 Account (Update information) Last names provided is not valid.
2409 Account (Update information) Date of birth provided is not valid.
2410 Account (Update information) Residential type provided is not valid.
2411 Account (Update information) Employment type provided is not valid.
2412 Account (Update information) Salary provided is not valid.
2413 Account (Update information) Salary currency provided is not vlaid.
2414 Account (Update information) Mobile phone country provided is not vlaid.
2415 Account (Update information) Mobile phone number provided is not valid.
2416 Account (Update information) The related checkout already has a dispersal token assigned to it, itinerary is locked.
2417 Account (Update information) The provided UK bank details are not valid
2418 Account (Update information) The marital status is a required field
2419 Account (Update information) The martial status does not contain a valid value
2420 Account (Update information) The dependants is a required field
2421 Account (Update information) The dependants does not contain a valid value
2422 Account (Update information) The usingSavings is a required field
2423 Account (Update information) The usingSavings does not contain a valid value
2424 Account (Update information) The socialSecurityNumber does not contain a valid value
2601 Address (List) The provided checkoutToken was not found.
2602 Address (List) There is no account connected with the checkout.
2603 Address (List) Given account token was not valid.
2801 Address (Create) The provided checkoutToken was not found.
2802 Address (Create) There is no account connected with the checkout.
2803 Address (Create) Given account token was not valid.
2804 Address (Create) Type provided is not valid.
2805 Address (Create) Primary identifier provided is not valid.
2806 Address (Create) Country code provided is not valid.
2807 Address (Create) We were unable to verify given address addressString.
2808 Address (Create) The “house” is a mandatory field.
2809 Address (Create) The “postcode” is a mandatory field.
2810 Address (Create) The “postcode” value is not valid.
3001 Address (Update) The provided checkoutToken was not found.
3002 Address (Update) There is no account connected with the checkout.
3003 Address (Update) Given account token was not valid.
3004 Address (Update) Primary identifier provided is not valid.
3005 Address (Update) Country code provided is not valid.
3006 Address (Update) Provided addressToken was not found.
3007 Address (Update) We were unable to verify given address addressString.
3008 Address (Update) The “house” is a mandatory field.
3009 Address (Update) The “postcode” is a mandatory field.
3010 Address (Update) The “postcode” value is not valid.
3201 Address (Delete) The provided checkoutToken was not found.
3202 Address (Delete) There is no account connected with the checkout.
3203 Address (Delete) Given account token was not valid.
3204 Address (Delete) Provided addressToken was not found.
3205 Address (Delete) Cannot delete address because it is linked with a payment method, see walletToken for reference.
3401 Payment Method (List) The provided checkoutToken was not found.
3402 Payment Method (List) There is no account connected with the checkout.
3403 Payment Method (List) Given account token was not valid.
3601 Payment Method (Create) The provided checkoutToken was not found.
3602 Payment Method (Create) There is no account connected with the checkout.
3603 Payment Method (Create) Given account token was not valid.
3604 Payment Method (Create) Provided type has invalid value.
3605 Payment Method (Create) The primary key must be provided and must be a boolean.
3606 Payment Method (Create) The type key must be provided and must be an integer.
3607 Payment Method (Create) The billing address token must be provided.
3608 Payment Method (Create) The billingAddressToken was not valid.
3609 Payment Method (Create) The provided billing address token matched an address that is not a billing address.
3610 Payment Method (Create) The name on card must be provided.
3611 Payment Method (Create) The card number (PAN) must be provided.
3612 Payment Method (Create) The card expiry month must be provided as integer.
3613 Payment Method (Create) The card expiry year must be provided as integer.
3614 Payment Method (Create) The card expiry year cannot be in past.
3615 Payment Method (Create) The card expiry cannot be in past.
3616 Payment Method (Create) The card expiry is not a valid Month/Year combination.
3617 Payment Method (Create) The card PAN consists of invalid symbols, only numbers allowed.
3618 Payment Method (Create) The card PAN number has an invalid length.
3619 Payment Method (Create) The card CVV number has not been provided or is not a string.
3620 Payment Method (Create) The card CVV consists of invalid symbols, only numbers allowed.
3621 Payment Method (Create) The card CVV has an invalid length, must be 3 or 4.
3622 Payment Method (Create) Payment method not accepted due to failed validation, ensure the card belongs to the applicant or ensure the applicant has filled out their profile.
3801 Payment Method (View) The provided checkoutToken was not found.
3802 Payment Method (View) There is no account connected with the checkout.
3803 Payment Method (View) Given account token was not valid.
3804 Payment Method (View) Given wallet token was not valid.
4001 Payment Method (Delete) The provided checkoutToken was not found.
4002 Payment Method (Delete) There is no account connected with the checkout.
4003 Payment Method (Delete) Given account token was not valid.
4004 Payment Method (Delete) Given wallet token was not valid.
4005 Payment Method (Delete) CVV was not provided in the query string.
4006 Payment Method (Delete) The CVV provided is not valid.
4201 Account Validation The provided checkoutToken was not found.
4202 Account Validation There is no account connected with the checkout.
4203 Account Validation Given account token was not valid.
4204 Account Validation There is no itinerary registered on checkout.
4205 Account Validation There is no offer selected on checkout.
4206 Account Validation There is no offer term selected on checkout.
4207 Account Validation Account e-mail address is not set.
4208 Account Validation Account full name is not set.
4209 Account Validation Account first name is not set.
4210 Account Validation Account last name is not set.
4211 Account Validation Account date of birth is not set.
4212 Account Validation Account gross salary is not set.
4213 Account Validation Account gross salary currency code is not set.
4214 Account Validation Account gender type is not set.
4215 Account Validation Account employment type is not set.
4216 Account Validation Account resident type is not set.
4217 Account Validation Account mobile phone country is not set.
4218 Account Validation Account mobile phone number is not set.
4219 Account Validation Account has no primary residential address on record.
4220 Account Validation Account date of birth indicates person to be underage, we cannot accept this.
4221 Account Validation Account employment type indicates no income, we cannot be accepted.
4222 Account Validation Annual gross salary currency set on account does not qualify, see required currency.
4223 Account Validation Annual gross salary is too low, see required minimum amount.
4224 Account Validation Your request cannot be processed at this point in time. Might be due to a temporary service unvailability.
4225 Account Validation Our API has indicated a high risk case, to continue customer must change their offer from currentOfferToken to changeOfferToken with the proposed changeToTerm.
4226 Account Validation The customer has failed our credit checks, cannot continue.
4227 Account Validation ID verification is required in order to verify this account.
4228 Account Validation The credit file was not found, request customer to review their personal details.
4230 Account Validation Account date of birth indicates person to be over the age limit, we cannot accept this.
4231 Account Validation Account information is confirmed, however you must submit their Income & Expense information. Once done, retry this endpoint to receive a confirmation on accept or a reject of the application.
4232 Account Validation Account social security number is not set.
4401 Payment Method (Set Primary) The provided checkoutToken was not found.
4402 Payment Method (Set Primary) There is no account connected with the checkout.
4403 Payment Method (Set Primary) Given account token was not valid.
4404 Payment Method (Set Primary) Given wallet token was not valid.
4601 Document list The provided checkoutToken was not found.
4602 Document list You have not validated account information.
4603 Document list The provided application token is not valid.
4604 Document list The provided application token has not been accepted during account validation.
4801 Document signing The provided checkoutToken was not found.
4802 Document signing You have not validated account information.
4803 Document signing The provided application token is not valid.
4804 Document signing The provided application token has not been accepted during account validation.
4805 Document signing The PUT data does not contain an array.
4806 Document signing The document id list provided contains invalid reference(s).
5001 Utility - Offer generation Submitted body does not contain a valid array, or the provided array is empty.
5002 Utility - Offer generation There was no ID or the ID provided was not valid, see index to identify which array index had a failure to match ID.
5201 Payment List The provided checkoutToken was not found.
5202 Payment List You have not validated account information.
5203 Payment List The provided application token is not valid.
5204 Payment List The provided application token has not been accepted during account validation.
5205 Payment List There are no legal documents assigned with the application.
5206 Payment List There are unsigned documents, see documents.
5401 Payment Authorisation The provided checkoutToken was not found.
5402 Payment Authorisation You have not validated account information.
5403 Payment Authorisation The provided application token is not valid.
5404 Payment Authorisation The provided application token has not been accepted during account validation.
5405 Payment Authorisation Payment ID provided was not valid.
5406 Payment Authorisation This payment has already been authorisd.
5407 Payment Authorisation The bank has rejected payment method (Invalid), potential problems related to card number, expiry.
5408 Payment Authorisation The bank has rejected payment method (Invalid), potential problems with security code, billing address.
5409 Payment Authorisation The bank has rejected the payment due to insufficient funds.
5410 Payment Authorisation The referred payment method was not found.
5411 Payment Authorisation The referred payment method is not supported by the up-front payment system.
5412 Payment Authorisation The payment system is not available at this time.
5601 ID Documents The provided checkoutToken was not found.
5602 ID Documents Checkout does not have an account connected.
5603 ID Documents Provided account token is not valid or disconnected.
5604 ID Documents Document type is not supported.
5605 ID Documents Document content not provided.
5606 ID Documents Provided document content cannot be uploaded or parsed.
5607 ID Documents Filename extension not supported.
5608 ID Documents Document content might be corrupted, ensure it’s uploaded in base 64 encoding.
5609 ID Documents Cannot confirm the document, might be blury or unreadable.
5610 ID Documents Cannot confirm, document seems to be falsified.
5611 ID Documents Cannot confirm, document seems to be a copy. Upload a photo of the original.
5612 ID Documents Cannot confirm, document has expired.
5613 ID Documents Cannot confirm, document format does not match provided document type.
5614 ID Documents Cannot confirm, date of birth on the application does not match date of birth within the document.
5615 ID Documents Cannot confirm, name on the application does not match name within the document.
5801 Application Validation The provided checkoutToken was not found.
5802 Application Validation Checkout does not have an account connected.
5803 Application Validation Application token is not valid or disconnected.
5804 Application Validation Application is not connected to an account, or connected account has incomplete details.
5805 Application Validation Application is missing legal documents.
5806 Application Validation Not all legal documents are signed.
5807 Application Validation Not all up-front payments are settled.
5808 Application Validation Failed to create dispersal token due to internal errors.
5809 Application Validation There is no valid UK bank account number registered against the account
5810 Application Validation There is no valid UK bank sort code registered against the account
5901 Acquire Payment Instrument Connected checkout was not found.
5902 Acquire Payment Instrument Connected application was not found.
5903 Acquire Payment Instrument Connected currency was not found.
5904 Acquire Payment Instrument Connected currency is not valid.
5905 Acquire Payment Instrument Connected itinerary was not found.
5911, 5912 Acquire Payment Instrument Payment instrument acquery failed.
6001 Checkout (Meta update) The provided checkoutToken was not found.
6002 Checkout (Meta update) The metadata can no longer be updated.
6101 Merchant Cancellation The provided checkoutToken was not found.
6102 Merchant Cancellation Cancellation is not possible at this time, please contact Fly Now Pay Later to execute this cancellation manually.
6201 Income & Expense Provided value for variable must be an integer, for example 1000 equals to 10.00, or 123456 equals to 1,234.56.
6202 Income & Espense Provided value for variable must be a either a zero or a positive number.
6203 Income & Espense This endpoint requires you to perform the account validation first.
6204 Income & Expense This endpoint cannot be called to perform updates, you must enter all the values and then call the account validation endpoint.
6401 3DS Payment The provided checkoutToken was not found.
6402 3DS Payment The referenced application was not found.
6403 3DS Payment The referenced application is not eligible to take upfront payments.
6404 3DS Payment The referenced application is not eligible to take upfront payments (Credit Check not passed).
6405 3DS Payment The referenced application does not have any upfront payments to take.
6406 3DS Payment The referenced payment method is not valid to take upfront payments.
6407 3DS Payment System error - there was a payment processing reference erorr, the device data collection token (JWT) was not found.
6408 3DS Payment System error - there was a payment processing reference error, remote id was not found.
6409 3DS Payment System error - there was a payment processing reference error, session id not found.
6410 3DS Payment System error - there was a payment processing reference error, payment record not found.
required
params
array[string]

If the fail code provides additional variables, they will be available under the params key.