ClearBank

Multicurrency Transactions

Overview

Multicurrency transaction endpoints allow you to retrieve a list of transactions for a multicurrency account and any virtual accounts associated with it, a multicurrency virtual account as well as a single transaction.

Retrieve a list of transactions for an account and virtual accounts associated with the 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

  • accountId string, path, Required

    The unique identifier for the account. This can be retrieved from GET/mccy/v1/Accounts.

  • 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 Success
  • 400 Bad Request
  • 404 Not Found
  • 500 Server Error
  • 503 Server Error

Success

{
  "transactions": [
    {
      "transactionId": "string",
      "accountId": "string",
      "virtualAccountId": "string",
      "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": "2022-06-01T16:35:41Z",
      "identifiers": [
        {
          "scope": "string",
          "name": "string",
          "identifier": "string"
        }
      ],
      "additionalProperties": [
        {
          "key": "string",
          "value": "string"
        }
      ],
      "settledAt": "2022-06-01T16:35:41Z",
      "valueAt": "2022-06-01T16:35:41Z",
      "cancelledAt": "2022-06-01T16:35:41Z",
      "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

Retrieve a list of transactions 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

  • 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 Success
  • 400 Bad Request
  • 404 Not Found
  • 500 Server Error
  • 503 Server Error

Success

{
  "transactionId": "string",
  "accountId": "string",
  "virtualAccountId": "string",
  "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": "2022-06-01T16:35:41Z",
  "identifiers": [
    {
      "scope": "string",
      "name": "string",
      "identifier": "string"
    }
  ],
  "additionalProperties": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "settledAt": "2022-06-01T16:35:41Z",
  "valueAt": "2022-06-01T16:35:41Z",
  "cancelledAt": "2022-06-01T16:35:41Z",
  "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

Retrieve 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.

Response (application/json)

  • 200 Success
  • 400 Bad Request
  • 404 Not Found
  • 500 Server Error
  • 503 Server Error

Success

{
  "transactionId": "string",
  "accountId": "string",
  "virtualAccountId": "string",
  "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": "2022-06-01T16:35:41Z",
  "identifiers": [
    {
      "scope": "string",
      "name": "string",
      "identifier": "string"
    }
  ],
  "additionalProperties": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "settledAt": "2022-06-01T16:35:41Z",
  "valueAt": "2022-06-01T16:35:41Z",
  "cancelledAt": "2022-06-01T16:35:41Z",
  "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