Apply a Payment to an Invoice
Manually apply a payment to an invoice.
Pass a transaction_id to apply a bank transaction as payment, or omit
transaction_id and pass payment_amount to draw from the customer’s
available credit pool.
Scopes: invoice:create
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Optional external entity identifier that performed the action
Path Parameters
The id of the business
"biz_GA6EG2qFxA97NZHtxeLPUy"
Body
The ID of the invoice to apply payment to
"inv_Lq5AyApd4pdL1VvakpY5aJ"
The ID of the transaction to apply as payment. If null, the payment is drawn from the customer's available credit pool and payment_amount is required.
"txn_oiL7THC5RDi2PVUbVyyoJ"
The amount to apply as payment. When transaction_id is provided, defaults to the transaction amount. When transaction_id is null, this is required and must be greater than zero.
x >= 0Response
Successful Response