Transactions

Transaction endpoints allow you to retrieve:

A list of transactions for a real account and any virtual accounts associated with it
A list of transactions for a virtual account
A single transaction

Get full transaction list for an account

get/mccy/v1/Accounts/{accountId}/transactions

This endpoint is used to retrieve a list of transactions for a real account and any virtual accounts associated with the real account.

Parameters

Authorization string, header, Required
Your API token, obtained from the ClearBank Portal.
DigitalSignature string, header, Required
Generated from your HTTP METHOD, Query Path, X-Request-Id, and X-Request-Time values.
X-Request-Id string, header, Required
A unique identifier for the request; valid for 24 hours, max length 83.
X-Request-Time string, header, Required
The current UNIX timestamp in seconds. This value will be rejected if it is more than 60 seconds late.
PageNumber integer, query
The page number to control returned results into manageable sets. There is a limit of 1000 per request. A request with over 1000 will result in a bad request. Default if not supplied: 1.
PageSize integer, query
The page size to control returned results into manageable sets. There is a limit of 1000 per request. A request with over 1000 will result in a bad request. Default if not supplied: 50.
StartDateTime string, query
When supplied, filters the result set to include the start date and time of when the returned transactions were created. If not supplied, then it defaults to 24 hours ago. If StartDateTime and EndDateTime time are not supplied, all transactions that have occurred in the last 24 hours will be returned.
EndDateTime string, query
When supplied, filters the result set to include the end date and time of the when the returned transactions were created. If not supplied, then it defaults to the current time. If StartDateTime and EndDateTime time are not supplied, all transactions that have occurred in the last 24 hours will be returned.
Currency string, query, Required
The ISO currency code for the currency of the transactions to be returned. For example, EUR.

Response (application/json)

200 OK
400 Bad Request
404 Not Found

OK

{
  "transactions": [
    {
      "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
      "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
      "virtualAccountId": "0ab10eda-9694-4e02-94d8-77283c7b56c1",
      "endToEndId": "string",
      "reference": "string",
      "ultimateBeneficiary": {
        "accountIdentifiers": [
          {
            "identifier": "string",
            "kind": "string"
          }
        ],
        "payeeName": "string"
      },
      "ultimateRemitter": {
        "accountIdentifiers": [
          {
            "identifier": "string",
            "kind": "string"
          }
        ],
        "payerName": "string"
      },
      "amount": 0,
      "currency": "str",
      "currencyExchange": {
        "rate": 0,
        "margin": 0,
        "currency": "string",
        "amount": 0
      },
      "actualPaymentMethod": "string",
      "requestedPaymentMethod": "string",
      "kind": "string",
      "createdAt": "2019-08-24T14:15:22Z",
      "identifiers": [
        {
          "scope": "string",
          "name": "string",
          "identifier": "string"
        }
      ],
      "additionalProperties": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "settledAt": "2019-08-24T14:15:22Z",
      "valueAt": "2019-08-24T14:15:22Z",
      "cancelledAt": "2019-08-24T14:15:22Z",
      "cancellationCode": "string",
      "reason": "string",
      "status": "string"
    }
  ]
}

Code copied

Bad Request

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Code copied

Not Found

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Code copied

Get transaction list for a virtual account

get/mccy/v1/VirtualAccounts/{virtualAccountId}/transactions

This endpoint is used to retrieve a list of transactions for a virtual account.

Parameters

Authorization string, header, Required
Your API token, obtained from the ClearBank Portal.
DigitalSignature string, header, Required
Generated from your HTTP METHOD, Query Path, X-Request-Id, and X-Request-Time values.
X-Request-Id string, header, Required
A unique identifier for the request; valid for 24 hours, max length 83.
X-Request-Time string, header, Required
The current UNIX timestamp in seconds. This value will be rejected if it is more than 60 seconds late.
virtualAccountId string, path, Required
The unique identifier for the virtual account.
PageNumber integer, query
The page number to control returned results into manageable sets. There is a limit of 1000 per request. A request with over 1000 will result in a bad request. Default if not supplied: 1.
PageSize integer, query
The page size to control returned results into manageable sets. There is a limit of 1000 per request. A request with over 1000 will result in a bad request. Default if not supplied: 50.
StartDateTime string, query
When supplied, filters the result set to include the start date and time of when the returned transactions were created. If not supplied, then it defaults to 24 hours ago. If StartDateTime and EndDateTime time are not supplied, all transactions that have occurred in the last 24 hours will be returned.
EndDateTime string, query
When supplied, filters the result set to include the end date and time of the when the returned transactions were created. If not supplied, then it defaults to the current time. If StartDateTime and EndDateTime time are not supplied, all transactions that have occurred in the last 24 hours will be returned.
Currency string, query, Required
The ISO currency code for the currency of the transactions to be returned. For example, EUR.

