API ReferenceInvoiceBnpl

Get BNPL Loan

Get information about a specific BNPL loan by loan ID

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path Parameters

loanIdstringRequired
The ID of the loan to retrieve

Response

This endpoint returns an object.
loanIdstring
The unique identifier for the loan
businessExternalIdstring
The external ID of the business entity
dueDateinteger
The final due date as timestamp in milliseconds
originalPrincipalBalanceinteger
The original principal balance in cents
drawDateinteger
The date the loan was drawn as timestamp in milliseconds
repaidAmountinteger
The total amount repaid in cents
paymentMethodIdstring
The ID of the payment method used
repaymentMethodIdstring
The ID of the repayment method
statusenum
The current status of the loan
Allowed values:
outstandingBalanceobject
The current outstanding balance breakdown
invoiceAmountinteger
The original invoice amount in cents
invoiceExternalIdstring
The external ID of the associated invoice
invoiceDueDateinteger
The original invoice due date as timestamp in milliseconds
downPaymentAmountinteger
The down payment amount in cents
installmentslist of objects
List of all installments for this loan
cadenceenum
The payment cadence for the loan
Allowed values:
baseFeeRatedouble
The base fee rate as a percentage
termsAgreementFilestring or null
URL to the terms agreement file
invoiceUrlstring or null
URL to the invoice PDF

Errors