AM/TA/Inv - Get Payment History Details

Details

/external/v1/payment/history

Synopsis

Get Payment History Details

get

This route is used to retrieve the history of payments, given a set of search filters. This endpoint is paginated, up to 50 records can be retrieved 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.

Responses

200

Successfully retrieved payment history

application/json

timestampstring · date-timeRequired

The timestamp of the action

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

blockNumbernumberRequired

The block number where the payment history was recorded.

Example: 350

transactionIdstringRequired

The transaction id where the payment history was recorded.

Example: 456789OIJHGFCVGHJKLKJHGF67JH

channelNamestringRequired

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

Example: OG123

eventall ofRequired

The type of the payment action.

Example: Created

string · enumOptional

The type of the payment action.

Possible values:

400

The following error codes can be returned: - GN0002 - 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/history

HTTPcURLJavaScriptPython

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

[
  {
    "timestamp": "2024-09-12T00:00:00.000Z",
    "blockNumber": 350,
    "transactionId": "456789OIJHGFCVGHJKLKJHGF67JH",
    "channelName": "OG123",
    "event": "Created",
    "organization": {
      "name": "Test Organization",
      "orgId": "TEST1234"
    },
    "update": {
      "paymentId": "US9QIMAOAS1Q",
      "securityId": "USCCWSF01I00",
      "status": "settled",
      "organization": {
        "name": "Test Organization",
        "orgId": "TEST1234"
      },
      "method": "Swift",
      "description": "Payment update",
      "amount": 1000,
      "sourceAccount": {
        "bankAccount": {
          "accountNumber": "123456789",
          "bankName": "Test Bank"
        }
      }
    },
    "signerData": {
      "email": "[email protected]",
      "name": "John Doe"
    }
  }
]