# Schemas

## The IbanValidateResult object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"IbanValidateResult":{"title":"IbanValidateResult","type":"object","properties":{"iban":{"type":"string","description":"IBAN"},"valid":{"type":"boolean","description":"Flag that specifies if IBAN is valid or not. IBAN is valid if all validations contain the validation success code, i.e. the code value that starts with double zero (example 001). More details can be found at https://www.iban.com/validation-api and https://www.iban.com/iban-checker."},"bank_data":{"$ref":"#/components/schemas/BankData"},"sepa_data":{"$ref":"#/components/schemas/SepaData"},"validations":{"$ref":"#/components/schemas/Validations"},"errors":{"type":"array","items":{"$ref":"#/components/schemas/Validation"},"description":"List of errors, if any"}},"required":["iban","valid"]},"BankData":{"type":"object","properties":{"bic":{"type":"string","description":"The BIC code of the issuing bank/branch or institution."},"bank":{"type":"string","description":"The name of the bank/institution that issued the IBAN"},"bank_code":{"type":"string","description":"The code of the bank/institution that issued the IBAN"},"country":{"type":"string","description":"Full name of the country of origin e.g. “United States”"},"country_iso":{"type":"string","description":"Two letter abbreviation of the country code e.g. US, UK, AU, FR … etc."}}},"SepaData":{"type":"object","properties":{"SCT":{"type":"string","description":"Whether this bank supports SEPA Credit Transfer (YES or NO)."},"SDD":{"type":"string","description":"Whether this bank supports SEPA Direct Debit (YES or NO)."},"COR1":{"type":"string","description":"Whether this bank supports SEPA COR1 (YES or NO)."},"B2B":{"type":"string","description":"Whether this bank supports SEPA Business to Business (YES or NO)."},"SCC":{"type":"string","description":"Whether this bank supports SEPA Card Clearing (YES or NO)."}}},"Validations":{"type":"object","properties":{"chars":{"$ref":"#/components/schemas/Validation"},"account":{"$ref":"#/components/schemas/Validation"},"iban":{"$ref":"#/components/schemas/Validation"},"structure":{"$ref":"#/components/schemas/Validation"},"length":{"$ref":"#/components/schemas/Validation"},"country_support":{"$ref":"#/components/schemas/Validation"}}},"Validation":{"type":"object","properties":{"code":{"type":"string","description":"Validation code as described at https://www.iban.com/validation-api"},"message":{"type":"string","description":"Validation message"}},"required":["code","message"]}}}}
```

## The BankData object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"BankData":{"type":"object","properties":{"bic":{"type":"string","description":"The BIC code of the issuing bank/branch or institution."},"bank":{"type":"string","description":"The name of the bank/institution that issued the IBAN"},"bank_code":{"type":"string","description":"The code of the bank/institution that issued the IBAN"},"country":{"type":"string","description":"Full name of the country of origin e.g. “United States”"},"country_iso":{"type":"string","description":"Two letter abbreviation of the country code e.g. US, UK, AU, FR … etc."}}}}}}
```

## The SepaData object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"SepaData":{"type":"object","properties":{"SCT":{"type":"string","description":"Whether this bank supports SEPA Credit Transfer (YES or NO)."},"SDD":{"type":"string","description":"Whether this bank supports SEPA Direct Debit (YES or NO)."},"COR1":{"type":"string","description":"Whether this bank supports SEPA COR1 (YES or NO)."},"B2B":{"type":"string","description":"Whether this bank supports SEPA Business to Business (YES or NO)."},"SCC":{"type":"string","description":"Whether this bank supports SEPA Card Clearing (YES or NO)."}}}}}}
```

## The Validations object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"Validations":{"type":"object","properties":{"chars":{"$ref":"#/components/schemas/Validation"},"account":{"$ref":"#/components/schemas/Validation"},"iban":{"$ref":"#/components/schemas/Validation"},"structure":{"$ref":"#/components/schemas/Validation"},"length":{"$ref":"#/components/schemas/Validation"},"country_support":{"$ref":"#/components/schemas/Validation"}}},"Validation":{"type":"object","properties":{"code":{"type":"string","description":"Validation code as described at https://www.iban.com/validation-api"},"message":{"type":"string","description":"Validation message"}},"required":["code","message"]}}}}
```