Response (application/json)

200 OK
400 Bad Request
404 Not Found

OK

{
  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  "virtualAccountId": "0ab10eda-9694-4e02-94d8-77283c7b56c1",
  "endToEndId": "string",
  "reference": "string",
  "ultimateBeneficiary": {
    "accountIdentifiers": [
      {
        "identifier": "string",
        "kind": "string"
      }
    ],
    "payeeName": "string"
  },
  "ultimateRemitter": {
    "accountIdentifiers": [
      {
        "identifier": "string",
        "kind": "string"
      }
    ],
    "payerName": "string"
  },
  "amount": 0,
  "currency": "str",
  "currencyExchange": {
    "rate": 0,
    "margin": 0,
    "currency": "string",
    "amount": 0
  },
  "actualPaymentMethod": "string",
  "requestedPaymentMethod": "string",
  "kind": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "identifiers": [
    {
      "scope": "string",
      "name": "string",
      "identifier": "string"
    }
  ],
  "additionalProperties": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "settledAt": "2019-08-24T14:15:22Z",
  "valueAt": "2019-08-24T14:15:22Z",
  "cancelledAt": "2019-08-24T14:15:22Z",
  "cancellationCode": "string",
  "reason": "string",
  "status": "string"
}

Code copied

Bad Request

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Code copied

Not Found

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Code copied

Get a transaction

get/mccy/v1/Transactions/{transactionId}

This endpoint is used to retrieve a transaction.

Parameters

transactionId string, path, Required
The unique identifier for the transaction.
Authorization string, header, Required
Your API token, obtained from the ClearBank Portal.
DigitalSignature string, header, Required
Generated from your HTTP METHOD, Query Path, X-Request-Id, and X-Request-Time values.
X-Request-Id string, header, Required
A unique identifier for the request; valid for 24 hours, max length 83.
X-Request-Time string, header, Required
The current UNIX timestamp in seconds. This value will be rejected if it is more than 60 seconds late.

Response (application/json)

200 OK
400 Bad Request
404 Not Found

OK

{
  "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
  "virtualAccountId": "0ab10eda-9694-4e02-94d8-77283c7b56c1",
  "endToEndId": "string",
  "reference": "string",
  "ultimateBeneficiary": {
    "accountIdentifiers": [
      {
        "identifier": "string",
        "kind": "string"
      }
    ],
    "payeeName": "string"
  },
  "ultimateRemitter": {
    "accountIdentifiers": [
      {
        "identifier": "string",
        "kind": "string"
      }
    ],
    "payerName": "string"
  },
  "amount": 0,
  "currency": "str",
  "currencyExchange": {
    "rate": 0,
    "margin": 0,
    "currency": "string",
    "amount": 0
  },
  "actualPaymentMethod": "string",
  "requestedPaymentMethod": "string",
  "kind": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "identifiers": [
    {
      "scope": "string",
      "name": "string",
      "identifier": "string"
    }
  ],
  "additionalProperties": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "settledAt": "2019-08-24T14:15:22Z",
  "valueAt": "2019-08-24T14:15:22Z",
  "cancelledAt": "2019-08-24T14:15:22Z",
  "cancellationCode": "string",
  "reason": "string",
  "status": "string"
}

Code copied

Bad Request

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Code copied

Not Found

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string",
  "property1": null,
  "property2": null
}

Code copied

API

Accounts

EUR payments

Reporting

Transactions

Transactions

Get full transaction list for an account

Parameters

Response (application/json)

OK

Bad Request

Not Found

Get transaction list for a virtual account

Parameters

Response (application/json)

OK

Bad Request

Not Found

Get a transaction

Parameters

Response (application/json)

OK

Bad Request

Not Found