ClearBank

API

GBP Accounts

UK Payments

Multi-currency/FX

Embedded Banking

Payment data

Payment data

ClearBank allows you to retrieve payment information 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.

Get all payments (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 supplied: 1.

  • pageSize integer, query

    The page size to control returned results into manageable sets. Default if not supplied: 50.

  • startDateTime string, query

    The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified.

  • endDateTime string, query

    The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified.

  • paymentMethodType string, query

    The payment method type filters the results to include that payment method type.

  • Authorization string, header, Required

    Your API Token, retrieved from the web portal.

Response (application/json)

  • 200 Success
  • 400 Bad Request
  • 403 Forbidden
  • 409 Conflict
  • 500 Server Error
  • 503 Server Error

Success

{
  "transactions": [
    {
      "amount": {
        "instructedAmount": 0,
        "currency": "GBP"
      },
      "counterpartAccount": {
        "identification": {
          "iban": "string",
          "accountName": "string",
          "sortCode": "string",
          "accountNumber": "string",
          "reference": "string",
          "other": {
            "identification": "string",
            "schemeName": {
              "code": "BBAN",
              "proprietary": "string"
            },
            "issuer": "string"
          }
        }
      },
      "debitCreditCode": "CRDT",
      "endToEndIdentifier": "string",
      "transactionId": "string",
      "transactionReference": "string",
      "transactionTime": "2019-08-24T14:15:22Z",
      "status": "ACCP",
      "ultimateBeneficiaryAccount": {
        "id": "string",
        "iban": "string",
        "bban": "string",
        "upic": "string",
        "cuid": "string"
      },
      "ultimateRemitterAccount": {
        "id": "string",
        "iban": "string",
        "bban": "string",
        "upic": "string",
        "cuid": "string"
      }
    }
  ],
  "halLinks": [
    {
      "name": "string",
      "href": "string",
      "templated": true
    }
  ]
}
Code copied

Bad Request

{
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
Code copied

Get all payments (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 supplied: 1.

  • pageSize integer, query

    The page size to control returned results into manageable sets. Default if not supplied: 50.

  • startDateTime string, query

    The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified.

  • endDateTime string, query

    The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified.

  • paymentMethodType string, query

    The payment method type filters the results to include that payment method type.

  • Authorization string, header, Required

    Your API Token, retrieved from the web portal.

Response (application/json)

  • 200 Success
  • 400 Bad Request
  • 403 Forbidden
  • 409 Conflict
  • 500 Server Error
  • 503 Server Error

Success

{
  "transactions": [
    {
      "amount": {
        "instructedAmount": 0,
        "currency": "GBP"
      },
      "counterpartAccount": {
        "identification": {
          "iban": "string",
          "accountName": "string",
          "sortCode": "string",
          "accountNumber": "string",
          "reference": "string",
          "other": {
            "identification": "string",
            "schemeName": {
              "code": "BBAN",
              "proprietary": "string"
            },
            "issuer": "string"
          }
        }
      },
      "debitCreditCode": "CRDT",
      "endToEndIdentifier": "string",
      "transactionId": "string",
      "transactionReference": "string",
      "transactionTime": "2019-08-24T14:15:22Z",
      "status": "ACCP",
      "ultimateBeneficiaryAccount": {
        "id": "string",
        "iban": "string",
        "bban": "string",
        "upic": "string",
        "cuid": "string"
      },
      "ultimateRemitterAccount": {
        "id": "string",
        "iban": "string",
        "bban": "string",
        "upic": "string",
        "cuid": "string"
      }
    }
  ],
  "halLinks": [
    {
      "name": "string",
      "href": "string",
      "templated": true
    }
  ]
}
Code copied

Bad Request

{
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
Code copied

Get a payment (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, retrieved from the web portal.

Response (application/json)

  • 200 Success
  • 400 Bad Request
  • 403 Forbidden
  • 404 Not Found
  • 409 Conflict
  • 500 Server Error
  • 503 Server Error

Success

{
  "transaction": {
    "amount": {
      "instructedAmount": 0,
      "currency": "GBP"
    },
    "counterpartAccount": {
      "identification": {
        "iban": "string",
        "accountName": "string",
        "sortCode": "string",
        "accountNumber": "string",
        "reference": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "BBAN",
            "proprietary": "string"
          },
          "issuer": "string"
        }
      }
    },
    "debitCreditCode": "CRDT",
    "endToEndIdentifier": "string",
    "transactionId": "string",
    "transactionReference": "string",
    "transactionTime": "2019-08-24T14:15:22Z",
    "status": "ACCP",
    "ultimateBeneficiaryAccount": {
      "id": "string",
      "iban": "string",
      "bban": "string",
      "upic": "string",
      "cuid": "string"
    },
    "ultimateRemitterAccount": {
      "id": "string",
      "iban": "string",
      "bban": "string",
      "upic": "string",
      "cuid": "string"
    }
  },
  "halLinks": [
    {
      "name": "string",
      "href": "string",
      "templated": true
    }
  ]
}
Code copied

Bad Request

{
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
Code copied

Not Found

{
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
Code copied

Get all payments (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 account. This can be retrieved from GET /v3/Accounts.

  • virtualAccountId string, path, Required

    The unique identifier for the virtual account.

  • pageNumber integer, query

    The page number to control returned results into manageable sets. Default if not supplied: 1.

  • pageSize integer, query

    The page size to control returned results into manageable sets. Default if not supplied: 50.

  • startDateTime string, query

    The start date time (when supplied) filters the result set to include transactions where the transaction time is either equal or greater than the value specified.

  • endDateTime string, query

    The end date time (when supplied) filters the result set to include transactions where the transaction time is either equal or less than the value specified.

  • paymentMethodType string, query

    The payment method type filters the results to include that payment method type.

  • Authorization string, header, Required

    Your API Token, retrieved from the web portal.

Response (application/json)

  • 200 Success
  • 400 Bad Request
  • 403 Forbidden
  • 409 Conflict
  • 500 Server Error
  • 503 Server Error

Success

{
  "transactions": [
    {
      "amount": {
        "instructedAmount": 0,
        "currency": "GBP"
      },
      "counterpartAccount": {
        "identification": {
          "iban": "string",
          "accountName": "string",
          "sortCode": "string",
          "accountNumber": "string",
          "reference": "string",
          "other": {
            "identification": "string",
            "schemeName": {
              "code": "BBAN",
              "proprietary": "string"
            },
            "issuer": "string"
          }
        }
      },
      "debitCreditCode": "CRDT",
      "endToEndIdentifier": "string",
      "transactionId": "string",
      "transactionReference": "string",
      "transactionTime": "2019-08-24T14:15:22Z",
      "status": "ACCP",
      "ultimateBeneficiaryAccount": {
        "id": "string",
        "iban": "string",
        "bban": "string",
        "upic": "string",
        "cuid": "string"
      },
      "ultimateRemitterAccount": {
        "id": "string",
        "iban": "string",
        "bban": "string",
        "upic": "string",
        "cuid": "string"
      }
    }
  ],
  "halLinks": [
    {
      "name": "string",
      "href": "string",
      "templated": true
    }
  ]
}
Code copied

Bad Request

{
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
Code copied

Get a payment (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, retrieved from the web portal.

Response (application/json)

  • 200 Success
  • 400 Bad Request
  • 403 Forbidden
  • 404 Not Found
  • 409 Conflict
  • 500 Server Error
  • 503 Server Error

Success

{
  "transaction": {
    "amount": {
      "instructedAmount": 0,
      "currency": "GBP"
    },
    "counterpartAccount": {
      "identification": {
        "iban": "string",
        "accountName": "string",
        "sortCode": "string",
        "accountNumber": "string",
        "reference": "string",
        "other": {
          "identification": "string",
          "schemeName": {
            "code": "BBAN",
            "proprietary": "string"
          },
          "issuer": "string"
        }
      }
    },
    "debitCreditCode": "CRDT",
    "endToEndIdentifier": "string",
    "transactionId": "string",
    "transactionReference": "string",
    "transactionTime": "2019-08-24T14:15:22Z",
    "status": "ACCP",
    "ultimateBeneficiaryAccount": {
      "id": "string",
      "iban": "string",
      "bban": "string",
      "upic": "string",
      "cuid": "string"
    },
    "ultimateRemitterAccount": {
      "id": "string",
      "iban": "string",
      "bban": "string",
      "upic": "string",
      "cuid": "string"
    }
  },
  "halLinks": [
    {
      "name": "string",
      "href": "string",
      "templated": true
    }
  ]
}
Code copied

Bad Request

{
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
Code copied

Not Found

{
  "errors": {
    "property1": [
      "string"
    ],
    "property2": [
      "string"
    ]
  },
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
Code copied