List POS Lending applications
Returns a paginated list of BNPL applications for the authenticated merchant. Supports the same query filters as the merchant UI (BnplApplicationsFilterDto). Requires Avvance POS Lending to be enabled on the merchant.
query Parameters
timeZoneTime zone
clientIdFilter by client ID
nameFilter by customer name (case-insensitive search)
emailFilter by customer email (case-insensitive search)
phoneNumberFilter by customer phone number (case-insensitive search)
statusFilter by lead status
expiredFilter by expired applications
amountFilter by amount range
createdAtStartDateFilter by creation date start (ISO date string)
createdAtEndDateFilter by creation date end (ISO date string)
pagePage number for pagination
limitNumber of items per page
sortSort field and direction
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
List POS Lending applications › Responses
Share POS Lending application link
Sends the Avvance pre-approval link to a customer by email and/or SMS. Requires Avvance POS Lending to be enabled on the merchant.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Share POS Lending application link › Request Body
nameCustomer display name
emailCustomer email
phoneNumberCustomer phone
Share POS Lending application link › Responses
Charge a POS Lending payment
Initiates an Avvance loan charge for a PRE_APPROVED application. applicationId (the Mongo id of the POS Lending application, as returned by the applications list) is required and must belong to the authenticated merchant. Customer identity (name, email, phone) is always taken from the pre-approval and cannot be overridden. amount is expressed in cents, must be at least 30000 ($300) and must not exceed the application's pre-approved maximum (nor the Avvance hard cap of $25,000) — amounts above the maximum are rejected, never capped. The payment is created in pending status: the customer must complete the loan through the returned consumerOnboardingUrl, and the final result (paid/declined/settled) arrives asynchronously via Avvance webhooks. Idempotency: repeating the charge for the same applicationId and amount while a non-declined, non-voided payment exists replays that payment with duplicate: true; a charge for a different amount creates a new loan.
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
Charge a POS Lending payment › Request Body
applicationIdId of the PRE_APPROVED POS Lending application to charge (the id field returned by the applications list). Must belong to the merchant of the API key.
amountAmount to charge in cents (smallest currency unit). Minimum 30000 ($300). Must not exceed the application's maxPreApprovedAmount nor the Avvance hard cap of 2500000 ($25,000).
invoiceNumberMerchant invoice/order reference forwarded to Avvance. Defaults to the application's Avvance lead id.
sendReceiptWhen true (default) Zero emails/SMSes the loan-completion link to the customer contact on the pre-approval. Set to false if you deliver the returned consumerOnboardingURL yourself.
currencyCurrency. Only USD is supported.
Charge a POS Lending payment › Responses
Charge initiated. The payment stays pending until the customer completes the loan.
Refund a POS Lending payment
Refunds a settled POS Lending (Avvance) payment of the authenticated merchant. amount is expressed in cents. Partial refunds are allowed until the paid amount is fully refunded. POS Lending payments become refundable only after U.S. Bank settles the loan (asynchronous, via webhook).
Headers
key-hashSecurity key hash issued to your integration (merchant dashboard: Administration → Security Keys).
user-agentRecorded on the transaction for auditing; not validated.
Refund a POS Lending payment › Request Body
paymentIdId of the POS Lending payment to refund.
amountAmount to refund in cents (smallest currency unit). Partial refunds are allowed up to the remaining paid amount.
reasonReason for the refund.
Refund a POS Lending payment › Responses
Refund processed and submitted to U.S. Bank.