Get transaction amounts allocated to an invoice

Get the precise amounts from a transaction allocated as invoice payments.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

The resource identifier string.

query Parameters
limit
integer [ 0 .. 1000 ]

The collection items limit.

offset
integer >= 0

The collection items offset.

Responses
200

List of allocations was retrieved successfully.

Response Headers
Pagination-Total
integer

Total items count.

Example: 332
Pagination-Limit
integer

Items per page limit.

Example: 100
Pagination-Offset
integer

Pagination offset.

Example: 2
Response Schema: application/json
Array
invoiceId
string (ResourceId) <= 50 characters

The resource ID. Defaults to UUID v4.

transactionId
string (ResourceId) <= 50 characters

The resource ID. Defaults to UUID v4.

amount
number
currency
string = 3 characters

ISO 4217 alphabetic currency code.

Array of InvoiceLink (object) or TransactionLink (object) = 2 items

The links related to resource.

Array (= 2 items)
Any of:
rel
required
string

The link type.

Value: "invoice"
href
required
string

The link URL.

401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

404

Resource was not found.

get/invoices/{id}/transaction-allocations
Request samples
Response samples
application/json
[
  • {
    }
]