Transaction data

ClearBank allows you to retrieve transactions against:

your institution,
real accounts,
and virtual accounts.

This includes information about payments which have been settled, those that are currently being processed, and those which have been rejected.

To be notified of transactions as soon as they are processed, you should subscribe to the relevant webhooks for each payment rail.

Get all transactions (institution)

get/v2/Transactions

Gets a summary of all of the transactions from the institution.

Parameters

pageNumber integer, query
The page number to control returned results into manageable sets. Default if not provided: 1.
pageSize integer, query
The page size to control returned results into manageable sets. Default if not provided: 50.
startDateTime string, query
Providing the startDateTime filters the result set to include transactions where the transaction time is either equal to or greater than the value specified.
endDateTime string, query
Providing the endDateTime filters the result set to include transactions where the transaction time is either equal to or less than the value specified.
paymentMethodType string, query
The payment method type filters the results to include that payment method type.
endToEndIdentifier string, query
The end-to-end identifier used in the transaction payload. When specified, only transactions with this ID are included.
Authorization string, header, Required
Your API Token, obtained from the ClearBank Portal.

Response (application/json)

200 OK
400 Bad Request
403 Forbidden
409 Conflict

OK

{
  "transactions": [
    {
      "amount": {
        "instructedAmount": 5432.15,
        "currency": "GBP"
      },
      "counterpartAccount": {
        "identification": {
          "iban": "GB12CLBK01020312345678",
          "accountName": "Current Account",
          "accountHolderName": "Jenny Marr",
          "sortCode": "010203",
          "accountNumber": "12345678",
          "reference": "string",
          "other": {
            "identification": "GBR01020312345678",
            "schemeName": {
              "code": "BBAN",
              "proprietary": "PRTY_COUNTRY_SPECIFIC"
            },
            "issuer": "string"
          }
        }
      },
      "debitCreditCode": "DBIT",
      "endToEndIdentifier": "string",
      "transactionId": "string",
      "transactionReference": "string",
      "transactionTime": "2019-08-24T14:15:22Z",
      "status": "ACCP",
      "ultimateBeneficiaryAccount": {
        "id": "string",
        "iban": "GB12CLBK01020312345678",
        "bban": "CLBK01020312345678",
        "upic": "string",
        "cuid": "string"
      },
      "ultimateRemitterAccount": {
        "id": "string",
        "iban": "GB12CLBK01020312345678",
        "bban": "CLBK01020312345678",
        "upic": "string",
        "cuid": "string"
      }
    }
  ],
  "halLinks": [
    {
      "name": "string",
      "href": "string",
      "templated": true
    }
  ]
}

Code copied

Bad Request

