AM/TA/Inv - Get Associated Entities History

Details

/external/v1/payment/associated-entities/history

Synopsis

Get Associated Entities Payment History

get

This route is used to retrieve the history data entries of all the entities that are associated with payments on the ledger, given a set of search filters. The history entries will reflect the state of the assets-payments events on that particular block. This endpoint returns paginated data. Up to 250 can be extracted per call. This endpoint can be called by applications with access to scope "readPayment".

Required scopes

This endpoint requires the following scopes:

• : readPayment

Authorizations

oauth2

OAuth2clientCredentialsRequired

Token URL:

Query parameters

pageSizenumberOptional

The number of rows being retrieved. Must be a positive integer.

offsetnumberOptional

The offset (i.e. row start index). Must be a positive integer (or 0).

blockNumbernumber · max: 2147483647Optional

The block number where the action was recorded on the ledger.

Example: 350

transactionIdstring · max: 500Optional

The transaction id where the action was recorded on the ledger.

Example: 456789OIJHGFCVGHJKLKJHGF67JHPattern: ^[a-zA-Z0-9-]*$

channelNamestring · max: 20Optional

The name of the channel where the action was recorded on the ledger.

Example: OG123Pattern: ^[a-zA-Z0-9-]*$

paymentIdsFilterstringOptional

The comma delimited list of payment ids to filter the payment history records. Up to 50 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

paymentCorrelationIdsFilterstringOptional

The comma delimited list of payment correlation ids to filter the payment history records. Up to 50 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

paymentCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "paymentCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

assetIdsFilterstringOptional

The comma delimited list of asset ids to filter the associated asset-payment history records. Up to 500 records can be provided. Each record should not exceed 12 characters.

Example: USCCWSF01I00,USCCWSF01I01

assetCorrelationIdsFilterstringOptional

The comma delimited list of asset correlation ids to filter the associated asset-payment history records. Up to 50 records can be provided. Each record should not exceed 100 characters.

Example: 1234,5678,7890

assetCorrelationOrgIdstring · max: 12Optional

The organization identifier linked to the correlation ids provided in the "assetCorrelationIdsFilter" property. If not provided the organization id will be inferred from the access token.

Responses

200

Successfully retrieved the Associated Payment Entities history

application/json

timestampstring · date-timeRequired

The timestamp of the action

Example: 2024-09-12T00:00:00.000Z

blockNumbernumberRequired

The block number where the associated entity payment history was recorded.

Example: 350

transactionIdstringRequired

The transaction id where the associated entity payment history was recorded.

Example: 456789OIJHGFCVGHJKLKJHGF67JH

channelNamestringRequired

The name of the channel where the associated entity payment history was recorded on the ledger.

Example: OG123

eventall ofRequired

The type of the associated entity payment action.

Example: Associated

string · enumOptional

The type of the associated entity payment action.

Possible values:

400

The following error codes can be returned: - GN0002 - TX0006 - GN0004 - GN0005 Please refer to the error code dictionary for the details of each error code.

application/json

401

The following error codes can be returned: - AU0001 Please refer to the error code dictionary for the details of each error code.

application/json

403

The following error codes can be returned: - AU0002 Please refer to the error code dictionary for the details of each error code.

application/json

get

/external/v1/payment/associated-entities/history

HTTPcURLJavaScriptPython

GET /external/v1/payment/associated-entities/history HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

[
  {
    "timestamp": "2024-09-12T00:00:00.000Z",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "OG123",
    "event": "Associated",
    "organization": {
      "name": "Test Organization",
      "orgId": "TEST1234"
    },
    "update": {
      "paymentId": "US9QIMAOAS1Q",
      "entityType": "asset",
      "entityId": "US9QIMAOAS2Q",
      "amount": 1000
    },
    "signerData": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  }
]