Endpoints
Attributes
string
required
The financing application ID, starting with inrq_.
string
required
The ID of the merchant account applying for payment financing, starting with
biz_.
string
required
When the application was created, as an ISO 8601 timestamp.
string | null
Public review feedback when more information is requested or the application
is denied. Internal notes are never included.
object[]
Merchant requirements and saved answers. Present on individual application responses, omitted from lists. Acceptance is collected separately on submit.
Properties
Properties
string
required
Requirement ID to use when updating this application’s answers.
string[]
required
Accepted document formats, such as pdf or jpeg.
string
required
The information requested, such as business_description or
processing_statements.
string
required
Whether the requirement accepts no file, one file, or multiple files.Available options:
none, single, multiobject[]
required
Files attached to this requirement, including expiring download URLs.
Properties
Properties
string
required
The file’s ID, prefixed
file_.string | null
required
BlurHash placeholder for an image or video. Null when unavailable or removed
by moderation.
string | null
required
The original file’s MIME type, for example
application/pdf. It is kept when
moderation removes the file.string
required
When the file was created, as an ISO 8601 timestamp.
number | null
required
Audio or video duration in seconds. Null when unavailable or removed by
moderation.
string | null
required
The original filename, including its extension.
integer | null
required
Image or video height in pixels. Null when unavailable or removed by
moderation.
integer | null
The byte size each part (except the last) must be. Present only on create, and
only for multipart uploads.
string | null
The ID of the multipart upload, passed back to
complete. Present only on
create, and only for multipart uploads.object[] | null
string
required
The type of this object, always
file.boolean
required
Whether moderation removed the file. When
true, url serves a replacement
image. filename, size and content_type still describe the original file.integer | null
required
The file size in bytes.
null until the upload has finished.object
Headers to send with the upload PUT. Present only on create.
string
required
Where the file is in its upload lifecycle.Available options:
pending, processing, ready, failedstring | null
Presigned URL to PUT the file’s bytes to. Present only on create, and only for
single-part uploads.
string | null
required
A URL to download the file. Public files get a permanent CDN URL, and private
files get a signed URL that expires.
null until the upload has finished.
When moderation removes the file, a replacement image URL.string
required
public files are served from an unsigned CDN URL. private files are served from a signed URL that expires.Available options: public, privatestring | null
required
Audio waveform URL. Null when unavailable or removed by moderation.
integer | null
required
Image or video width in pixels. Null when unavailable or removed by moderation.
integer
required
Maximum size in bytes for each uploaded document.
integer | null
required
Minimum characters per text answer, when specified.
object | null
required
Saved maximum product price in its original currency. Null when unanswered or the saved legacy answer is invalid.
Properties
Properties
string
required
The amount in major units, as an exact decimal string. For example,
"10.00"
is ten dollars. It is a string so that no float rounds it in transit.string
required
Three-letter ISO 4217 currency code, lowercase.
integer
required
How many decimal places the amount carries. This is the precision the charge
itself runs at.
integer
required
How many decimal places to SHOW. Usually equal to
decimals, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is 2 and 0. Format the number in your own locale using this.string[]
required
Allowed dropdown values. Empty when the answer is not an enumeration.
boolean
required
Whether this requirement must be completed before submission.
string
required
Whether the requirement accepts no text, one value, or multiple values.Available options:
none, single, multistring
required
Expected text format. max_product_price uses money instead of values.Available options:
plain, url, email, phone, number, checkbox, dropdownstring[]
required
Saved text answers. Empty for money requirements. Read
money for those.string
required
The application’s review state. Approval does not by itself indicate that financing payment methods are enabled on the account.Available options:
requires_collection, awaiting_review, completed, approved, deniedobject
Current terms to present before submitting. Present on individual application responses.
Properties
Properties
string
required
The exact plain-text contract snapshot covered by this version. Present this
content, the policies, and the disclosure before collecting acceptance.
string
required
Affirmative acceptance statement to present to the merchant.
string
required
Additional financing fee information.
string[]
required
Financing policies to present alongside the contract before collecting
acceptance.
string
required
Source URL for the Splitit contract snapshot.
string
required
Content fingerprint to pass as merchant_acceptance.terms_version when submitting.
string
required
When the application was last updated, as an ISO 8601 timestamp.
FinancingApplication