clearbank-api-v2.json

{"swagger":"2.0","info":{"version":"2.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":{"/v2/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":"V2AccountsGet","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.V2.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":"V2AccountsPost","consumes":["application/json"],"produces":["application/json","application/problem+json"],"parameters":[{"name":"request","in":"body","required":false,"schema":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.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.V2.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.V2.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":[]}},"/v2/Accounts/{accountId}":{"get":{"tags":["Accounts"],"summary":"Gets a detailed view of an account","operationId":"V2AccountsByAccountIdGet","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.V2.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.V2.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":[]}},"/v2/Accounts/{accountId}/Mandates":{"get":{"tags":["Accounts"],"summary":"Gets all of the Direct Debit Instructions associated with the account","operationId":"V2AccountsByAccountIdMandatesGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /V2/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.V2.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.V2.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":[]}},"/v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates":{"get":{"tags":["Virtual Accounts"],"summary":"Gets all of the Direct Debit Instructions associated with the virtual account","operationId":"V2AccountsByAccountIdVirtualByVirtualAccountIdMandatesGet","consumes":["application/json"],"produces":["application/json"],"parameters":[{"name":"accountId","in":"path","description":"The unique identifier for the account. This can be retrieved from GET /V2/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 /V2/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.V2.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.V2.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":[]}},"/v2/Transactions":{"get":{"tags":["Institution"],"summary":"Gets a summary of all of the transactions from the institution","operationId":"V2TransactionsGet","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.V2.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.V2.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.V2.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.V2.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":[]}},"/v2/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 />\r\nSee above for more information on scheme related character sets for FPS and CHAPS.","operationId":"V2PaymentsBySchemePost","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.V2.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.V2.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.V2.Models.Response.Payments.CreditTransferResponse","type":"ClearBank.FI.API.Versions.V2.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.V2.Models.Response.ValidationProblemDetails","type":"ClearBank.FI.API.Versions.V2.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":[]}},"/v2/Accounts/{accountId}/Transactions":{"get":{"tags":["Accounts"],"summary":"Gets a summary of all of the transactions from the specified account","operationId":"V2AccountsByAccountIdTransactionsGet","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.V2.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.V2.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":[]}},"/v2/Accounts/{accountId}/Transactions/{transactionId}":{"get":{"tags":["Accounts"],"summary":"Gets the details of a specific transaction from the specified account","operationId":"V2AccountsByAccountIdTransactionsByTransactionIdGet","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.V2.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.V2.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":[]}},"/v2/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":"V2AccountsByAccountIdMandatesByMandateIdCollectionsGet","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.V2.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.V2.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":[]}},"/v2/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":"V2AccountsByAccountIdVirtualByVirtualAccountIdMandatesByMandateIdCollectionsGet","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.V2.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.V2.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":[]}},"/v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Transactions":{"get":{"tags":["Virtual Accounts"],"summary":"Gets a summary of all of the transactions from the specified account","operationId":"V2AccountsByAccountIdVirtualByVirtualAccountIdTransactionsGet","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.V2.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.V2.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":[]}},"/v2/Accounts/{accountId}/Mandates/Unpaid":{"get":{"tags":["Accounts"],"summary":"Returns a list of all unpaid transactions belonging to an account","operationId":"V2AccountsByAccountIdMandatesUnpaidGet","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.V2.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.V2.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":[]}},"/v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Mandates/Unpaid":{"get":{"tags":["Virtual Accounts"],"summary":"Returns a list of all unpaid transactions belonging to a virtual account","operationId":"V2AccountsByAccountIdVirtualByVirtualAccountIdMandatesUnpaidGet","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.V2.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.V2.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":[]}},"/v2/Accounts/{accountId}/Virtual/{virtualAccountId}/Transactions/{transactionId}":{"get":{"tags":["Virtual Accounts"],"summary":"Gets the details of a specific transaction from the specified virtual account","operationId":"V2AccountsByAccountIdVirtualByVirtualAccountIdTransactionsByTransactionIdGet","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.V2.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.V2.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":[]}},"/v2/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":"V2AccountsByAccountIdVirtualGet","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.V2.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":"V2AccountsByAccountIdVirtualPost","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.V2.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.V2.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/Microsoft.AspNetCore.Mvc.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":[]}},"/v2/Accounts/{accountId}/Virtual/{virtualAccountId}":{"get":{"tags":["Virtual Accounts"],"summary":"Gets a specific Virtual Account","operationId":"V2AccountsByAccountIdVirtualByVirtualAccountIdGet","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.V2.Models.Response.VirtualAccounts.VirtualAccountResponse"},"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":[]}}},"definitions":{"ClearBank.FI.API.Versions.V2.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.V2.Models.Response.Accounts.Account"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V2.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"},"label":{"description":"The account holder label for 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.V2.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.V2.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.V2.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.V2.Models.Binding.Accounts.CreateAccountRequest":{"description":"Information that is used to create a Current Account","required":["accountName","sortCode"],"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.V2.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.V2.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.V2.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.V2.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.V2.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V2.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.V2.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.V2.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.V2.Models.Response.Mandates.DirectDebitMandate"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V2.Models.Response.Mandates.DirectDebitMandate":{"description":"Direct Debit Mandate","type":"object","properties":{"mandateId":{"format":"uuid","description":"DDI Id","type":"string"},"payerName":{"description":"Payer Name","type":"string"},"payerBban":{"description":"Payer Bban","type":"string"},"payerAccountNumber":{"description":"Payer Account Number","type":"string"},"payerSortCode":{"description":"Payer Sort Code","type":"string"},"reference":{"description":"Reference","type":"string"},"serviceUserNumber":{"description":"Holds the service user number of the organisation which is authorised to collect this Direct Debit","type":"string"},"originatorName":{"description":"Originator Name","type":"string"},"state":{"description":"Indicates the Instruction state","enum":["Active","PendingInitiation","Cancelled","Rejected","Finished","Returned"],"type":"string"}}},"ClearBank.FI.API.Versions.V2.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.V2.Models.Response.Transaction"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V2.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.V2.Models.Amount","description":"The instructed amount and applied currency for the instructed amount"},"counterpartAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.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"},"ultimateBeneficiaryAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.Accounts.UltimateAccount","description":"The ultimate beneficiary account details in a given transaction"},"ultimateRemitterAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.Accounts.UltimateAccount","description":"The ultimate remitter account details in a given transaction"}}},"ClearBank.FI.API.Versions.V2.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.V2.Models.CounterpartAccount":{"description":"Information about the counterpart in a given transaction","required":["identification"],"type":"object","properties":{"identification":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.CounterpartAccountIdentification","description":"Identification information of the account"}}},"ClearBank.FI.API.Versions.V2.Models.Response.Accounts.UltimateAccount":{"description":"Represents a summary of a given ultimate account","required":["id"],"type":"object","properties":{"id":{"description":"The unique identifier for the account","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.V2.Models.CounterpartAccountIdentification":{"description":"The identifible information of an account","type":"object","properties":{"iban":{"description":"The IBAN number of the account","type":"string"},"accountName":{"description":"The account name","type":"string"},"sortCode":{"description":"The accounts sort code","type":"string"},"accountNumber":{"description":"The account number","type":"string"},"reference":{"description":"The payment reference","type":"string"},"other":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.CounterpartAccountGenericIdentification","description":"Unique identification of an account, as assigned by the account service, using an identification scheme"}}},"ClearBank.FI.API.Versions.V2.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.V2.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.V2.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.V2.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.V2.Models.Binding.Payments.PaymentInstruction"}}}},"ClearBank.FI.API.Versions.V2.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"},"schemeChannelName":{"description":"The (optional) scheme channel name","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.V2.Models.Binding.Payments.DebtorPartyIdentifier","description":"Details about the account holder"},"debtorAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Binding.Payments.PaymentInstructionCounterpartAccount","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.V2.Models.Binding.Payments.CreditTransfer"}}}},"ClearBank.FI.API.Versions.V2.Models.Binding.Payments.DebtorPartyIdentifier":{"description":"Optionally, the legal entity identifier of the account","type":"object","properties":{"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.V2.Models.Binding.Payments.PaymentInstructionCounterpartAccount":{"description":"Information about the counterpart in a given transaction","required":["identification"],"type":"object","properties":{"identification":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Binding.Payments.PaymentInstructionCounterpartAccountIdentification","description":"Identification information of the account"}}},"ClearBank.FI.API.Versions.V2.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.V2.Models.Binding.Payments.PaymentIdentification","description":"Identifying information for the credit transfer"},"amount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Amount","description":"The instructed amount and applied currency for the instructed amount"},"creditor":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Binding.Payments.PartyIdentifier","description":"Details about the account holder"},"creditorAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Binding.Payments.PaymentInstructionCounterpartAccount","description":"Information about the counterpart in a given transaction"},"remittanceInformation":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Binding.Payments.RemittanceInformation","description":"Information regarding the payment, eg: payment reference"}}},"ClearBank.FI.API.Versions.V2.Models.Binding.Payments.PaymentInstructionCounterpartAccountIdentification":{"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.V2.Models.CounterpartAccountGenericIdentification","description":"Unique identification of an account, as assigned by the account service, using an identification scheme"}}},"ClearBank.FI.API.Versions.V2.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.V2.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.V2.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.V2.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.V2.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.V2.Models.Binding.Payments.CreditorReferenceInformation","description":"Reference information provided by the creditor to allow the identification of the underlying documents."}}},"ClearBank.FI.API.Versions.V2.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.V2.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.V2.Models.Response.Payments.PaymentInstructionResponse"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V2.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.V2.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.V2.Models.Response.Transaction"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V2.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.V2.Models.Response.Transaction","description":"The transaction requested"},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V2.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.V2.Models.Binding.Mandates.MandateTransaction"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V2.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.V2.Models.Amount","description":"Amount and currency"},"status":{"description":"Status of transaction","type":"string"},"reference":{"description":"Reference of transaction","type":"string"},"debtorBban":{"description":"The debtors bban","type":"string"},"debtorAccountName":{"description":"The debtors account name","type":"string"},"debtorSortCode":{"description":"The debtors sort code","type":"string"},"debtorAccountNumber":{"description":"The debtors account number","type":"string"}}},"ClearBank.FI.API.Versions.V2.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.V2.Models.UnpaidTransaction"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V2.Models.UnpaidTransaction":{"description":"Unpaid transaction info","type":"object","properties":{"pendingTransactionId":{"format":"uuid","description":"The internal identifier of the pending BACS credit transaction.","type":"string"},"transactionType":{"description":"The type of pending BACS credit 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.V2.Models.CounterpartAccount","description":"The creditor account with BBAN"},"debtorAccount":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.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 on a Direct Credit.","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"}}},"ClearBank.FI.API.Versions.V2.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.V2.Models.Response.VirtualAccounts.VirtualAccount"}},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.HalLink"}}}},"ClearBank.FI.API.Versions.V2.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"},"label":{"description":"The account holder label","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.V2.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.V2.Models.Binding.VirtualAccounts.CreateVirtualAccount"}}}},"ClearBank.FI.API.Versions.V2.Models.Binding.VirtualAccounts.CreateVirtualAccount":{"description":"Represents the data required to create a virtual account","required":["ownerName","accountIdentifier"],"type":"object","properties":{"ownerName":{"description":"Virtual account owner name (account holder label)","maxLength":70,"minLength":1,"pattern":"^[^<!&|$*;^%_>`#@=\"~\\[\\]{}\\\\]*$","type":"string"},"accountIdentifier":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.VirtualAccountIdentifier","description":"How to identify the account"}}},"ClearBank.FI.API.Versions.V2.Models.VirtualAccountIdentifier":{"description":"Represents ways of identifying a virtual 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"},"proprietaryIdentifier":{"description":"ClearBank proprietary identifier consisting of country code, sort code and account number","type":"string"},"externalIdentifier":{"description":"Customer provided External ID","maxLength":50,"minLength":0,"type":"string"}}},"ClearBank.FI.API.Versions.V2.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.V2.Models.Response.HalLink"}}}},"Microsoft.AspNetCore.Mvc.ValidationProblemDetails":{"type":"object","properties":{"errors":{"type":"object","additionalProperties":{"uniqueItems":false,"type":"array","items":{"type":"string"}},"readOnly":true},"type":{"type":"string"},"title":{"type":"string"},"status":{"format":"int32","type":"integer"},"detail":{"type":"string"},"instance":{"type":"string"}}},"ClearBank.FI.API.Versions.V2.Models.Response.VirtualAccounts.VirtualAccountResponse":{"description":"Represents one or more accounts and associated hypermedia links","required":["account"],"type":"object","properties":{"account":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.VirtualAccounts.VirtualAccount","description":"The Virtual account details"},"halLinks":{"description":"Hypermedia links","uniqueItems":false,"type":"array","items":{"$ref":"#/definitions/ClearBank.FI.API.Versions.V2.Models.Response.HalLink"}}}}}}