Our Application API exposes all the methods you need to create, check the status, upload an invoice, and add the delivery information for your applications.
Check our reference guide for all the methods available.
When creating an application, you can provide the
Callback-Url HTTP header with an URL that our system will POST to when there is an update on the status of the application during the application process.
The URL must be public, secure (i.e., it must use HTTPS), support JSON requests, and return a 200 (OK) response.
Here are the fields included in the request:
|publicId||string||No||The Public ID that can be used for all further references to this application or pre-qualification.|
|applicationId||int||Yes (when there is no application)||Our internal application ID|
|status||string||No||Current status. The possible values are: Declined, Approved, Signed, Funded and Returned|
|phone||string||No||Customer's phone number|
|approvalAmount||decimal||Yes (when status is Declined)||Approval Amount|
|borrowedAmount||decimal||Yes (when status is not Signed)||Contract's Borrowed Amount|
|invoiceAmount||decimal||Yes (when status is not Signed)||Contract's Invoice Amount|
|totalInStorePayment||decimal||Yes (when status is not Signed)||Contract's Total In Store Payment|
|financingPartnerCode||string||Yes (when status is not Signed)||Contract's Financing Partner Code|
|financingPartnerName||string||Yes (when status is not Signed)||Contract's Financing Partner Name|
|financingPartnerDisplayName||string||Yes (when status is not Signed)||Contract's Financing Partner Display Name|
|paymentInfo||object||Yes (when payment is not Created)||Contract's Payment Information|
Contract's Payment Information fields:
|transferId||string||Yes (when status is manually processed)||Payment Transfer ID|
|wireReferenceId||string||Yes (when status is not manually processed)||Payment Wire Reference ID|
|status||string||No||Payment Status. The possible values are: pending, processed, manually processed and returned|