invoice > bnpl

Get BNPL Loan

Get information about a specific BNPL loan by loan ID

get/bnpl/loan/{loanId}

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/bnpl/loan/{loanId}
  • Auth: HTTP bearer

Path parameters

loanIdstring required

The ID of the loan to retrieve

Response

Response with status 200

loanIdstring required

The unique identifier for the loan

businessExternalIdstring required

The external ID of the business entity

dueDateinteger required

The final due date as timestamp in milliseconds

originalPrincipalBalanceinteger required

The original principal balance in cents

drawDateinteger required

The date the loan was drawn as timestamp in milliseconds

repaidAmountinteger required

The total amount repaid in cents

paymentMethodIdstring required

The ID of the payment method used

repaymentMethodIdstring required

The ID of the repayment method

status'PENDING' | 'ACTIVE' | 'PAID_OFF' | 'DELINQUENT' required
termsAgreementFilestring

URL to the terms agreement file

invoiceUrlstring

URL to the invoice PDF

invoiceAmountinteger required

The original invoice amount in cents

invoiceExternalIdstring required

The external ID of the associated invoice

invoiceDueDateinteger required

The original invoice due date as timestamp in milliseconds

downPaymentAmountinteger required

The down payment amount in cents

cadence'WEEKLY' | 'BIWEEKLY' | 'MONTHLY' required
baseFeeRatenumber double required

The base fee rate as a percentage

Changes

No recorded changes to this operation across all 1 revision of this API.