Payment Information

Payment Data

ClearBank® allows you to retrieve payment information against your institution, real and virtual accounts. This includes information about payments which have been settled, those that are currently being processed as well as those which have been rejected.

Get all payments for your 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: ClearBank.FI.API.Versions.V2.Controllers.BaseController.DefaultPageNumber

  • pageSize integer, query

    The page size to control returned results into manageable sets. Default if not supplied: ClearBank.FI.API.Versions.V2.Controllers.BaseController.DefaultPageSize

  • 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": "ALL"
},
"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": "2020-08-11T11:37:30Z",
"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 for an 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 /v1/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": "ALL"
},
"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": "2020-08-11T11:37:31Z",
"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 for an 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 /v1/Accounts

  • transactionId string, path, Required

    The unique identifier for the transaction. This can be retrieved from GET /v1/Transactions

  • 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

{
"transaction": {
"amount": {
"instructedAmount": 0,
"currency": "ALL"
},
"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": "2020-08-11T11:37:31Z",
"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 for a virtual account

get/v2/Accounts/{accountId}/Virtual/{virtualAccountId}/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 /v1/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": "ALL"
},
"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": "2020-08-11T11:37:31Z",
"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 for a 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 /v1/Accounts

  • virtualAccountId string, path, Required

    The unique identifier for the virtual account. This can be retrieved from GET /v1/Accounts/{accountId}/Virtual

  • transactionId string, path, Required

    The unique identifier for the transaction. This can be retrieved from GET /v1/Transactions

  • 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

{
"transaction": {
"amount": {
"instructedAmount": 0,
"currency": "ALL"
},
"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": "2020-08-11T11:37:31Z",
"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 unapplied Direct Credit payments

get/v1/Transactions/{sortCode}/DirectCredit/Unapplied

Returns a list of all unapplied direct credit transactions for a given sort code

Parameters

  • sortCode string, path, Required

    Sort code which will be used to filter unapplied direct credit transactions

  • reasonCode string, query

    The reason code

  • sun string, query

    Service user number (SUN)

  • paymentReference string, query

    The payment reference

  • processingDateFrom string, query

    The starting processing date to filter by

  • processingDateTo string, query

    The last processing date to filter by

  • amount number, query

    The transaction amount

  • transactionCodes array, query

    The transaction codes

  • 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

  • Authorization string, header, Required

    Your API Token, retrieved from the web portal

Response (application/json)

  • 200 Success
  • 400 Bad Request
  • 404 Not Found

Success

{
"unappliedTransactions": [
{
"pendingTransactionId": "string",
"transactionType": "DirectCredit",
"transactionStatus": "Pending",
"creditorAccount": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"schemeName": {
"code": "BBAN",
"proprietary": "string"
},
"issuer": "string"
}
}
},
"debtorAccount": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"schemeName": {
"code": "BBAN",
"proprietary": "string"
},
"issuer": "string"
}
}
},
"amount": 0,
"paymentReference": "string",
"processingDate": "2020-08-11T11:37:31Z",
"settlementDate": "2020-08-11T11:37:31Z",
"transferredDate": "2020-08-11T11:37:31Z",
"serviceUserNumber": "string",
"transactionCode": "string",
"isReturn": true,
"hasReturn": true,
"reasonCode": "string",
"collectionReference": "string",
"creditorAccountName": "string",
"debtorAccountName": "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

Direct Debit Payment Data

ClearBank® allows you to retrieve Direct Debit payment information against your sort code, real and virtual accounts. This includes information about unpaid and collected payments.

Get all collected Direct Debit payments for an account

get/v2/Accounts/{accountId}/Mandates/{mandateId}/Collections

Gets a collection of transactions for account mandate

This is a paged endpoint, if no parameters are supplied the first page is returned, you can add date filter by supplying in the URL.

Parameters

  • accountId string, path, Required

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

  • mandateId string, path, Required

    The unique identifier for Direct Debit Instruction.

  • startDate string, query

    Optional filter by start date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09

  • endDate string, query

    Optional filter by end date. Date must be formatted as YYYY-mm-DD. For example ?endDate=1990-10-04

  • 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

  • Authorization string, header, Required

    Your API Token, retrieved from the web portal

Response (application/json)

  • 202 Success
  • 400 Bad Request
  • 404 Not Found

Success

