-
Notifications
You must be signed in to change notification settings - Fork 2
/
clearbank-api-v1.json
1 lines (1 loc) · 127 KB
/
clearbank-api-v1.json
1
{"swagger":"2.0","info":{"version":"1.0","title":"ClearBank Financial Institutions API","description":"The ClearBank® API is a REST based API that can be connected to in order to leverage ClearBank®’s products and banking services.\r\n\r\nThis ClearBank® Financial Institution API area in Swagger provides Financial Institutions with the required API endpoint information and message schema.\r\n\r\nFor the necessary information in order for Financial Institutions to successfully connect to ClearBank®’s API, refer to the Knowledge Centre.\r\n\r\nAll information is provided to you on a confidential basis and shall remain the property of ClearBank Ltd (including ownership rights in all intellectual property). All information is provided \"as is\" and without any implied warranty, representation, condition or otherwise, regarding its accuracy or completeness.\r\n\r\nCopyright ClearBank Ltd. Authorised by the Prudential Regulation Authority and regulated by the Financial Conduct Authority and the Prudential Regulation Authority (Financial Services Register number: 754568). Registered Address: Level 29, 30 St. Mary Axe, London, England EC3A 8EP.","contact":{"name":"API Support","url":"https://clear.bank","email":"fiapisupport@clear.bank"}},"paths":{"/v1/Accounts":{"get":{"tags":["Accounts"],"summary":"Gets all accounts associated with your institution","description":"All accounts are returned except those which have been disabled or where the account is a virtual account","operationId":"V1AccountsGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Accounts.AccountsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]},"post":{"tags":["Accounts"],"summary":"Creates an account with the specified name","description":"Currently, this endpoint only supports the creation of current accounts\r\n \r\nAccountName must: not be null, only white space, only contain letters, numbers and the following special characters: - ,.","operationId":"V1AccountsPost","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"request","in":"body","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Accounts.CreateAccountRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"201":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Accounts.AccountResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}":{"get":{"tags":["Accounts"],"summary":"Gets a detailed view of an account","operationId":"V1AccountsByAccountIdGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Accounts.AccountResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]},"patch":{"tags":["Accounts"],"summary":"Amends properties of an account","description":"Currently supports changing the status of an account","operationId":"V1AccountsByAccountIdPatch","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"The information required to amend account properties","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Accounts.PatchAccountRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"204":{"description":"Success","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Transactions/{sortCode}/DirectCredit/Unapplied":{"get":{"tags":["Institution"],"summary":"Returns a list of all unapplied direct credit transactions for a given sort code","operationId":"V1TransactionsBySortCodeDirectCreditUnappliedGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"sortCode","in":"path","description":"Sort code which will be used to filter unapplied direct credit transactions","required":true,"type":"string"},{"name":"reasonCode","in":"query","description":"The reason code","required":false,"type":"string"},{"name":"sun","in":"query","description":"Service user number (SUN)","required":false,"type":"string","pattern":"^\\d{6}$"},{"name":"paymentReference","in":"query","description":"The payment reference","required":false,"type":"string"},{"name":"processingDateFrom","in":"query","description":"The starting processing date to filter by","required":false,"type":"string","format":"date-time"},{"name":"processingDateTo","in":"query","description":"The last processing date to filter by","required":false,"type":"string","format":"date-time"},{"name":"amount","in":"query","description":"The transaction amount","required":false,"type":"number","format":"double"},{"name":"transactionCodes","in":"query","description":"The transaction codes","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.GetUnappliedDirectCreditTransactionsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Transactions/{sortCode}/DirectDebit/Unpaid":{"get":{"tags":["Institution"],"summary":"Returns a list of all unpaid Direct Debit Transactions for a given sort code","operationId":"V1TransactionsBySortCodeDirectDebitUnpaidGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"sortCode","in":"path","description":"Sort code which will be used to filter unpaid Direct Debit transactions","required":true,"type":"string"},{"name":"reasonCode","in":"query","description":"The reason code","required":false,"type":"string"},{"name":"sun","in":"query","description":"Service user number (SUN)","required":false,"type":"string","pattern":"^\\d{6}$"},{"name":"paymentReference","in":"query","description":"The payment reference","required":false,"type":"string"},{"name":"processingDateFrom","in":"query","description":"The starting processing date to filter by","required":false,"type":"string","format":"date-time"},{"name":"processingDateTo","in":"query","description":"The last processing date to filter by","required":false,"type":"string","format":"date-time"},{"name":"amount","in":"query","description":"The transaction amount","required":false,"type":"number","format":"double"},{"name":"transactionCodes","in":"query","description":"The transaction codes","required":false,"type":"array","items":{"type":"string"},"collectionFormat":"multi","uniqueItems":false},{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.GetUnpaidDirectDebitTransactionsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Mandates":{"get":{"tags":["Accounts"],"summary":"Gets all of the Direct Debit Instructions associated with the account","operationId":"V1AccountsByAccountIdMandatesGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Mandates.MandatesResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]},"post":{"tags":["Accounts"],"summary":"Requests creation of a Direct Debit Instruction","operationId":"V1AccountsByAccountIdMandatesPost","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Information required to create Direct Debit Instruction","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.MandateCreationRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.EmptyApiResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates":{"get":{"tags":["Virtual Accounts"],"summary":"Gets all of the Direct Debit Instructions associated with the virtual account","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdMandatesGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The unique identifier for the virtual account. This can be retrieved from GET /v1/Accounts/{accountId}/Virtual","required":true,"type":"string","format":"uuid"},{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Mandates.MandatesResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]},"post":{"tags":["Virtual Accounts"],"summary":"Requests creation of a Direct Debit Instruction","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdMandatesPost","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The unique identifier for the virtual account. This can be retrieved from GET /v1/Accounts/{accountId}/Virtual","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Information required to create the direct debit mandate","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.MandateCreationRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.EmptyApiResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Mandates/{mandateId}":{"delete":{"tags":["Accounts"],"summary":"Requests cancellation for a Direct Debit mandate","description":"<strong>Supported reason codes are:</strong>\r\n<br />\r\n 0 - Institution cancelled - refer to payer. Paying bank has cancelled instruction.<br />\r\n 1 - Instruction cancelled by payer. Payer has instructed the paying bank to cancel the DirectDebit Instruction.<br />\r\n 2 - Payer deceased.<br />\r\n B - Account closed. Payer has closed their account for an unknown reason.","operationId":"V1AccountsByAccountIdMandatesByMandateIdDelete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"mandateId","in":"path","description":"The unique Direct Debit Instruction identifier","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Information required for cancelling the mandate","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.MandateCancellationRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.EmptyApiResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]},"patch":{"tags":["Accounts"],"summary":"Requests amendments to Direct Debit Instruction","description":"Supported reason codes are:\r\nC - Account transfered to a different branch of bank/building society\r\nE - Instruction amended","operationId":"V1AccountsByAccountIdMandatesByMandateIdPatch","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"mandateId","in":"path","description":"The unique Direct Debit Instruction identifier","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Information required for amending the mandate","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.MandateAmendmentRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.EmptyApiResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/{mandateId}":{"delete":{"tags":["Virtual Accounts"],"summary":"Requests cancellation for a Direct Debit mandate for virtual account","description":"Supported reason codes are:\r\n0 - Institution cancelled - refer to payer. Paying bank has cancelled instruction.\r\n1 - Instruction cancelled by payer. Payer has instructed the paying bank to cancel the DirectDebit Instruction (Mandate).\r\n2 - Payer deceased\r\nB - Account closed. Payer has closed their account for an unknown reason.","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdMandatesByMandateIdDelete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The unique identifier for the virtual account. This can be retrieved from GET /v1/Accounts/{accountId}/Virtual","required":true,"type":"string","format":"uuid"},{"name":"mandateId","in":"path","description":"The unique Direct Debit Instruction identifier","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Information required for canceling the mandate","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.MandateCancellationRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.EmptyApiResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]},"patch":{"tags":["Virtual Accounts"],"summary":"Requests amendments to Direct Debit mandate for virtual account","description":"Supported reason codes are:\r\nC - Account transfered to a different branch of bank/building society\r\nE - Instruction amended","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdMandatesByMandateIdPatch","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The unique identifier for the virtual account","required":true,"type":"string","format":"uuid"},{"name":"mandateId","in":"path","description":"The unique Direct Debit Instruction identifier","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Information required for amending the mandate","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.MandateAmendmentRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.EmptyApiResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Mandates/{mandateId}/Returns":{"post":{"tags":["Accounts"],"summary":"Requests rejection for the supplied Direct Debit Instruction identifier","operationId":"V1AccountsByAccountIdMandatesByMandateIdReturnsPost","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"mandateId","in":"path","description":"The unique Direct Debit Instruction identifier","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"The request mainly includes ReasonCode required for returning the mandate","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.DirectDebitMandateRejectRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.EmptyApiResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/{mandateId}/Returns":{"post":{"tags":["Virtual Accounts"],"summary":"Requests rejection for the supplied Instruction identifier","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdMandatesByMandateIdReturnsPost","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The unique identifier for the virtual account","required":true,"type":"string","format":"uuid"},{"name":"mandateId","in":"path","description":"The unique Direct Debit Instruction identifier","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"The request mainly includes ReasonCode required for returning the mandate","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.DirectDebitMandateRejectRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.EmptyApiResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Transactions":{"get":{"tags":["Institution"],"summary":"Gets a summary of all of the transactions from the institution","operationId":"V1TransactionsGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: ClearBank.FI.API.Versions.V1.Controllers.BaseController.DefaultPageNumber","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: ClearBank.FI.API.Versions.V1.Controllers.BaseController.DefaultPageSize","required":false,"type":"integer","format":"int32"},{"name":"startDateTime","in":"query","description":"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.","required":false,"type":"string","format":"date-time"},{"name":"endDateTime","in":"query","description":"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.","required":false,"type":"string","format":"date-time"},{"name":"paymentMethodType","in":"query","description":"The payment method type filters the results to include that payment method type.","required":false,"type":"string","enum":["Transfer","FasterPayments","Bacs","Chaps"]},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Institutions.InstitutionTransactionsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Payments/{scheme}":{"post":{"tags":["Payments"],"summary":"Initiate a payment using the specified payment scheme","description":"This endpoint works on a partial acceptance basis - meaning that you can submit 10 payments and only 6 of them may be accepted for processing.\r\n \r\nEach payment instruction is validated against the scheme specific rules as well as the ISO20022 specification.\r\n \r\nCurrently, only payments through GBP are supported. We have listed possible currencies for future proofing of the API.\r\n \r\nThe remittance information must be scheme compatible. Values exceeding the length limits of the scheme will be truncated. Missing remittance information will be replaced by a blank string.\r\n<br /><strong>FPS</strong><br /><u>Account Holder Name</u> - Required, alpha-numeric, space, comma, full-stop, hyphen (Max 18 characters)\r\n<u>Sort code</u> - 6 character length, must be numeric\r\n<u>Account Number</u> - required, 8 character length, must be numeric\r\n<u>Amount</u> - required, must be numeric and greater than 0\r\n<u>Payment Reference</u> - required, alpha numeric, space, comma, full stop, hyphen, maximum length 18 characters (Description to be provided -if customer exceeds 18 characters this will be truncated)\r\n<br /><strong>CHAPS</strong><br /><u>Account Holder Name</u> - Required, alpha-numeric, space, comma, full-stop, hyphen (Max 18 characters)\r\n<u>Sort code</u> - 6 character length, must be numeric\r\n<u>Account Number</u> - required, 8 character length, must be numeric\r\n<u>Amount</u> - required, must be numeric and greater than 0\r\n<u>Payment Reference</u> - required, alpha numeric, space, comma, full stop, hyphen, maximum length 35 characters\r\n<u>CHAPS availability</u> - 8am - 5pm M-F (Business Days)\r\n<br />","operationId":"V1PaymentsBySchemePost","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"scheme","in":"path","description":"The name of the scheme through which monies should be transferred.","required":true,"type":"string","enum":["FPS","CHAPS"]},{"name":"request","in":"body","description":"The details of the payment instructions to be executed.","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Payments.CreateCreditTransferRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202 ":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Payments.CreditTransferResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400 ":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Payments.CreditTransferResponse","type":"ClearBank.FI.API.Versions.V1.Models.Response.Payments.CreditTransferResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}},"examples":[{"transactions":[{"endToEndIdentification":"string","response":"InvalidAccount"}],"halLinks":[{"name":"string","href":"string","templated":true}]}]},"400 ":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails","type":"ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403 ":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409 ":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500 ":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503 ":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Test":{"get":{"tags":["Test"],"summary":"A test endpoint which ensures that authentication is working as expected","operationId":"V1TestGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]},"post":{"tags":["Test"],"summary":"A test endpoint which echoes the supplied content to ensure that signature verification and authorization is working as expected","operationId":"V1TestPost","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"},{"name":"request","in":"body","description":"Any payload","required":false,"schema":{"type":"object"}}],"responses":{"200":{"description":"Success","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Mandates/{mandateId}/Collections":{"get":{"tags":["Accounts"],"summary":"Gets a collection of transactions for account mandate","description":"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.","operationId":"V1AccountsByAccountIdMandatesByMandateIdCollectionsGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"mandateId","in":"path","description":"The unique identifier for Direct Debit Instruction.","required":true,"type":"string","format":"uuid"},{"name":"startDate","in":"query","description":"Optional filter by start date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09","required":false,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"Optional filter by end date. Date must be formatted as YYYY-mm-DD. For example ?endDate=1990-10-04","required":false,"type":"string","format":"date-time"},{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Mandates.MandateTransactionsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/{mandateId}/Collections":{"get":{"tags":["Virtual Accounts"],"summary":"Gets a collection of transactions for account mandate","description":"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.","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdMandatesByMandateIdCollectionsGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The unique identifier for the virtual account. This can be retrieved from GET /v1/Accounts/{accountId}/Virtual","required":true,"type":"string","format":"uuid"},{"name":"mandateId","in":"path","description":"The unique identifier for Direct Debit Instruction.","required":true,"type":"string","format":"uuid"},{"name":"startDate","in":"query","description":"Optional filter by start date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09","required":false,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"Optional filter by end date. Date must be formatted as YYYY-mm-DD. For example ?endDate=1990-10-04","required":false,"type":"string","format":"date-time"},{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Mandates.MandateTransactionsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Mandates/Unpaid":{"get":{"tags":["Accounts"],"summary":"Returns a list of all unpaid transactions belonging to an account","operationId":"V1AccountsByAccountIdMandatesUnpaidGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"startDate","in":"query","description":"Transactions query start date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09","required":false,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"Transactions query end date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09","required":false,"type":"string","format":"date-time"},{"name":"sun","in":"query","description":"Service user number (SUN)","required":false,"type":"string","pattern":"^\\d{6}$"},{"name":"reference","in":"query","description":"Transaction reference","required":false,"type":"string","maxLength":18,"minLength":1},{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.GetAllUnpaidTransactionsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/Unpaid":{"get":{"tags":["Virtual Accounts"],"summary":"Returns a list of all unpaid transactions belonging to a virtual account","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdMandatesUnpaidGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The unique identifier for the virtual account. This can be retrieved from GET /v1/Accounts/{accountId}/Virtual","required":true,"type":"string","format":"uuid"},{"name":"startDate","in":"query","description":"Transactions query start date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09","required":false,"type":"string","format":"date-time"},{"name":"endDate","in":"query","description":"Transactions query end date. Date must be formatted as YYYY-mm-DD. For example ?startDate=1984-02-09","required":false,"type":"string","format":"date-time"},{"name":"sun","in":"query","description":"Service user number (SUN)","required":false,"type":"string","pattern":"^\\d{6}$"},{"name":"reference","in":"query","description":"Transaction reference","required":false,"type":"string","maxLength":18,"minLength":1},{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.GetAllUnpaidTransactionsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Transactions/Returns":{"post":{"tags":["Accounts"],"summary":"Creates a return of one or more Direct Debit or Direct Credit transactions for the account. This is only valid on the Entry Day, or the working day after before 15:30 UTC.","operationId":"V1AccountsByAccountIdTransactionsReturnsPost","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"A collection of transactions to return, each transaction must have transaction id and return reason code specified","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.TransactionReturnsRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.EmptyApiResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Transactions/Returns":{"post":{"tags":["Virtual Accounts"],"summary":"Creates a return of one or more Direct Debit or Direct Credit transactions for the virtual account","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdTransactionsReturnsPost","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The unique identifier for the virtual account. This can be retrieved from GET /v1/Accounts/{accountId}/Virtual","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"A collection of transactions to return, each transaction must have transaction id and return reason code specified","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.TransactionReturnsRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.EmptyApiResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Transactions":{"get":{"tags":["Accounts"],"summary":"Gets a summary of all of the transactions from the specified account","operationId":"V1AccountsByAccountIdTransactionsGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"startDateTime","in":"query","description":"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.","required":false,"type":"string","format":"date-time"},{"name":"endDateTime","in":"query","description":"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.","required":false,"type":"string","format":"date-time"},{"name":"paymentMethodType","in":"query","description":"The payment method type filters the results to include that payment method type.","required":false,"type":"string","enum":["Transfer","FasterPayments","Bacs","Chaps"]},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Accounts.AccountTransactionsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Transactions":{"get":{"tags":["Virtual Accounts"],"summary":"Gets a summary of all of the transactions from the specified account","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdTransactionsGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The unique identifier for the virtual account.","required":true,"type":"string","format":"uuid"},{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"startDateTime","in":"query","description":"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.","required":false,"type":"string","format":"date-time"},{"name":"endDateTime","in":"query","description":"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.","required":false,"type":"string","format":"date-time"},{"name":"paymentMethodType","in":"query","description":"The payment method type filters the results to include that payment method type.","required":false,"type":"string","enum":["Transfer","FasterPayments","Bacs","Chaps"]},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Accounts.AccountTransactionsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Transactions/{transactionId}":{"get":{"tags":["Accounts"],"summary":"Gets the details of a specific transaction from the specified account","operationId":"V1AccountsByAccountIdTransactionsByTransactionIdGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"transactionId","in":"path","description":"The unique identifier for the transaction. This can be retrieved from GET /v1/Transactions","required":true,"type":"string","format":"uuid"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Accounts.AccountTransactionResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Virtual/{virtualAccountId}/Transactions/{transactionId}":{"get":{"tags":["Virtual Accounts"],"summary":"Gets the details of a specific transaction from the specified virtual account","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdTransactionsByTransactionIdGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The unique identifier for the virtual account. This can be retrieved from GET /v1/Accounts/{accountId}/Virtual","required":true,"type":"string","format":"uuid"},{"name":"transactionId","in":"path","description":"The unique identifier for the transaction. This can be retrieved from GET /v1/Transactions","required":true,"type":"string","format":"uuid"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Accounts.AccountTransactionResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Virtual":{"get":{"tags":["Virtual Accounts"],"summary":"Lists all of the virtual accounts belonging to a given account","description":"All virtual accounts are returned including those which have been disabled. A Status field is available","operationId":"V1AccountsByAccountIdVirtualGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: 1","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: 50","required":false,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.VirtualAccounts.VirtualAccountsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]},"post":{"tags":["Virtual Accounts"],"summary":"Creates a series of virtual accounts","operationId":"V1AccountsByAccountIdVirtualPost","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountsRequest","in":"body","description":"","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.VirtualAccounts.CreateVirtualAccountsRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"202":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.VirtualAccounts.VirtualAccountsCreationAcceptedResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/{accountId}/Virtual/{virtualAccountId}":{"get":{"tags":["Virtual Accounts"],"summary":"Gets a specific Virtual Account","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The account identifier.","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The virtual account identifier.","required":true,"type":"string","format":"uuid"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.VirtualAccounts.VirtualAccountsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]},"delete":{"tags":["Virtual Accounts"],"summary":"Disables the virtual account that belongs to the given account","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdDelete","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /v1/Accounts","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The unique identifier for the virtual account. This can be retrieved from GET /v1/Accounts/{accountId}/Virtual","required":true,"type":"string","format":"uuid"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"204":{"description":"Success","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]},"patch":{"tags":["Virtual Accounts"],"summary":"Requests update of a Virtual Account","operationId":"V1AccountsByAccountIdVirtualByVirtualAccountIdPatch","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"accountId","in":"path","description":"The account identifier.","required":true,"type":"string","format":"uuid"},{"name":"virtualAccountId","in":"path","description":"The virtual account identifier.","required":true,"type":"string","format":"uuid"},{"name":"request","in":"body","description":"Information required to update virtual account","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.VirtualAccounts.UpdateVirtualAccountRequest"}},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"},{"name":"DigitalSignature","in":"header","description":"Signed hash of the body of the request. The hash is signed by your private key","required":true,"type":"string"},{"name":"X-Request-Id","in":"header","description":"A unique identifier for the request","required":true,"type":"string"}],"responses":{"204":{"description":"Success","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"409":{"description":"Conflict","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}},"/v1/Accounts/Virtual":{"get":{"tags":["Virtual Accounts"],"summary":"Lists all of the virtual accounts belonging to an Institution","description":"All virtual accounts are returned including those which have been disabled. A Status field is available","operationId":"V1AccountsVirtualGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"pageNumber","in":"query","description":"The page number to control returned results into manageable sets. Default if not supplied: ClearBank.FI.API.Versions.V1.Controllers.BaseController.DefaultPageNumber","required":false,"type":"integer","format":"int32"},{"name":"pageSize","in":"query","description":"The page size to control returned results into manageable sets. Default if not supplied: ClearBank.FI.API.Versions.V1.Controllers.BaseController.DefaultPageSize","required":false,"type":"integer","format":"int32"},{"name":"Authorization","in":"header","description":"Your API Token, retrieved from the web portal","required":true,"type":"string"}],"responses":{"200":{"description":"Success","schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.VirtualAccounts.VirtualAccountsResponse"},"headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"403":{"description":"Forbidden","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"500":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"503":{"description":"Server Error","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"400":{"description":"Bad Request","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}},"404":{"description":"Not Found","headers":{"X-Correlation-Id":{"description":"A unique identifier which should be referenced in any issue with any API call","type":"string"}}}},"security":[]}}},"definitions":{"ClearBank.FI.API.Versions.V1.Models.Response.Accounts.AccountsResponse":{"description":"Represents one or more accounts and associated hypermedia links","required":["accounts"],"type":"object","properties":{"accounts":{"description":"A collection of all accounts belonging to the institution associated with the API token.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Accounts.Account"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Response.Accounts.Account":{"description":"Represents a summary of a given account","required":["id","name","type","currency"],"type":"object","properties":{"id":{"description":"The unique identifier for the account","type":"string"},"name":{"description":"The friendly name of the account","type":"string"},"type":{"description":"Specifies the type of the account","enum":["CACC"],"type":"string"},"currency":{"description":"Currencies used for the account","uniqueItems":false,"type":"array","items":{"enum":["ALL","DZD","ARS","AUD","BSD","BHD","BDT","AMD","BBD","BMD","BTN","BOB","BWP","BZD","SBD","BND","MMK","BIF","KHR","CAD","CVE","KYD","LKR","CLP","CNY","COP","KMF","CRC","HRK","CUP","CZK","DKK","DOP","SVC","ETB","ERN","FKP","FJD","DJF","GMD","GIP","GTQ","GNF","GYD","HTG","HNL","HKD","HUF","ISK","INR","IDR","IRR","IQD","ILS","JMD","JPY","KZT","JOD","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","LRD","LYD","MOP","MWK","MYR","MVR","MUR","MXN","MNT","MDL","MAD","OMR","NAD","NPR","ANG","AWG","VUV","NZD","NIO","NGN","NOK","PKR","PAB","PGK","PYG","PEN","PHP","QAR","RUB","RWF","SHP","SAR","SCR","SLL","SGD","VND","SOS","ZAR","SSP","SZL","SEK","CHF","SYP","THB","TOP","TTD","AED","TND","UGX","MKD","EGP","GBP","TZS","USD","UYU","UZS","WST","YER","TWD","MRU","STN","CUC","ZWL","BYN","TMT","GHS","VEF","SDG","UYI","RSD","MZN","AZN","RON","CHE","CHW","TRY","XAF","XCD","XOF","XPF","XBA","XBB","XBC","XBD","XAU","XDR","XAG","XPT","XTS","XPD","XUA","ZMW","SRD","MGA","COU","AFN","TJS","AOA","BGN","CDF","BAM","EUR","MXV","UAH","GEL","BOV","PLN","BRL","CLF","XSU","USN","XXX"],"type":"string"}},"balances":{"description":"Balances associated with the account in the given currencies","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Accounts.Balance"}},"iban":{"description":"The IBAN identifier associated with the account","type":"string"},"bban":{"description":"The BBAN identifier associated with the account","type":"string"},"upic":{"description":"The Universal Payment Identification Code (UPIC) associated with the account","type":"string"},"cuid":{"description":"The CHIPS Universal Identifier associated with the account","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Response.HalLink":{"description":"A single hypermedia link","required":["name","href"],"type":"object","properties":{"name":{"description":"The named link type","type":"string"},"href":{"description":"URI to be used","type":"string"},"templated":{"description":"Specifies \"true\" if href is a URI template, i.e. with parameters. Otherwise, this property is absent or set to false","type":"boolean"}}},"ClearBank.FI.API.Versions.V1.Models.Response.Accounts.Balance":{"description":"A summary of the balance of an account, in a specific currency","required":["name","amount","currency","status"],"type":"object","properties":{"name":{"description":"The name of the account","type":"string"},"amount":{"format":"double","description":"The amount of monies, relative to the specified currency, in the account","type":"number"},"currency":{"description":"The ISO 4217 currency code of the account","enum":["ALL","DZD","ARS","AUD","BSD","BHD","BDT","AMD","BBD","BMD","BTN","BOB","BWP","BZD","SBD","BND","MMK","BIF","KHR","CAD","CVE","KYD","LKR","CLP","CNY","COP","KMF","CRC","HRK","CUP","CZK","DKK","DOP","SVC","ETB","ERN","FKP","FJD","DJF","GMD","GIP","GTQ","GNF","GYD","HTG","HNL","HKD","HUF","ISK","INR","IDR","IRR","IQD","ILS","JMD","JPY","KZT","JOD","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","LRD","LYD","MOP","MWK","MYR","MVR","MUR","MXN","MNT","MDL","MAD","OMR","NAD","NPR","ANG","AWG","VUV","NZD","NIO","NGN","NOK","PKR","PAB","PGK","PYG","PEN","PHP","QAR","RUB","RWF","SHP","SAR","SCR","SLL","SGD","VND","SOS","ZAR","SSP","SZL","SEK","CHF","SYP","THB","TOP","TTD","AED","TND","UGX","MKD","EGP","GBP","TZS","USD","UYU","UZS","WST","YER","TWD","MRU","STN","CUC","ZWL","BYN","TMT","GHS","VEF","SDG","UYI","RSD","MZN","AZN","RON","CHE","CHW","TRY","XAF","XCD","XOF","XPF","XBA","XBB","XBC","XBD","XAU","XDR","XAG","XPT","XTS","XPD","XUA","ZMW","SRD","MGA","COU","AFN","TJS","AOA","BGN","CDF","BAM","EUR","MXV","UAH","GEL","BOV","PLN","BRL","CLF","XSU","USN","XXX"],"type":"string"},"status":{"description":"The type of balance that is being reported","enum":["CLBD","XPCD","OTHR","VALU"],"type":"string"},"lastCommittedTransaction":{"description":"The reference of the last committed transaction against the account","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Accounts.CreateAccountRequest":{"description":"Information that is used to create a Current Account","required":["accountName"],"type":"object","properties":{"accountName":{"description":"The friendly name that should be associated with the account","maxLength":70,"minLength":1,"pattern":"^[a-zA-Z0-9\\- ,.]*$","type":"string"},"owner":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Accounts.PartyIdentification","description":"Set of elements used to identify a person or an organisation"},"sortCode":{"description":"The sort code these accounts should be created under","pattern":"^\\d{6}$","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Accounts.PartyIdentification":{"description":"Set of elements used to identify a person or an organisation","type":"object","properties":{"name":{"description":"Name by which a party is known and which is usually used to identify that party","maxLength":140,"minLength":0,"pattern":"^[^<!&|$*;^%_>`#@=\"~\\[\\]{}\\\\]*$","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Response.Accounts.AccountResponse":{"description":"Represents a single account and associated hypermedia links","required":["account"],"type":"object","properties":{"account":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Accounts.Account","description":"Details of the requested account"},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails":{"description":"A ClearBank.FI.API.Versions.V1.Models.Response.ProblemDetails for validation errors.","required":["type","title"],"type":"object","properties":{"errors":{"description":"Gets or sets the validation errors associated with this instance of ClearBank.FI.API.Versions.V1.Models.Response.ValidationProblemDetails.","type":"object","additionalProperties":{"uniqueItems":false,"type":"array","items":{"type":"string"}},"readOnly":true},"type":{"description":"A URI reference [RFC3986] that identifies the problem type. This specification encourages that, when\r\ndereferenced, it provides human-readable documentation for the problem type\r\n(e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be\r\n\"about:blank\".","type":"string"},"title":{"description":"A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence\r\nof the problem, except for purposes of localization(e.g., using proactive content negotiation;\r\nsee[RFC7231], Section 3.4).","type":"string"},"status":{"format":"int32","description":"The HTTP status code([RFC7231], Section 6) generated by the origin server for this occurrence of the problem.","type":"integer"},"detail":{"description":"A human-readable explanation specific to this occurrence of the problem.","type":"string"},"instance":{"description":"A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Accounts.PatchAccountRequest":{"description":"Information required for a current account amendment","type":"object","properties":{"status":{"description":"The status of the account.","enum":["NotProvided","Enabled","Closed","Suspended"],"type":"string"},"statusReason":{"description":"The account status reason","enum":["NotProvided","AccountHolderBankrupt","AccountHolderDeceased","AccountSwitched","CompanyNoLongerTrading","DissatisfiedCustomer","DuplicateSoleTraderAccount","FinancialCrime","FraudFirstParty","FraudThirdParty","Other"],"type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Response.GetUnappliedDirectCreditTransactionsResponse":{"description":"Returns list of all unapplied direct credit transactions for the specified criteria/request","type":"object","properties":{"unappliedTransactions":{"description":"List of unapplied transactions","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.UnpaidTransaction"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.UnpaidTransaction":{"description":"Unpaid transaction info","type":"object","properties":{"pendingTransactionId":{"format":"uuid","description":"The internal identifier of the pending transaction.","type":"string"},"transactionType":{"description":"The type of pending transaction.","enum":["DirectCredit","DirectDebit","DirectDebitIndemnityClaim"],"type":"string"},"transactionStatus":{"description":"The status of the transaction.","enum":["Pending","Rejected","FailedInternalValidation","Processed","Returned","Recalled","ContraNotReceived"],"type":"string"},"creditorAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.CounterpartAccount","description":"The creditor account with BBAN"},"debtorAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.CounterpartAccount","description":"The debtor account with BBAN"},"amount":{"format":"double","description":"The transaction amount.","type":"number"},"paymentReference":{"description":"The actual payment identifier.","type":"string"},"processingDate":{"format":"date-time","description":"The date that transaction is processed.","type":"string"},"settlementDate":{"format":"date-time","description":"The date that we settle transactions internally.","type":"string"},"transferredDate":{"format":"date-time","description":"The date that funds are transferred.","type":"string"},"serviceUserNumber":{"description":"The service user number for the debtor.","type":"string"},"transactionCode":{"description":"The transaction code.","type":"string"},"isReturn":{"description":"Indicates the pending transaction is the result of an existing cash transaction.","type":"boolean"},"hasReturn":{"description":"Indicates the pending transaction has a return transaction.","type":"boolean"},"reasonCode":{"description":"The reason code if any.","type":"string"},"collectionReference":{"description":"The collection reference.","type":"string"},"creditorAccountName":{"description":"The creditor account name.","type":"string"},"debtorAccountName":{"description":"The debtor account name.","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.CounterpartAccount":{"description":"Information about the counterpart in a given transaction","required":["identification"],"type":"object","properties":{"identification":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.CounterpartAccountIdentification","description":"Identification information of the account"}}},"ClearBank.FI.API.Versions.V1.Models.CounterpartAccountIdentification":{"description":"The identifible information of an account","type":"object","properties":{"iban":{"description":"The IBAN number of the account","type":"string"},"other":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.CounterpartAccountGenericIdentification","description":"Unique identification of an account, as assigned by the account service, using an identification scheme"}}},"ClearBank.FI.API.Versions.V1.Models.CounterpartAccountGenericIdentification":{"description":"Unique identification of an account, as assigned by the account servicer, using an identification scheme","required":["identification","schemeName"],"type":"object","properties":{"identification":{"description":"Identification assigned by an institution","maxLength":34,"minLength":1,"type":"string"},"schemeName":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.CounterpartAccountGenericIdentificationScheme","description":"Name of the identification scheme"},"issuer":{"description":"The name of the entity that assigns the identification","maxLength":35,"minLength":0,"type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.CounterpartAccountGenericIdentificationScheme":{"description":"Name of the identification scheme","type":"object","properties":{"code":{"description":"Name of the identification scheme, in a coded form as published in an external list","enum":["BBAN","CUID","UPIC"],"type":"string"},"proprietary":{"description":"Name of the identification scheme, in a free text form","maxLength":35,"minLength":1,"type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Response.GetUnpaidDirectDebitTransactionsResponse":{"description":"Returns list of all unpaid direct debit transactions for the specified criteria/request","type":"object","properties":{"unpaidTransactions":{"description":"List of unpaid transactions","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.UnpaidTransaction"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Response.Mandates.MandatesResponse":{"description":"DirectDebitMandates by Account Response","type":"object","properties":{"directDebitMandates":{"description":"Direct Debit Instructions","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Mandates.DirectDebitMandate"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Response.Mandates.DirectDebitMandate":{"description":"Direct Debit Mandate","type":"object","properties":{"mandateId":{"format":"uuid","description":"Mandate Id","type":"string"},"payerName":{"description":"Payer Name","type":"string"},"reference":{"description":"Reference","type":"string"},"serviceUserNumber":{"description":"Holds the service user number, in case the service user associated with the mandate is not one of our internal service users","type":"string"},"originatorName":{"description":"Originator Name","type":"string"},"state":{"description":"Indicates the mandate state","enum":["Active","PendingInitiation","Cancelled","Rejected","Finished","Returned"],"type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.MandateCreationRequest":{"description":"Request to create a DDM\r\nIBAN and BBAN account identifiers are supported","required":["serviceUserNumber","reference"],"type":"object","properties":{"serviceUserNumber":{"description":"The service user number.","pattern":"^\\d{6}$","type":"string"},"originatorName":{"description":"The originator name.","maxLength":18,"minLength":0,"pattern":"^[A-Z0-9\\.\\&\\/\\-\\ ]*$","type":"string"},"reference":{"description":"The Service User's reference.","maxLength":18,"minLength":1,"pattern":"^[A-Z0-9\\.\\&\\/\\-\\ ]*$","type":"string"},"payerName":{"description":"The payer name.","maxLength":18,"minLength":0,"pattern":"^[A-Z0-9\\.\\&\\/\\-\\ ]*$","type":"string"},"counterpartAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.CounterpartAccount","description":"The counterpart account details"},"mandateType":{"description":"The specified Instruction type for the request. \r\n(You will only use “Origination” and “Migrated” if you are transferring a sort code from another Direct Participant to the ClearBank® domain. “Migrated” indicates that the DDI was initially received as a paper item but later re-lodged in AUDDIS format by the Service User)","enum":["PaperMandate","Origination","Migrated"],"type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Response.EmptyApiResponse":{"description":"An API response which contains no additional properties","type":"object","properties":{"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.MandateCancellationRequest":{"description":"Request to cancel a Mandate","required":["reasonCode"],"type":"object","properties":{"reasonCode":{"description":"The reason code","pattern":"^[0-2B]{1}$","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.MandateAmendmentRequest":{"description":"Request to cancel a Mandate","required":["reasonCode","newDebtorAccount"],"type":"object","properties":{"reasonCode":{"description":"Reason code for requesting the amendment","pattern":"^[EC]{1}$","type":"string"},"newDebtorAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.CounterpartAccount","description":"New debtor account details"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.DirectDebitMandateRejectRequest":{"description":"Direct Debit Mandate Reject Request","required":["rejectionReason"],"type":"object","properties":{"rejectionReason":{"description":"The reason why the DDI is being returned","pattern":"^[BCFGHIK12356]{1}$","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Response.Institutions.InstitutionTransactionsResponse":{"description":"Represents one or more transactions against the specified institution and associated hypermedia links","required":["transactions"],"type":"object","properties":{"transactions":{"description":"A collection of the transactions against the specified account","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Transaction"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Response.Transaction":{"description":"Represents information regarding a transaction","required":["amount","counterpartAccount","debitCreditCode","endToEndIdentifier","transactionId","transactionReference","transactionTime","status"],"type":"object","properties":{"amount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Amount","description":"The instructed amount and applied currency for the instructed amount"},"counterpartAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.CounterpartAccount","description":"Information about the counterpart in a given transaction"},"debitCreditCode":{"description":"The direction of the monies","enum":["CRDT","DBIT"],"type":"string"},"endToEndIdentifier":{"description":"The scheme specific end to end transactional identifier","type":"string"},"transactionId":{"description":"The unique identifier for this transaction","type":"string"},"transactionReference":{"description":"The user supplied reference for the transaction","type":"string"},"transactionTime":{"format":"date-time","description":"The date/time the transaction occurred relative to UTC","type":"string"},"status":{"description":"The current status of the transaction","enum":["ACCP","ACSC","ACSP","ACTC","ACWC","PART","PDNG","RCVD","RJCT"],"type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Amount":{"description":"Indicates the amount and the currency used in a given transaction or account balance","required":["instructedAmount","currency"],"type":"object","properties":{"instructedAmount":{"format":"double","description":"Amount of money to be moved between the debtor and creditor, before deduction of charges, expressed in the currency as ordered by the initiating party","type":"number"},"currency":{"description":"The currency code must be a valid active currency code, not yet withdrawn on the day the message containing the currency is exchanged. Valid active currency codes are registered with the ISO 4217 Maintenance Agency, consist of three (3) contiguous letters, and are not yet withdrawn on the day the message containing the Currency is exchanged","enum":["ALL","DZD","ARS","AUD","BSD","BHD","BDT","AMD","BBD","BMD","BTN","BOB","BWP","BZD","SBD","BND","MMK","BIF","KHR","CAD","CVE","KYD","LKR","CLP","CNY","COP","KMF","CRC","HRK","CUP","CZK","DKK","DOP","SVC","ETB","ERN","FKP","FJD","DJF","GMD","GIP","GTQ","GNF","GYD","HTG","HNL","HKD","HUF","ISK","INR","IDR","IRR","IQD","ILS","JMD","JPY","KZT","JOD","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","LRD","LYD","MOP","MWK","MYR","MVR","MUR","MXN","MNT","MDL","MAD","OMR","NAD","NPR","ANG","AWG","VUV","NZD","NIO","NGN","NOK","PKR","PAB","PGK","PYG","PEN","PHP","QAR","RUB","RWF","SHP","SAR","SCR","SLL","SGD","VND","SOS","ZAR","SSP","SZL","SEK","CHF","SYP","THB","TOP","TTD","AED","TND","UGX","MKD","EGP","GBP","TZS","USD","UYU","UZS","WST","YER","TWD","MRU","STN","CUC","ZWL","BYN","TMT","GHS","VEF","SDG","UYI","RSD","MZN","AZN","RON","CHE","CHW","TRY","XAF","XCD","XOF","XPF","XBA","XBB","XBC","XBD","XAU","XDR","XAG","XPT","XTS","XPD","XUA","ZMW","SRD","MGA","COU","AFN","TJS","AOA","BGN","CDF","BAM","EUR","MXV","UAH","GEL","BOV","PLN","BRL","CLF","XSU","USN","XXX"],"type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Payments.CreateCreditTransferRequest":{"description":"Information that should be used to create a credit transfer","required":["paymentInstructions"],"type":"object","properties":{"paymentInstructions":{"description":"Details of the payments to be made","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Payments.PaymentInstruction"}}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Payments.PaymentInstruction":{"description":"A payment from a single account to multiple creditors","required":["paymentInstructionIdentification","debtor","debtorAccount","creditTransfers"],"type":"object","properties":{"paymentInstructionIdentification":{"description":"The unique identifier for the payment instruction","maxLength":35,"minLength":1,"type":"string"},"requestedExecutionDate":{"format":"date-time","description":"Optional: The ISO 8601 date/time that the instruction should be executed at. Deprecated: Any value specified here will be ignored","type":"string"},"debtor":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Payments.PartyIdentifier","description":"Details about the account holder"},"debtorAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.CounterpartAccount","description":"Details of the account"},"creditTransfers":{"description":"A series of payments that should be made from the debtor account","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Payments.CreditTransfer"}}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Payments.PartyIdentifier":{"description":"The name and, optionally, the legal entity identifier of the account","required":["name"],"type":"object","properties":{"name":{"description":"The name of the account holder","maxLength":140,"minLength":1,"type":"string"},"legalEntityIndentifier":{"description":"The legal entity identifier of the account holder (eg: charity number). This should be supplied if known","maxLength":35,"minLength":0,"type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Payments.CreditTransfer":{"description":"Represents a creditor in a payment instruction","required":["paymentIdentification","amount","creditor","creditorAccount","remittanceInformation"],"type":"object","properties":{"paymentIdentification":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Payments.PaymentIdentification","description":"Identifying information for the credit transfer"},"amount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Amount","description":"The instructed amount and applied currency for the instructed amount"},"creditor":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Payments.PartyIdentifier","description":"Details about the account holder"},"creditorAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.CounterpartAccount","description":"Information about the counterpart in a given transaction"},"remittanceInformation":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Payments.RemittanceInformation","description":"Information regarding the payment, eg: payment reference"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Payments.PaymentIdentification":{"description":"Identification of the payment instruction","required":["instructionIdentification","endToEndIdentification"],"type":"object","properties":{"instructionIdentification":{"description":"Unique identification, as assigned by an instructing party for an instructed party, to unambiguously identify the instruction","maxLength":35,"minLength":1,"type":"string"},"endToEndIdentification":{"description":"Unique identification, as assigned by the initiating party, to unambiguously identify the transaction. This identification is passed on, unchanged, throughout the entire end-to-end chain","maxLength":35,"minLength":1,"type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Payments.RemittanceInformation":{"description":"Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system","type":"object","properties":{"structured":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Payments.Structured","description":"Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form."}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Payments.Structured":{"description":"Information supplied to enable the matching/reconciliation of an entry with the items that the payment is intended to settle, such as commercial invoices in an accounts' receivable system, in a structured form.","type":"object","properties":{"creditorReferenceInformation":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Payments.CreditorReferenceInformation","description":"Reference information provided by the creditor to allow the identification of the underlying documents."}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Payments.CreditorReferenceInformation":{"description":"Reference information provided by the creditor to allow the identification of the underlying documents.","type":"object","properties":{"reference":{"description":"A reference, as assigned by the creditor, to unambiguously refer to the payment transaction.","maxLength":35,"minLength":0,"type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Response.Payments.CreditTransferResponse":{"description":"The result of each payment instruction and applicable links","type":"object","properties":{"transactions":{"description":"The acceptance or rejection status of each individual payment instruction","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Payments.PaymentInstructionResponse"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Response.Payments.PaymentInstructionResponse":{"description":"An individual response for a debtor/creditor pairing","required":["endToEndIdentification","response"],"type":"object","properties":{"endToEndIdentification":{"description":"The unique identifier for the payment instruction","type":"string"},"response":{"description":"The result of how we are going to process the individual payment instruction","enum":["Accepted","AccountDisabled","InsufficientFunds","InvalidAccount","InvalidCurrency","Rejected","DebitPaymentDisabled"],"type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Response.Mandates.MandateTransactionsResponse":{"description":"List of transactions","type":"object","properties":{"mandateTransactions":{"description":"Array of transactions","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.MandateTransaction"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.MandateTransaction":{"description":"Transaction associated with mandate","type":"object","properties":{"transactionId":{"format":"uuid","description":"Unique transaction ID","type":"string"},"date":{"format":"date-time","description":"Date of transaction settled","type":"string"},"amount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Amount","description":"Amount and currency"},"status":{"description":"Status of transaction","type":"string"},"reference":{"description":"Reference of transaction","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Response.GetAllUnpaidTransactionsResponse":{"description":"Returns list of all unpaid transactions for the specified criteria/request","type":"object","properties":{"unpaidTransactions":{"description":"List of unpaid transactions","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.UnpaidTransaction"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.TransactionReturnsRequest":{"description":"Request to make a return of transaction","required":["returns"],"type":"object","properties":{"returns":{"description":"Array of transactions to be returned","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.TransactionReturn"}}}},"ClearBank.FI.API.Versions.V1.Models.Binding.Mandates.TransactionReturn":{"description":"Direct Debit Transaction to be returned","required":["transactionId","reasonCode"],"type":"object","properties":{"transactionId":{"format":"uuid","description":"Transaction identification.","type":"string"},"reasonCode":{"description":"Reason for return, single character only,\r\nAllowed ReasonCode for Bacs Direct Credit:\r\n 0 - Invalid details,\r\n 2 - Beneficiary deceased,\r\n 3 - Account transferred,\r\n 5 - No account,\r\n B - Account closed,\r\n C - Requested by Remitter.\r\nAllowed ReasonCode for Direct Debit:\r\n 0 - Refer to payer, \r\n 1 - Instruction canceled, \r\n 2 - Payer deceased, \r\n 3 - Account transferred, \r\n 4 - Advance notice disputed,\r\n 5 - No account(OR wrong account type),\r\n 6 - No Instruction, \r\n 7 - Amount differs, \r\n 8 - Amount not yet due, \r\n 9 - Presentation overdue,\r\n A - Service user differs,\r\n B - Account closed.","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Response.Accounts.AccountTransactionsResponse":{"description":"Represents one or more transactions against the specified account and associated hypermedia links","required":["transactions"],"type":"object","properties":{"transactions":{"description":"A collection of the transactions against the specified account","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Transaction"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Response.Accounts.AccountTransactionResponse":{"description":"Represents a transaction against the specified account and associated hypermedia links","required":["transaction"],"type":"object","properties":{"transaction":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.Transaction","description":"The transaction requested"},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Binding.VirtualAccounts.CreateVirtualAccountsRequest":{"description":"Information that's used to create multiple virtual accounts","required":["virtualAccounts"],"type":"object","properties":{"virtualAccounts":{"description":"The virtual accounts that should be created","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.VirtualAccounts.CreateVirtualAccount"}}}},"ClearBank.FI.API.Versions.V1.Models.Binding.VirtualAccounts.CreateVirtualAccount":{"description":"Represents the data required to create a virtual account","required":["accountName","accountIdentifier"],"type":"object","properties":{"accountName":{"description":"The friendly name that should be given to the virtual account","maxLength":70,"minLength":1,"type":"string"},"owner":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Binding.VirtualAccounts.PartyIdentification","description":"Set of elements used to identify a person or an organisation"},"accountIdentifier":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.AccountIdentifier","description":"How to identify the account"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.VirtualAccounts.PartyIdentification":{"description":"Set of elements used to identify a person or an organisation","type":"object","properties":{"name":{"description":"Name by which a party is known and which is usually used to identify that party","maxLength":140,"minLength":0,"pattern":"^[^<!&|$*;^%_>`#@=\"~\\[\\]{}\\\\]*$","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.AccountIdentifier":{"description":"Represents ways of identifying an account","type":"object","properties":{"iban":{"description":"The IBAN identifier associated with the account","type":"string"},"bban":{"description":"The BBAN identifier associated with the account","type":"string"},"upic":{"description":"The Universal Payment Identification Code (UPIC) associated with the account","type":"string"},"cuid":{"description":"The CHIPS Universal Identifier associated with the account","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Response.VirtualAccounts.VirtualAccountsCreationAcceptedResponse":{"description":"Provides the necessary links that are required after a virtual account has been accepted for processing","type":"object","properties":{"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Response.VirtualAccounts.VirtualAccountsResponse":{"description":"Represents one or more accounts and associated hypermedia links","required":["accounts"],"type":"object","properties":{"accounts":{"description":"A collection of all accounts belonging to the institution associated with the API token.","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.VirtualAccounts.VirtualAccount"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V1.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V1.Models.Response.VirtualAccounts.VirtualAccount":{"description":"Represents a summary of a given Virtual Account","required":["id","name","type","currency"],"type":"object","properties":{"id":{"description":"The unique identifier for the account","type":"string"},"name":{"description":"The friendly name of the account","type":"string"},"type":{"description":"Specifies the type of the account","enum":["CACC"],"type":"string"},"status":{"description":"Status","enum":["Enabled","Disabled"],"type":"string"},"currency":{"description":"Currencies used for the account","uniqueItems":false,"type":"array","items":{"enum":["ALL","DZD","ARS","AUD","BSD","BHD","BDT","AMD","BBD","BMD","BTN","BOB","BWP","BZD","SBD","BND","MMK","BIF","KHR","CAD","CVE","KYD","LKR","CLP","CNY","COP","KMF","CRC","HRK","CUP","CZK","DKK","DOP","SVC","ETB","ERN","FKP","FJD","DJF","GMD","GIP","GTQ","GNF","GYD","HTG","HNL","HKD","HUF","ISK","INR","IDR","IRR","IQD","ILS","JMD","JPY","KZT","JOD","KES","KPW","KRW","KWD","KGS","LAK","LBP","LSL","LRD","LYD","MOP","MWK","MYR","MVR","MUR","MXN","MNT","MDL","MAD","OMR","NAD","NPR","ANG","AWG","VUV","NZD","NIO","NGN","NOK","PKR","PAB","PGK","PYG","PEN","PHP","QAR","RUB","RWF","SHP","SAR","SCR","SLL","SGD","VND","SOS","ZAR","SSP","SZL","SEK","CHF","SYP","THB","TOP","TTD","AED","TND","UGX","MKD","EGP","GBP","TZS","USD","UYU","UZS","WST","YER","TWD","MRU","STN","CUC","ZWL","BYN","TMT","GHS","VEF","SDG","UYI","RSD","MZN","AZN","RON","CHE","CHW","TRY","XAF","XCD","XOF","XPF","XBA","XBB","XBC","XBD","XAU","XDR","XAG","XPT","XTS","XPD","XUA","ZMW","SRD","MGA","COU","AFN","TJS","AOA","BGN","CDF","BAM","EUR","MXV","UAH","GEL","BOV","PLN","BRL","CLF","XSU","USN","XXX"],"type":"string"}},"iban":{"description":"The IBAN identifier associated with the account","type":"string"},"bban":{"description":"The BBAN identifier associated with the account","type":"string"},"upic":{"description":"The Universal Payment Identification Code (UPIC) associated with the account","type":"string"},"cuid":{"description":"The CHIPS Universal Identifier associated with the account","type":"string"}}},"ClearBank.FI.API.Versions.V1.Models.Binding.VirtualAccounts.UpdateVirtualAccountRequest":{"description":"Represents the data for updating a virtual account","required":["ownerName"],"type":"object","properties":{"ownerName":{"description":"Owner name","maxLength":70,"minLength":1,"pattern":"^[^<!&|$*;^%_>`#@=\"~\\[\\]{}\\\\]*$","type":"string"}}}}}