/
Retrieve transaction amou...

Retrieve transaction amounts allocations

Request

Retrieves amounts from a transaction that are allocated as invoice payments.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

Query
limitinteger, [ 0 .. 1000 ]

Limit the number of collection items to be returned. Use 0 to return an empty collection and still receive the count of matching items in Pagination-Total.

offsetinteger, [ 0 .. 1000 ]

Specifies the starting point within the collection of items to be returned.

curl -i -X GET \
  'https://www.rebilly.com/_mock/catalog/all/invoices/{id}/transaction-allocations?limit=0&offset=0' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE'

Responses

List of allocations retrieved.

Headers
Pagination-Totalinteger

Total number of items that match the request. The value is independent of limit, including when limit is 0.

Example:332
Pagination-Limitinteger

Maximum number of items per page.

Example:100
Pagination-Offsetinteger

Specifies the starting point within the collection of resource results. For example, a request with limit=20 retrieves and displays the first 20 results on a page. A following request with limit=20 and offset=20, retrieves the next page of 20 results.

Example:2
Bodyapplication/json
Array [
invoiceIdstring, <= 50 characters

Unique resource ID.

Example:"in_0YVF9605RKC62BP14NE2R7V2XT"
transactionIdstring, <= 50 characters(TransactionId)

ID of the transaction.

Example:"txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0"
amountnumber, (double)
currencystring, = 3 characters(CurrencyCode)

Currency code in ISO 4217 format.

Example:"USD"
]
Response
[
  {
    "invoiceId": "in_0YVF9605RKC62BP14NE2R7V2XT",
    "transactionId": "txn_0YVDTQJ8YWDGQACV2N2N5SPWQ0",
    "amount": 0.1,
    "currency": "USD",
    "_links": [ … ]
  }
]