AM/TA/Inv - Get Payment Associated Entity Details

Details

/external/v1/payment/associated-entities

Synopsis

Get Payment Associated Entity Details

get

This route is used to get the details regarding the entities (e.g. assets) that are associated with payments, given a set of search filters. 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).

extraDataKeyFilterstring · max: 100Optional

The key to search within the extraData property. Will be used in combination with "extraDataValueFilter". If "extraDataValueFilter" is not provided then this property is discarded.

extraDataValueFilterstring · max: 100Optional

The value to search within the extraData property. Will be used in combination with "extraDataKeyFilter". If "extraDataKeyFilter" is not provided then this property is discarded.

paymentIdsFilterstringOptional

The comma delimited list of payment ids to filter the payment 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 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 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 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 extracted the associated entities details for the payment

application/json

entityIdstringRequired

The unique id of the associated entity for which the payment was made.

Example: USS3JKS01I00

entityTypeall ofRequired

The type of the associated entity for which the payment was made.

Example: asset

string · enumOptional

The type of the entities that were affected by this payment action.

Possible values:

paymentIdstringRequired

The unique id of the payment associated with the entity.

Example: USS3JKS01I00

amountnumberRequired

How much was transferred via payment. Up to 2 decimal cases can be provided

Example: 1000.99

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

HTTPcURLJavaScriptPython

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

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "entityId": "USS3JKS01I00",
    "entityType": "asset",
    "paymentId": "USS3JKS01I00",
    "amount": 1000.99
  }
]