Payments API

Endpoint Index

ActionEndpoint
Fetch a PaymentGET /billing/{tenantLocator}/payments/{locator}
Fetch Multiple PaymentsGET /billing/{tenantLocator}/payments/list
Fetch SubpaymentsGET /billing/{tenantLocator}/payments/{locator}/subpayments/list
Create a PaymentPOST /billing/{tenantLocator}/payments
Update a PaymentPATCH /billing/{tenantLocator}/payments/{locator}
Update a Payment (overwrite extension data)PUT /billing/{tenantLocator}/payments/{locator}
Validate a PaymentPATCH /billing/{tenantLocator}/payments/{locator}/validate
Post a PaymentPATCH /billing/{tenantLocator}/payments/{locator}/post
Reverse a Posted PaymentPATCH /billing/{tenantLocator}/payments/{locator}/reverse
Reset a Validated Payment Back to Draft StatePATCH /billing/{tenantLocator}/payments/{locator}/reset
Discard a PaymentPATCH /billing/{tenantLocator}/payments/{locator}/discard
Fetch shortfall creditsGET /billing/{tenantLocator}/payments/{locator}/shortfallCredits/list
Fetch a Payment
fetchPayment
GET /billing/{tenantLocator}/payments/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Security Group:payments   Permission:read
Fetch Multiple Payments
fetchMultiplePayments
GET /billing/{tenantLocator}/payments/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    offsetqueryint?optional
    countqueryint?optional
    accountLocatorquerystring?optional
    targetContainerLocatorquerystring?optional
    extendedqueryboolean?optional
    Security Group:payments   Permissions:read,list
Fetch Subpayments
fetchSubpayments
GET /billing/{tenantLocator}/payments/{locator}/subpayments/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    offsetqueryint?optional
    countqueryint?optional
    Security Group:payments   Permissions:read,list
ListPageResponsePaymentResponse
required
listCompleted boolean
PaymentResponse
required
locator string
currency string
paymentState Enum draft | validated | posted | reversed | discarded
amount number
type string
createdAt datetime
createdBy uuid
shortfallCreditLocators string[]
subpayments SubpaymentResponse[]
targets CreditItem[]

optional
accountLocator string?
aggregatePaymentLocator string?
externalCashTransactionLocator string?
paymentMode Enum? aggregate | normal
postedAt datetime?
remainingAmount number?
reversalReason string?
reversedAt datetime?
reversedBy uuid?
validationResult ValidationResult?
data map<string,object>?
SubpaymentResponse
required
subpaymentLocator string
amount number
CreditItem
required
containerLocator string
containerType Enum account | invoice | subpayment

optional
amount number?
Create a Payment
createPayment
POST /billing/{tenantLocator}/payments
PaymentCreateRequest
required
amount number
type string
useDefaultFinancialInstrument boolean
data map<string,object>
targets CreditItem[]

optional
accountLocator string?
financialInstrumentLocator string?
currency string?
paymentMode Enum? aggregate | normal
transactionMethod Enum? ach | cash | eft | standard | wire
transactionNumber string?
Update a Payment
updatePayment
PATCH /billing/{tenantLocator}/payments/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Security Group:payments   Permission:write
PaymentUpdateRequest
required
addTargets CreditItem[]
removeData map<string,object>
removeTargets string[]
setData map<string,object>

optional
accountLocator string?
financialInstrumentLocator string?
currency string?
amount number?
paymentMode Enum? aggregate | normal
transactionMethod Enum? ach | cash | eft | standard | wire
transactionNumber string?
type string?
useDefaultFinancialInstrument boolean?
Update a Payment (overwrite extension data)
updatePaymentOverwriteData
PUT /billing/{tenantLocator}/payments/{locator}
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Security Group:payments   Permission:write
Validate a Payment
validatePayment
PATCH /billing/{tenantLocator}/payments/{locator}/validate
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Security Group:payments   Permission:write
Post a Payment
postPayment
PATCH /billing/{tenantLocator}/payments/{locator}/post
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Security Group:payments   Permission:write
Reverse a Posted Payment
reversePayment
PATCH /billing/{tenantLocator}/payments/{locator}/reverse
Reset a Validated Payment Back to Draft State
resetPayment
PATCH /billing/{tenantLocator}/payments/{locator}/reset
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Security Group:payments   Permission:write
Discard a Payment
discardPayment
PATCH /billing/{tenantLocator}/payments/{locator}/discard
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    Security Group:payments   Permission:write
Fetch Payments for an Invoice
fetchPaymentsForAnInvoice
GET /billing/{tenantLocator}/invoices/{locator}/payments/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    includeReversedqueryboolean?optional
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Response:PaymentListResponse
    Security Group:invoices   Permissions:read,list
Fetch Invoices Targeted By a Payment
fetchInvoicesTargetedByAPayment
GET /billing/{tenantLocator}/payments/{locator}/invoices/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    offsetqueryint?optional
    countqueryint?optional
    extendedqueryboolean?optional
    Security Group:payments   Permissions:read,list
Fetch shortfall credits
listShortfallCredits
GET /billing/{tenantLocator}/payments/{locator}/shortfallCredits/list
    Request Parameters:
    NamePositionTypeRequired
    tenantLocatorpathuuidrequired
    locatorpathstringrequired
    offsetqueryint?optional
    countqueryint?optional
    Security Group:payments   Permissions:read,list
ListPageResponseShortfallCreditResponse
required
listCompleted boolean
ShortfallCreditResponse
required
locator string
accountLocator string
parentCreditLocator string
currency string
shortfallCreditState Enum draft | distributed | reversed
amount number
creditType Enum creditDistribution | disbursement | payment | refund | shortfallWriteOff | subpayment | writeOff
createdAt datetime
createdBy uuid
targets CreditItem[]

optional
reversalReason string?

See Also