Sign in

v1

latestOpenAPI 3.0.2Apache 2.02026-07-14384753.8 KB
Transactions and Payments

Create Invoice Item Payment

post/transactions/payments/invoice/{invoiceid}/items/{itemid}

Path parameters

invoiceidstring required
itemidstring required

Headers

x-business-idstring required

Request body

timestampstring date-time required

The date and time the transaction occured in UTC

amountnumber required

The dollar amount of the transaction

currencystring

The currency of the transaction

description'payment' | 'partial' | 'deposit' required

An enumeration.

methodstring

The Payment method used to pay this invoice. Eg. Credit Card, Check (Cheque) etc.

sourcestring

Name of the third party payments processor such as Stripe, Adyen, Square, etc.

sourceReferenceIdstring

Optional reference to associate payments processed through a third party

Response

Successful Response

transactionIdstring required

Unique ID for this Transaction