{
"mandateTransactions": [
{
"transactionId": "string",
"date": "2020-08-11T11:37:31Z",
"amount": {
"instructedAmount": 0,
"currency": "ALL"
},
"status": "string",
"reference": "string",
"debtorBban": "string",
"debtorAccountName": "string",
"debtorSortCode": "string",
"debtorAccountNumber": "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 collected Direct Debit payments for a virtual account

get/v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/{mandateId}/Collections

Gets a collection of transactions for account mandate

This is a paged endpoint, if no parameters are supplied the first page is returned, you can add date filter by supplying in the URL.

Parameters

  • accountId string, path, Required

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

  • virtualAccountId string, path, Required

    The unique identifier for the virtual account. This can be retrieved from GET /v1/Accounts/{accountId}/Virtual

  • mandateId string, path, Required

    The unique identifier for Direct Debit Instruction.

  • startDate string, query

    Optional filter by start date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09

  • endDate string, query

    Optional filter by end date. Date must be formatted as YYYY-mm-DD. For example ?endDate=1990-10-04

  • 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

  • Authorization string, header, Required

    Your API Token, retrieved from the web portal

Response (application/json)

  • 202 Success
  • 400 Bad Request
  • 404 Not Found

Success

{
"mandateTransactions": [
{
"transactionId": "string",
"date": "2020-08-11T11:37:31Z",
"amount": {
"instructedAmount": 0,
"currency": "ALL"
},
"status": "string",
"reference": "string",
"debtorBban": "string",
"debtorAccountName": "string",
"debtorSortCode": "string",
"debtorAccountNumber": "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 unpaid Direct Debit payments

get/v1/Transactions/{sortCode}/DirectDebit/Unpaid

Returns a list of all unpaid Direct Debit Transactions for a given sort code

Parameters

  • sortCode string, path, Required

    Sort code which will be used to filter unpaid Direct Debit transactions

  • reasonCode string, query

    The reason code

  • sun string, query

    Service user number (SUN)

  • paymentReference string, query

    The payment reference

  • processingDateFrom string, query

    The starting processing date to filter by

  • processingDateTo string, query

    The last processing date to filter by

  • amount number, query

    The transaction amount

  • transactionCodes array, query

    The transaction codes

  • 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

  • Authorization string, header, Required

    Your API Token, retrieved from the web portal

Response (application/json)

  • 200 Success
  • 400 Bad Request
  • 404 Not Found

Success

{
"unpaidTransactions": [
{
"pendingTransactionId": "string",
"transactionType": "DirectCredit",
"transactionStatus": "Pending",
"creditorAccount": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"schemeName": {
"code": "BBAN",
"proprietary": "string"
},
"issuer": "string"
}
}
},
"debtorAccount": {
"identification": {
"iban": "string",
"other": {
"identification": "string",
"schemeName": {
"code": "BBAN",
"proprietary": "string"
},
"issuer": "string"
}
}
},
"amount": 0,
"paymentReference": "string",
"processingDate": "2020-08-11T11:37:31Z",
"settlementDate": "2020-08-11T11:37:31Z",
"transferredDate": "2020-08-11T11:37:31Z",
"serviceUserNumber": "string",
"transactionCode": "string",
"isReturn": true,
"hasReturn": true,
"reasonCode": "string",
"collectionReference": "string",
"creditorAccountName": "string",
"debtorAccountName": "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 unpaid Direct Debit payments for an account

get/v2/Accounts/{accountId}/Mandates/Unpaid

Returns a list of all unpaid transactions belonging to an account

Parameters

  • accountId string, path, Required

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

  • startDate string, query

    Transactions query start date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09

  • endDate string, query

    Transactions query end date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09

  • sun string, query

    Service user number (SUN)

  • reference string, query

    Transaction reference

  • 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

  • Authorization string, header, Required

    Your API Token, retrieved from the web portal

Response (application/json)

  • 200 Success
  • 400 Bad Request
  • 404 Not Found

Success

{
"unpaidTransactions": [
{
"pendingTransactionId": "string",
"transactionType": "DirectCredit",
"transactionStatus": "Pending",
"creditorAccount": {
"identification": {
"iban": "string",
"accountName": "string",
"sortCode": "string",
"accountNumber": "string",
"reference": "string",
"other": {
"identification": "string",
"schemeName": {
"code": "BBAN",
"proprietary": "string"
},
"issuer": "string"
}
}
},
"debtorAccount": {
"identification": {
"iban": "string",
"accountName": "string",
"sortCode": "string",
"accountNumber": "string",
"reference": "string",
"other": {
"identification": "string",
"schemeName": {
"code": "BBAN",
"proprietary": "string"
},
"issuer": "string"
}
}
},
"amount": 0,
"paymentReference": "string",
"processingDate": "2020-08-11T11:37:31Z",
"settlementDate": "2020-08-11T11:37:31Z",
"transferredDate": "2020-08-11T11:37:31Z",
"serviceUserNumber": "string",
"transactionCode": "string",
"isReturn": true,
"hasReturn": true,
"reasonCode": "string",
"collectionReference": "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 unpaid Direct Debit payments for a virtual account

get/v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/Unpaid

Returns a list of all unpaid transactions belonging to a virtual account

Parameters

  • accountId string, path, Required

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

  • virtualAccountId string, path, Required

    The unique identifier for the virtual account. This can be retrieved from GET /v1/Accounts/{accountId}/Virtual

  • startDate string, query

    Transactions query start date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09

  • endDate string, query

    Transactions query end date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09

  • sun string, query

    Service user number (SUN)

  • reference string, query

    Transaction reference

  • 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

  • Authorization string, header, Required

    Your API Token, retrieved from the web portal

Response (application/json)

  • 200 Success
  • 400 Bad Request
  • 404 Not Found

Success

{
"unpaidTransactions": [
{
"pendingTransactionId": "string",
"transactionType": "DirectCredit",
"transactionStatus": "Pending",
"creditorAccount": {
"identification": {
"iban": "string",
"accountName": "string",
"sortCode": "string",
"accountNumber": "string",
"reference": "string",
"other": {
"identification": "string",
"schemeName": {
"code": "BBAN",
"proprietary": "string"
},
"issuer": "string"
}
}
},
"debtorAccount": {
"identification": {
"iban": "string",
"accountName": "string",
"sortCode": "string",
"accountNumber": "string",
"reference": "string",
"other": {
"identification": "string",
"schemeName": {
"code": "BBAN",
"proprietary": "string"
},
"issuer": "string"
}
}
},
"amount": 0,
"paymentReference": "string",
"processingDate": "2020-08-11T11:37:31Z",
"settlementDate": "2020-08-11T11:37:31Z",
"transferredDate": "2020-08-11T11:37:31Z",
"serviceUserNumber": "string",
"transactionCode": "string",
"isReturn": true,
"hasReturn": true,
"reasonCode": "string",
"collectionReference": "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