## The Validation object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"Validation":{"type":"object","properties":{"code":{"type":"string","description":"Validation code as described at https://www.iban.com/validation-api"},"message":{"type":"string","description":"Validation message"}},"required":["code","message"]}}}}
```

## The CreateTransferResult object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"CreateTransferResult":{"title":"CreateTransferResult","type":"object","properties":{"transferId":{"type":"string","format":"uuid","description":"Unique transfer identification number in UUID format"},"createdOn":{"type":"string","format":"date-time","description":"The date denoting when the transfer's record was initially created"}},"required":["transferId","createdOn"]}}}}
```

## The TransferData object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"TransferData":{"title":"TransferData","type":"object","properties":{"customerId":{"type":"string","format":"uuid","description":"The identifier of the customer."},"customerProductId":{"type":"string","format":"uuid","description":"Unique customer product identification number in UUID format"},"reference":{"type":"string","minLength":6,"maxLength":140,"description":"Transfer reference. If not provided, a text 'NOT PROVIDED' will be used. If provided, it must contain at least 6 alphanumeric characters that are not all the same and it can contain special characters include space, hyphen(-), full stop (.), ampersand(&), and forward slash (/)."},"receiverIban":{"type":"string","description":"IBAN code","pattern":"^[A-Z]{2}[0-9A-Z]{14,31}$","maxLength":33},"amount":{"type":"number","description":"transfer amount","minimum":0,"exclusiveMinimum":true,"multipleOf":0.01},"instant":{"type":"boolean","description":"flag indicating if the transfer is an instant transfer","default":false},"externalId":{"type":"string","pattern":"[a-zA-Z0-9]{32,32}","description":"External Id in partner's system. This value has to be unique."},"currency":{"$ref":"#/components/schemas/TransferCurrencyEnum"}},"required":["customerId","customerProductId","receiverIban","amount","externalId"]},"TransferCurrencyEnum":{"title":"SepaTransferCurrencyEnum","enum":["EUR"],"description":"Sepa Transfer Currency"}}}}
```

## The Transfer object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"Transfer":{"title":"Transfer","properties":{"transferId":{"type":"string","format":"uuid","description":"Unique transfer identification number in UUID format"},"transferStatus":{"$ref":"#/components/schemas/TransferStatusEnum"},"rejectReason":{"type":"string","description":"The reason of the transfer rejection."},"createdOn":{"type":"string","format":"date-time","description":"The date denoting when the transfer's record was initially created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date indicating the most recent modification made to the transfer's data"},"customerId":{"type":"string","format":"uuid","description":"The identifier of the customer."},"customerProductId":{"type":"string","format":"uuid","description":"Unique customer product identification number in UUID format"},"reference":{"type":"string","maxLength":140,"description":"transfer reference"},"name":{"type":"string","maxLength":255,"description":"Receiver name"},"iban":{"type":"string","description":"IBAN code","pattern":"^[A-Z]{2}[0-9A-Z]{14,31}$","maxLength":33},"bic":{"type":"string","description":"BIC (Business Identifier Code) of the receiver bank","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z\\d]{2}(?:[A-Z\\d]{3})?$"},"amount":{"type":"number","description":"transfer amount","minimum":0,"exclusiveMinimum":true,"multipleOf":0.01},"instant":{"type":"boolean","description":"flag indicating if the transfer is an instant transfer","default":false},"externalId":{"type":"string","pattern":"[a-zA-Z0-9]{32,32}","description":"External Id in partner's system for outgoing transfers. This value has to be unique."},"transactionType":{"$ref":"#/components/schemas/TransactionTypeEnum"},"currency":{"$ref":"#/components/schemas/TransferCurrencyEnum"}},"required":["transferId","transferStatus","createdOn","modifiedOn","customerId","customerProductId","reference","name","iban","amount","transactionType"]},"TransferStatusEnum":{"title":"TransferStatusEnum","enum":["RECEIVED","INVALID","PENDING","REJECTED","PROCESSED","RECONCILED"],"description":"Status of the transfer"},"TransactionTypeEnum":{"title":"TransactionTypeEnum","enum":["INCOMING_TRANSFER","OUTGOING_TRANSFER"],"description":"Transfer Transaction Type"},"TransferCurrencyEnum":{"title":"SepaTransferCurrencyEnum","enum":["EUR"],"description":"Sepa Transfer Currency"}}}}
```

