Payments API
Endpoint Index
Action | Endpoint |
---|---|
Fetch a Payment | GET /billing/{tenantLocator}/payments/{locator} |
Fetch Multiple Payments | GET /billing/{tenantLocator}/payments/list |
Fetch Subpayments | GET /billing/{tenantLocator}/payments/{locator}/subpayments/list |
Create a Payment | POST /billing/{tenantLocator}/payments |
Update a Payment | PATCH /billing/{tenantLocator}/payments/{locator} |
Update a Payment (overwrite extension data) | PUT /billing/{tenantLocator}/payments/{locator} |
Validate a Payment | PATCH /billing/{tenantLocator}/payments/{locator}/validate |
Post a Payment | PATCH /billing/{tenantLocator}/payments/{locator}/post |
Reverse a Posted Payment | PATCH /billing/{tenantLocator}/payments/{locator}/reverse |
Reset a Validated Payment Back to Draft State | PATCH /billing/{tenantLocator}/payments/{locator}/reset |
Discard a Payment | PATCH /billing/{tenantLocator}/payments/{locator}/discard |
Fetch shortfall credits | GET /billing/{tenantLocator}/payments/{locator}/shortfallCredits/list |
GET /billing/{tenantLocator}/payments/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:PaymentResponse
Security Group:payments  Permission:read
GET /billing/{tenantLocator}/payments/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
offset | query | int? | optional |
count | query | int? | optional |
accountLocator | query | string? | optional |
targetContainerLocator | query | string? | optional |
extended | query | boolean? | optional |
Response:ListPageResponsePaymentResponse
Security Group:payments  Permissions:read,list
GET /billing/{tenantLocator}/payments/{locator}/subpayments/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
offset | query | int? | optional |
count | query | int? | optional |
Response:ListPageResponsePaymentResponse
Security Group:payments  Permissions:read,list
ListPageResponsePaymentResponse
¶requiredlistCompleted booleanitems PaymentResponse[]
PaymentResponse
¶requiredlocator stringcurrency stringpaymentState Enum draft | validated | posted | reversed | discardedamount numbertype stringcreatedAt datetimecreatedBy uuidshortfallCreditLocators string[]subpayments SubpaymentResponse[]targets CreditItem[]optionalaccountLocator string?aggregatePaymentLocator string?externalCashTransactionLocator string?paymentMode Enum? aggregate | normalpostedAt datetime?remainingAmount number?reversalReason string?reversedAt datetime?reversedBy uuid?validationResult ValidationResult?data map<string,object>?
SubpaymentResponse
¶requiredsubpaymentLocator stringamount number
CreditItem
¶requiredcontainerLocator stringcontainerType Enum account | invoice | subpaymentoptionalamount number?
POST /billing/{tenantLocator}/payments
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
Request:PaymentCreateRequest
Response:PaymentResponse
Security Group:payments  Permission:write
PaymentCreateRequest
¶requiredamount numbertype stringuseDefaultFinancialInstrument booleandata map<string,object>targets CreditItem[]optionalaccountLocator string?financialInstrumentLocator string?currency string?paymentMode Enum? aggregate | normaltransactionMethod Enum? ach | cash | eft | standard | wiretransactionNumber string?
PATCH /billing/{tenantLocator}/payments/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Request:PaymentUpdateRequest
Response:PaymentResponse
Security Group:payments  Permission:write
PaymentUpdateRequest
¶requiredaddTargets CreditItem[]removeData map<string,object>removeTargets string[]setData map<string,object>optionalaccountLocator string?financialInstrumentLocator string?currency string?amount number?paymentMode Enum? aggregate | normaltransactionMethod Enum? ach | cash | eft | standard | wiretransactionNumber string?type string?useDefaultFinancialInstrument boolean?
PUT /billing/{tenantLocator}/payments/{locator}
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Request:PaymentCreateRequest
Response:PaymentResponse
Security Group:payments  Permission:write
PATCH /billing/{tenantLocator}/payments/{locator}/validate
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:PaymentResponse
Security Group:payments  Permission:write
PATCH /billing/{tenantLocator}/payments/{locator}/post
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:PaymentResponse
Security Group:payments  Permission:write
PATCH /billing/{tenantLocator}/payments/{locator}/reverse
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Request:CreditDistributionReverseRequest
Response:PaymentResponse
Security Group:payments  Permission:write
PATCH /billing/{tenantLocator}/payments/{locator}/reset
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:PaymentResponse
Security Group:payments  Permission:write
PATCH /billing/{tenantLocator}/payments/{locator}/discard
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
Response:PaymentResponse
Security Group:payments  Permission:write
GET /billing/{tenantLocator}/invoices/{locator}/payments/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
includeReversed | query | boolean? | optional |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:PaymentListResponse
Security Group:invoices  Permissions:read,list
GET /billing/{tenantLocator}/payments/{locator}/invoices/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
offset | query | int? | optional |
count | query | int? | optional |
extended | query | boolean? | optional |
Response:InvoiceListResponse
Security Group:payments  Permissions:read,list
GET /billing/{tenantLocator}/payments/{locator}/shortfallCredits/list
Request Parameters:
Name | Position | Type | Required |
---|---|---|---|
tenantLocator | path | uuid | required |
locator | path | string | required |
offset | query | int? | optional |
count | query | int? | optional |
Security Group:payments  Permissions:read,list
ListPageResponseShortfallCreditResponse
¶requiredlistCompleted booleanitems ShortfallCreditResponse[]
ShortfallCreditResponse
¶requiredlocator stringaccountLocator stringparentCreditLocator stringcurrency stringshortfallCreditState Enum draft | distributed | reversedamount numbercreditType Enum creditDistribution | disbursement | payment | refund | shortfallWriteOff | subpayment | writeOffcreatedAt datetimecreatedBy uuidtargets CreditItem[]optionalreversalReason string?