AM/TA/Inv - Get Payment Details

Details

/external/v1/payment

Synopsis

Get Payment Details

get

This route is used to retrieve the details 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).

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.

Responses

200

Successfully retrieved payment details

application/json

paymentIdstringRequired

The ID of the payment

Example: US9QIMAOAS1Q

securityIdstringRequired

The ID of the security for which this payment was created.

Example: USCCWSF01I00

executedDatestring · date-timeRequired

The date on which the payment was executed.

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

amountnumberRequired

The total amount being paid through this transaction.

Example: 1000

statusall ofRequired

The status of the payment.

Example: executed

string · enumOptional

The status of the payment.

Possible values:

methodall ofOptional

The method of payment.

Example: Swift

string · enumOptional

The method of payment. It is optional.

Possible values:

additionalMethodInfostringOptional

The additional information about the method of payment. Might be provided if method was set to "Other".

wireIdstringOptional

The ID that identifies a wire transfer.

descriptionstringOptional

The payment transaction description. It is optional.

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

HTTPcURLJavaScriptPython

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

[
  {
    "extraData": {
      "externalId": "123456789",
      "some": "Custom Property"
    },
    "paymentId": "US9QIMAOAS1Q",
    "securityId": "USCCWSF01I00",
    "executedDate": "2024-09-12T00:00:00.000Z",
    "amount": 1000,
    "status": "executed",
    "method": "Swift",
    "additionalMethodInfo": "text",
    "wireId": "text",
    "description": "text",
    "sourceAccount": {
      "bankAccount": {
        "accountNumber": "111111111",
        "accountName": "savings account",
        "bankABA": "555555555",
        "bankName": "Test Bank",
        "bankSwift": "AAAA-BB-CC-123"
      }
    },
    "targetAccount": {
      "accountId": "USS3JKS01I00"
    },
    "organization": {
      "orgId": "TEST1234",
      "name": "Test Organization"
    },
    "correlationData": [
      {
        "correlationId": "123245573717",
        "origin": "Identifies security on backoffice",
        "organization": {
          "name": "Test Organization",
          "orgId": "TEST1234"
        },
        "extraData": {
          "some": "Custom Property"
        }
      }
    ]
  }
]