## The TechnicalTransfer object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"TechnicalTransfer":{"title":"TechnicalTransfer","properties":{"transferId":{"type":"string","format":"uuid","description":"Unique transfer identification number in UUID format"},"transferStatus":{"$ref":"#/components/schemas/TransferStatusEnum"},"createdOn":{"type":"string","format":"date-time","description":"The date denoting when the transfer's record was initially created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date indicating the most recent modification made to the transfer's data"},"customerId":{"type":"string","format":"uuid","description":"The identifier of the customer."},"customerProductId":{"type":"string","format":"uuid","description":"Unique customer product identification number in UUID format"},"reference":{"type":"string","maxLength":140,"description":"transfer reference"},"amount":{"type":"number","description":"transfer amount","minimum":0,"exclusiveMinimum":true,"multipleOf":0.01},"transactionType":{"$ref":"#/components/schemas/TransactionTypeEnum"},"currency":{"$ref":"#/components/schemas/TransferCurrencyEnum"}},"required":["transferId","transferStatus","createdOn","modifiedOn","customerId","customerProductId","reference","amount","transactionType"]},"TransferStatusEnum":{"title":"TransferStatusEnum","enum":["RECEIVED","INVALID","PENDING","REJECTED","PROCESSED","RECONCILED"],"description":"Status of the transfer"},"TransactionTypeEnum":{"title":"TransactionTypeEnum","enum":["INCOMING_TRANSFER","OUTGOING_TRANSFER"],"description":"Transfer Transaction Type"},"TransferCurrencyEnum":{"title":"SepaTransferCurrencyEnum","enum":["EUR"],"description":"Sepa Transfer Currency"}}}}
```

## The TransferCompound object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"TransferCompound":{"type":"object","properties":{"transfer":{"$ref":"#/components/schemas/Transfer"},"technicalTransfer":{"$ref":"#/components/schemas/TechnicalTransfer"}}},"Transfer":{"title":"Transfer","properties":{"transferId":{"type":"string","format":"uuid","description":"Unique transfer identification number in UUID format"},"transferStatus":{"$ref":"#/components/schemas/TransferStatusEnum"},"rejectReason":{"type":"string","description":"The reason of the transfer rejection."},"createdOn":{"type":"string","format":"date-time","description":"The date denoting when the transfer's record was initially created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date indicating the most recent modification made to the transfer's data"},"customerId":{"type":"string","format":"uuid","description":"The identifier of the customer."},"customerProductId":{"type":"string","format":"uuid","description":"Unique customer product identification number in UUID format"},"reference":{"type":"string","maxLength":140,"description":"transfer reference"},"name":{"type":"string","maxLength":255,"description":"Receiver name"},"iban":{"type":"string","description":"IBAN code","pattern":"^[A-Z]{2}[0-9A-Z]{14,31}$","maxLength":33},"bic":{"type":"string","description":"BIC (Business Identifier Code) of the receiver bank","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z\\d]{2}(?:[A-Z\\d]{3})?$"},"amount":{"type":"number","description":"transfer amount","minimum":0,"exclusiveMinimum":true,"multipleOf":0.01},"instant":{"type":"boolean","description":"flag indicating if the transfer is an instant transfer","default":false},"externalId":{"type":"string","pattern":"[a-zA-Z0-9]{32,32}","description":"External Id in partner's system for outgoing transfers. This value has to be unique."},"transactionType":{"$ref":"#/components/schemas/TransactionTypeEnum"},"currency":{"$ref":"#/components/schemas/TransferCurrencyEnum"}},"required":["transferId","transferStatus","createdOn","modifiedOn","customerId","customerProductId","reference","name","iban","amount","transactionType"]},"TransferStatusEnum":{"title":"TransferStatusEnum","enum":["RECEIVED","INVALID","PENDING","REJECTED","PROCESSED","RECONCILED"],"description":"Status of the transfer"},"TransactionTypeEnum":{"title":"TransactionTypeEnum","enum":["INCOMING_TRANSFER","OUTGOING_TRANSFER"],"description":"Transfer Transaction Type"},"TransferCurrencyEnum":{"title":"SepaTransferCurrencyEnum","enum":["EUR"],"description":"Sepa Transfer Currency"},"TechnicalTransfer":{"title":"TechnicalTransfer","properties":{"transferId":{"type":"string","format":"uuid","description":"Unique transfer identification number in UUID format"},"transferStatus":{"$ref":"#/components/schemas/TransferStatusEnum"},"createdOn":{"type":"string","format":"date-time","description":"The date denoting when the transfer's record was initially created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date indicating the most recent modification made to the transfer's data"},"customerId":{"type":"string","format":"uuid","description":"The identifier of the customer."},"customerProductId":{"type":"string","format":"uuid","description":"Unique customer product identification number in UUID format"},"reference":{"type":"string","maxLength":140,"description":"transfer reference"},"amount":{"type":"number","description":"transfer amount","minimum":0,"exclusiveMinimum":true,"multipleOf":0.01},"transactionType":{"$ref":"#/components/schemas/TransactionTypeEnum"},"currency":{"$ref":"#/components/schemas/TransferCurrencyEnum"}},"required":["transferId","transferStatus","createdOn","modifiedOn","customerId","customerProductId","reference","amount","transactionType"]}}}}
```