{
  "type": "../dictionary",
  "title": "string",
  "status": 100,
  "detail": "string",
  "instance": "../dictionary",
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Code copied

Get all transactions (real account)

get/v2/Accounts/{accountId}/Transactions

Gets a summary of all of the transactions from the specified account.

Parameters

accountId string, path, Required
The unique identifier for the account. This can be retrieved from GET /v3/Accounts.
pageNumber integer, query
The page number to control returned results into manageable sets. Default if not provided: 1.
pageSize integer, query
The page size to control returned results into manageable sets. Default if not provided: 50.
startDateTime string, query
Providing a startDateTime filters the result set to include transactions where the transaction time is either equal to or greater than the value specified.
endDateTime string, query
Providing an endDateTime filters the result set to include transactions where the transaction time is either equal to or less than the value specified.
paymentMethodType string, query
The payment method type filters the results to include that payment method type.
endToEndIdentifier string, query
The end-to-end identifier used in the transaction payload. When specified, only transactions with this ID are included.
Authorization string, header, Required
Your API Token, obtained from the ClearBank Portal.

Response (application/json)

200 OK
400 Bad Request
403 Forbidden
409 Conflict

OK

{
  "transactions": [
    {
      "amount": {
        "instructedAmount": 5432.15,
        "currency": "GBP"
      },
      "counterpartAccount": {
        "identification": {
          "iban": "GB12CLBK01020312345678",
          "accountName": "Current Account",
          "accountHolderName": "Jenny Marr",
          "sortCode": "010203",
          "accountNumber": "12345678",
          "reference": "string",
          "other": {
            "identification": "GBR01020312345678",
            "schemeName": {
              "code": "BBAN",
              "proprietary": "PRTY_COUNTRY_SPECIFIC"
            },
            "issuer": "string"
          }
        }
      },
      "debitCreditCode": "DBIT",
      "endToEndIdentifier": "string",
      "transactionId": "string",
      "transactionReference": "string",
      "transactionTime": "2019-08-24T14:15:22Z",
      "status": "ACCP",
      "ultimateBeneficiaryAccount": {
        "id": "string",
        "iban": "GB12CLBK01020312345678",
        "bban": "CLBK01020312345678",
        "upic": "string",
        "cuid": "string"
      },
      "ultimateRemitterAccount": {
        "id": "string",
        "iban": "GB12CLBK01020312345678",
        "bban": "CLBK01020312345678",
        "upic": "string",
        "cuid": "string"
      }
    }
  ],
  "halLinks": [
    {
      "name": "string",
      "href": "string",
      "templated": true
    }
  ]
}

Code copied

Bad Request

{
  "type": "../dictionary",
  "title": "string",
  "status": 100,
  "detail": "string",
  "instance": "../dictionary",
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Code copied

Get a transaction (real account)

get/v2/Accounts/{accountId}/Transactions/{transactionId}

Gets the details of a specific transaction from the specified account.

Parameters

accountId string, path, Required
The unique identifier for the account. This can be retrieved from GET /v3/Accounts.
transactionId string, path, Required
The unique identifier for the transaction. This can be retrieved from GET /v2/Transactions.
Authorization string, header, Required
Your API Token, obtained from the ClearBank Portal.

Response (application/json)

200 OK
400 Bad Request
403 Forbidden
404 Not Found
409 Conflict

OK

{
  "transaction": {
    "amount": {
      "instructedAmount": 5432.15,
      "currency": "GBP"
    },
    "counterpartAccount": {
      "identification": {
        "iban": "GB12CLBK01020312345678",
        "accountName": "Current Account",
        "accountHolderName": "Jenny Marr",
        "sortCode": "010203",
        "accountNumber": "12345678",
        "reference": "string",
        "other": {
          "identification": "GBR01020312345678",
          "schemeName": {
            "code": "BBAN",
            "proprietary": "PRTY_COUNTRY_SPECIFIC"
          },
          "issuer": "string"
        }
      }
    },
    "debitCreditCode": "DBIT",
    "endToEndIdentifier": "string",
    "transactionId": "string",
    "transactionReference": "string",
    "transactionTime": "2019-08-24T14:15:22Z",
    "status": "ACCP",
    "ultimateBeneficiaryAccount": {
      "id": "string",
      "iban": "GB12CLBK01020312345678",
      "bban": "CLBK01020312345678",
      "upic": "string",
      "cuid": "string"
    },
    "ultimateRemitterAccount": {
      "id": "string",
      "iban": "GB12CLBK01020312345678",
      "bban": "CLBK01020312345678",
      "upic": "string",
      "cuid": "string"
    }
  },
  "halLinks": [
    {
      "name": "string",
      "href": "string",
      "templated": true
    }
  ]
}

Code copied

Bad Request

{
  "type": "../dictionary",
  "title": "string",
  "status": 100,
  "detail": "string",
  "instance": "../dictionary",
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Code copied

Not Found

{
  "type": "../dictionary",
  "title": "string",
  "status": 100,
  "detail": "string",
  "instance": "../dictionary",
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Code copied

Get all transactions (virtual account)

get/v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Transactions

Gets a summary of all of the transactions from the specified virtual account.

Parameters

accountId string, path, Required
The unique identifier for the real account. This can be retrieved from GET /v3/Accounts.
virtualAccountId string, path, Required
The unique identifier for the virtual account. This can be retrieved from GET /v2/Accounts/{accountId}/Virtual.
pageNumber integer, query
The page number to control returned results into manageable sets. Default if not provided: 1.
pageSize integer, query
The page size to control returned results into manageable sets. Default if not provided: 50.
startDateTime string, query
When provided, the startDateTime filters the result set to include transactions where the transaction time is either equal to or greater than the value specified.
endDateTime string, query
When provided, the endDateTime filters the result set to include transactions where the transaction time is either equal to or less than the value specified.
paymentMethodType string, query
The payment method type filters the results to include that payment method type.
endToEndIdentifier string, query
The end-to-end identifier used in the transaction payload. When specified, only transactions with this ID are included.
Authorization string, header, Required
Your API Token, obtained from the ClearBank Portal.

Response (application/json)

200 OK
400 Bad Request
403 Forbidden
409 Conflict

OK

{
  "transactions": [
    {
      "amount": {
        "instructedAmount": 5432.15,
        "currency": "GBP"
      },
      "counterpartAccount": {
        "identification": {
          "iban": "GB12CLBK01020312345678",
          "accountName": "Current Account",
          "accountHolderName": "Jenny Marr",
          "sortCode": "010203",
          "accountNumber": "12345678",
          "reference": "string",
          "other": {
            "identification": "GBR01020312345678",
            "schemeName": {
              "code": "BBAN",
              "proprietary": "PRTY_COUNTRY_SPECIFIC"
            },
            "issuer": "string"
          }
        }
      },
      "debitCreditCode": "DBIT",
      "endToEndIdentifier": "string",
      "transactionId": "string",
      "transactionReference": "string",
      "transactionTime": "2019-08-24T14:15:22Z",
      "status": "ACCP",
      "ultimateBeneficiaryAccount": {
        "id": "string",
        "iban": "GB12CLBK01020312345678",
        "bban": "CLBK01020312345678",
        "upic": "string",
        "cuid": "string"
      },
      "ultimateRemitterAccount": {
        "id": "string",
        "iban": "GB12CLBK01020312345678",
        "bban": "CLBK01020312345678",
        "upic": "string",
        "cuid": "string"
      }
    }
  ],
  "halLinks": [
    {
      "name": "string",
      "href": "string",
      "templated": true
    }
  ]
}

Code copied

Bad Request

{
  "type": "../dictionary",
  "title": "string",
  "status": 100,
  "detail": "string",
  "instance": "../dictionary",
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Code copied

Get a transaction (virtual account)

get/v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Transactions/{transactionId}

Gets the details of a specific transaction from the specified virtual account.

Parameters

accountId string, path, Required
The unique identifier for the account. This can be retrieved from GET /v3/Accounts.
virtualAccountId string, path, Required
The unique identifier for the virtual account. This can be retrieved from GET /v2/Accounts/{accountId}/Virtual.
transactionId string, path, Required
The unique identifier for the transaction. This can be retrieved from GET /v2/Transactions.
Authorization string, header, Required
Your API Token, obtained from the ClearBank Portal.

Response (application/json)

200 OK
400 Bad Request
403 Forbidden
404 Not Found
409 Conflict

OK

{
  "transaction": {
    "amount": {
      "instructedAmount": 5432.15,
      "currency": "GBP"
    },
    "counterpartAccount": {
      "identification": {
        "iban": "GB12CLBK01020312345678",
        "accountName": "Current Account",
        "accountHolderName": "Jenny Marr",
        "sortCode": "010203",
        "accountNumber": "12345678",
        "reference": "string",
        "other": {
          "identification": "GBR01020312345678",
          "schemeName": {
            "code": "BBAN",
            "proprietary": "PRTY_COUNTRY_SPECIFIC"
          },
          "issuer": "string"
        }
      }
    },
    "debitCreditCode": "DBIT",
    "endToEndIdentifier": "string",
    "transactionId": "string",
    "transactionReference": "string",
    "transactionTime": "2019-08-24T14:15:22Z",
    "status": "ACCP",
    "ultimateBeneficiaryAccount": {
      "id": "string",
      "iban": "GB12CLBK01020312345678",
      "bban": "CLBK01020312345678",
      "upic": "string",
      "cuid": "string"
    },
    "ultimateRemitterAccount": {
      "id": "string",
      "iban": "GB12CLBK01020312345678",
      "bban": "CLBK01020312345678",
      "upic": "string",
      "cuid": "string"
    }
  },
  "halLinks": [
    {
      "name": "string",
      "href": "string",
      "templated": true
    }
  ]
}

Code copied

Bad Request

{
  "type": "../dictionary",
  "title": "string",
  "status": 100,
  "detail": "string",
  "instance": "../dictionary",
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Code copied

Not Found

{
  "type": "../dictionary",
  "title": "string",
  "status": 100,
  "detail": "string",
  "instance": "../dictionary",
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  }
}

Code copied

API

GBP Accounts

GBP Payments

Multi-currency, FX, & SCT UK

Embedded Banking

Transaction data