API Reference

Allows Merchant data to be gathered for both BCA and Flexi products.


Product discriminator

Use the deal.type or application.type to differentiate the products and power your user experiences or API calls. The deals array and the applications array can contain a mix of BCA and Flexi objects.

Flexi response differences

  • deals.performance will be null
  • deals.pricing.factor_rate will be null
  • deals.transactions.payment_channel_id will be null
  • applications.pricing will be null
  • applications.contract_link will be null



Flexi statuses

Account / Deal:

Active,
Frozen,
EndOfAvailabilityPeriod,
Paid,
WrittenOff,
NeverUtilised

Application:

Submitted,
Approved,
Activated,
Cancelled,
Declined

Advance:

ReadyForFunding,
NeedsIntervention,
Rejected,
Funded


BCA Statuses

Application:

Agreement Signed,
Approved,
Assigned,
Cancelled,
Created,
Declined,
Evidenced,
Funded,
Ineligible,
Lost,
Quoted,
Repaid,
Rescinded,
Split Placed,
Submitted,
Withdrawn,
Written Off

Deal:

Open, (Deal is funded)
Closed (Deal is not yet funded / Deal is repaid)
Language
Credentials
OAuth2
Click Try It! to start a request and see the response here!