## The Transfers object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"Transfers":{"title":"Transfers","type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/TransferCompound"}},"pagination":{"$ref":"#/components/schemas/Pagination"}},"required":["data","pagination"]},"TransferCompound":{"type":"object","properties":{"transfer":{"$ref":"#/components/schemas/Transfer"},"technicalTransfer":{"$ref":"#/components/schemas/TechnicalTransfer"}}},"Transfer":{"title":"Transfer","properties":{"transferId":{"type":"string","format":"uuid","description":"Unique transfer identification number in UUID format"},"transferStatus":{"$ref":"#/components/schemas/TransferStatusEnum"},"rejectReason":{"type":"string","description":"The reason of the transfer rejection."},"createdOn":{"type":"string","format":"date-time","description":"The date denoting when the transfer's record was initially created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date indicating the most recent modification made to the transfer's data"},"customerId":{"type":"string","format":"uuid","description":"The identifier of the customer."},"customerProductId":{"type":"string","format":"uuid","description":"Unique customer product identification number in UUID format"},"reference":{"type":"string","maxLength":140,"description":"transfer reference"},"name":{"type":"string","maxLength":255,"description":"Receiver name"},"iban":{"type":"string","description":"IBAN code","pattern":"^[A-Z]{2}[0-9A-Z]{14,31}$","maxLength":33},"bic":{"type":"string","description":"BIC (Business Identifier Code) of the receiver bank","minLength":8,"maxLength":11,"pattern":"^[A-Z]{6}[A-Z\\d]{2}(?:[A-Z\\d]{3})?$"},"amount":{"type":"number","description":"transfer amount","minimum":0,"exclusiveMinimum":true,"multipleOf":0.01},"instant":{"type":"boolean","description":"flag indicating if the transfer is an instant transfer","default":false},"externalId":{"type":"string","pattern":"[a-zA-Z0-9]{32,32}","description":"External Id in partner's system for outgoing transfers. This value has to be unique."},"transactionType":{"$ref":"#/components/schemas/TransactionTypeEnum"},"currency":{"$ref":"#/components/schemas/TransferCurrencyEnum"}},"required":["transferId","transferStatus","createdOn","modifiedOn","customerId","customerProductId","reference","name","iban","amount","transactionType"]},"TransferStatusEnum":{"title":"TransferStatusEnum","enum":["RECEIVED","INVALID","PENDING","REJECTED","PROCESSED","RECONCILED"],"description":"Status of the transfer"},"TransactionTypeEnum":{"title":"TransactionTypeEnum","enum":["INCOMING_TRANSFER","OUTGOING_TRANSFER"],"description":"Transfer Transaction Type"},"TransferCurrencyEnum":{"title":"SepaTransferCurrencyEnum","enum":["EUR"],"description":"Sepa Transfer Currency"},"TechnicalTransfer":{"title":"TechnicalTransfer","properties":{"transferId":{"type":"string","format":"uuid","description":"Unique transfer identification number in UUID format"},"transferStatus":{"$ref":"#/components/schemas/TransferStatusEnum"},"createdOn":{"type":"string","format":"date-time","description":"The date denoting when the transfer's record was initially created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date indicating the most recent modification made to the transfer's data"},"customerId":{"type":"string","format":"uuid","description":"The identifier of the customer."},"customerProductId":{"type":"string","format":"uuid","description":"Unique customer product identification number in UUID format"},"reference":{"type":"string","maxLength":140,"description":"transfer reference"},"amount":{"type":"number","description":"transfer amount","minimum":0,"exclusiveMinimum":true,"multipleOf":0.01},"transactionType":{"$ref":"#/components/schemas/TransactionTypeEnum"},"currency":{"$ref":"#/components/schemas/TransferCurrencyEnum"}},"required":["transferId","transferStatus","createdOn","modifiedOn","customerId","customerProductId","reference","amount","transactionType"]},"Pagination":{"title":"Pagination","type":"object","properties":{"cursor":{"type":"string","description":"String value used for pagination, which should be set in next page request."},"limit":{"type":"integer","description":"Maximum number of returned items"}},"required":["cursor","limit"]}}}}
```

## The TransferStatusEnum object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"TransferStatusEnum":{"title":"TransferStatusEnum","enum":["RECEIVED","INVALID","PENDING","REJECTED","PROCESSED","RECONCILED"],"description":"Status of the transfer"}}}}
```

## The TransferMetadata object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"TransferMetadata":{"title":"TransferMetadata","type":"object","properties":{"transferId":{"type":"string","format":"uuid","description":"Unique transfer identification number in UUID format"},"transferStatus":{"$ref":"#/components/schemas/TransferStatusEnum"},"rejectReason":{"type":"string","description":"The reason of the transfer rejection."},"customerId":{"type":"string","format":"uuid","description":"The identifier of the customer."},"customerProductId":{"type":"string","format":"uuid","description":"Unique customer product identification number in UUID format"},"reference":{"type":"string","maxLength":140,"description":"transfer reference"},"amount":{"type":"number","description":"transfer amount","minimum":0,"exclusiveMinimum":true,"multipleOf":0.01},"currency":{"$ref":"#/components/schemas/CurrencyEnum"},"externalId":{"type":"string","pattern":"[a-zA-Z0-9]{32,32}","description":"External Id in partner's system. This value has to be unique."},"createdOn":{"type":"string","format":"date-time","description":"The date denoting when the transfer's record was initially created"},"modifiedOn":{"type":"string","format":"date-time","description":"The date indicating the most recent modification made to the transfer's data"}},"required":["transferId","transferStatus","customerId","customerProductId","reference","amount","currency","externalId","createdOn","modifiedOn"]},"TransferStatusEnum":{"title":"TransferStatusEnum","enum":["RECEIVED","INVALID","PENDING","REJECTED","PROCESSED","RECONCILED"],"description":"Status of the transfer"},"CurrencyEnum":{"title":"CurrencyEnum","type":"string","description":"Currency of the product's balance. Currency code in ISO 4217","enum":["EUR"]}}}}
```

## The TransferCurrencyEnum object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"TransferCurrencyEnum":{"title":"SepaTransferCurrencyEnum","enum":["EUR"],"description":"Sepa Transfer Currency"}}}}
```

## The TransactionTypeEnum object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"TransactionTypeEnum":{"title":"TransactionTypeEnum","enum":["INCOMING_TRANSFER","OUTGOING_TRANSFER"],"description":"Transfer Transaction Type"}}}}
```

## The CreateTestIncomingPaymentData object

```json
{"openapi":"3.0.1","info":{"title":"Transfers","version":"1.0"},"components":{"schemas":{"CreateTestIncomingPaymentData":{"title":"CreateTestIncomingPaymentData","properties":{"customerProductId":{"type":"string","format":"uuid","description":"Unique customer product identification number in UUID format"},"amount":{"type":"number","description":"transfer amount","minimum":0,"exclusiveMinimum":true,"multipleOf":0.01},"reference":{"type":"string","maxLength":140,"description":"transfer reference"}},"required":["customerProductId","amount","reference"]}}}}
```