Download OpenAPI specification:
Endpoint used to create staff User.
| email required | string <email> |
| white-label required | string [ 5 .. 100 ] characters |
{- "email": "user@example.com",
- "white-label": "string"
}{- "message": "Invite sent to the user's email address."
}Endpoint is used for login
| username required | string |
| password required | string >= 8 characters |
| white-label required | string [ 2 .. 100 ] characters |
{- "username": "user@example.com",
- "password": "Password123",
- "white-label": "client-app"
}{- "message": "Successful Login"
}Endpoint used to change password.
| username required | string |
| currentPassword required | string [ 8 .. 15 ] characters |
| newPassword required | string [ 12 .. 15 ] characters ^(?=.*[A-Z].*[A-Z])(?=.*[!@#$&*].*[!@#$&*])(?... |
| white-label required | string <uri-template> [ 2 .. 100 ] characters |
{- "username": "string",
- "currentPassword": "stringst",
- "newPassword": "stringstring",
}{ }Endpoint used to create wallet user.
| birthdate required | string <date> |
| country required | string Enum: "Chad" "Estonia" "Ethiopia" "Falkland Islands (Malvinas)" "Faroe Islands" "Fiji" "Finland" "France" "French Guiana" "French Polynesia" "French Southern Territories" "Gabon" "Gambia" "Georgia" "Germany" "Ghana" "Gibraltar" "Greece" "Greenland" "Grenada" "Guadeloupe" "Guam" "Guatemala" "Guernsey" "Guinea" "Guinea-Bissau" "Guyana" "Haiti" "Heard and Mcdonald Islands" "Holy See (Vatican City State)" "Honduras" "Hungary" "Iceland" "India" "Indonesia" "Iran, Islamic Republic of" "Iraq" "Ireland" "Isle of Man" "Israel" "Italy" "Ivory Coast" "Jamaica" "Japan" "Jersey" "Jordan" "Kazakhstan" "Kenya" "Kiribati" "North Korea" "South Korea" "Kuwait" "Kyrgyzstan" "Lao PDR" "Latvia" "Lebanon" "Lesotho" "Liberia" "Libya" "Liechtenstein" "Lithuania" "Luxembourg" "Macedonia, Republic of" "Madagascar" "Malawi" "Malaysia" "Maldives" "Mali" "Malta" "Marshall Islands" "Martinique" "Mauritania" "Mauritius" "Mayotte" "Mexico" "Micronesia, Federated States of" "Moldova" "Monaco" "Mongolia" "Montenegro" "Montserrat" "Morocco" "Mozambique" "Myanmar" "Namibia" "Nauru" "Nepal" "Netherlands" "Netherlands Antilles" "New Caledonia" "New Zealand" "Cape Verde" "Cayman Islands" "Central African Republic" "Chile" "China" "Hong Kong, SAR China" "Macao, SAR China" "Christmas Island" "Cocos (Keeling) Islands" "Colombia" "Comoros" "Congo (Brazzaville)" "Congo, (Kinshasa)" "Cook Islands" "Costa Rica" "Croatia" "Cuba" "Cyprus" "Czech Republic" "Denmark" "Djibouti" "Dominica" "Dominican Republic" "Ecuador" "Egypt" "El Salvador" "Equatorial Guinea" "Eritrea" "Nicaragua" "Niger" "Nigeria" "Niue" "Afghanistan" "Aland Islands" "Albania" "Algeria" "Burkina Faso" "Burundi" "Cambodia" "Cameroon" "Canada" "Norfolk Island" "Northern Mariana Islands" "Norway" "Oman" "Sri Lanka" "Sudan" "Suriname" "Svalbard and Jan Mayen Islands" "Swaziland" "Sweden" "Switzerland" "Syria" "Taiwan, Republic of China" "Tajikistan" "Tanzania, United Republic of" "Thailand" "Timor-Leste" "Togo" "Tokelau" "American Samoa" "Andorra" "Angola" "Anguilla" "Antarctica" "Antigua and Barbuda" "Argentina" "Armenia" "Aruba" "Australia" "Austria" "Azerbaijan" "Bahamas" "Bahrain" "Bangladesh" "Barbados" "Belarus" "Belgium" "Belize" "Benin" "Bermuda" "Bhutan" "Bolivia" "Bosnia and Herzegovina" "Botswana" "Bouvet Island" "Brazil" "British Virgin Islands" "British Indian Ocean Territory" "Brunei Darussalam" "Bulgaria" "Tonga" "Trinidad and Tobago" "Tunisia" "Turkey" "Turkmenistan" "Turks and Caicos Islands" "Tuvalu" "Uganda" "Peru" "Ukraine" "United Arab Emirates" "United States of America" "US Minor Outlying Islands" "Uruguay" "Uzbekistan" "Vanuatu" "Venezuela" "Viet Nam" "Virgin Islands, US" "Wallis and Futuna Islands" "Western Sahara" "Yemen" "Zambia" "Zimbabwe" "United States" "Pakistan" "Palau" "Palestinian Territory" "Panama" "Papua New Guinea" "Paraguay" "Philippines" "Pitcairn" "Poland" "Portugal" "Puerto Rico" "Qatar" "Reunion" "Romania" "Russian Federation" "Rwanda" "Saint Barthelemy" "Saint Helena" "Saint Kitts and Nevis" "Saint Lucia" "Saint-Martin (French part)" "Saint Pierre and Miquelon" "Saint Vincent and Grenadines" "Samoa" "San Marino" "Sao Tome and Principe" "Saudi Arabia" "Senegal" "Serbia" "Seychelles" "Sierra Leone" "Singapore" "Slovakia" "Slovenia" "Solomon Islands" "Somalia" "South Africa" "South Georgia and the South Sandwich Islands" "South Sudan" "Spain" "United States Minor Outlying Islands" "United Kingdom" "Hong Kong" "Curacao" |
| email required | string <email> |
| phone required | string^[+][0-9]{1,15}$ |
| white-label required | string <uri> |
| city required | string [ 2 .. 35 ] characters |
| state required | string [ 2 .. 35 ] characters |
| zip_code required | string [ 2 .. 35 ] characters |
| first_name required | string [ 2 .. 35 ] characters |
| middle_name required | string |
| last_name required | string [ 2 .. 35 ] characters |
| address_1 required | string [ 2 .. 35 ] characters |
| address_2 | string |
| occupation | string [ 2 .. 35 ] characters |
| gender required | string Enum: "male" "female" "unknown" |
{- "birthdate": "2019-08-24",
- "country": "Chad",
- "email": "user@example.com",
- "phone": "string",
- "city": "string",
- "state": "string",
- "zip_code": "string",
- "first_name": "string",
- "middle_name": "string",
- "last_name": "string",
- "address_1": "string",
- "address_2": "string",
- "occupation": "string",
- "gender": "male"
}{ }Endpoint used to change card status.
| currentProfile | string |
| entityId required | number |
required | object |
{- "currentProfile": "string",
- "entityId": 0,
- "entityDetail": {
- "country": "Chad",
- "parentOrg": "string",
- "regNumber": "string",
- "tinNumber": "string",
- "companyUrl": "string",
- "whiteLabel": "string",
- "companyName": "string",
- "phoneNumber": "string",
- "tradingName": "string",
- "companyEmail": "string",
- "address": {
- "registrationAddress": {
- "regAddress1": "string",
- "regAddress2": "string",
- "regCountry": "string",
- "regState": "string",
- "regPostCode": "string",
- "regCity": "string"
}, - "businessAddress": {
- "businessAddress1": "string",
- "businessAddress2": "string",
- "businessCountry": "string",
- "businessState": "string",
- "businessPostCode": "string",
- "businessCity": "string"
}
}, - "additionalInfo": {
- "companyStatus": "Public Limited Company (PLC)",
- "businessSectors": [
- "Finance"
], - "leiNumber": "string",
- "vatNumber": "string",
- "frnNumber": "string"
}, - "shareholders": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "shareholderType": "individual",
- "dateOfBirth": "string"
}
], - "directors": [
- {
- "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f",
- "directorType": "individual",
- "dateOfBirth": "string"
}
]
}
}{ }Endpoint used to add KYB Document.
| documentName required | string |
| issueOrExpiryDate required | string^[0-9]{4}-[0-9]{2}-[0-9]{2}$ |
| documentDescription | string |
| documentString required | string |
| fileType | integer Enum: 0 1 2 3 4 5 |
{- "documentName": "string",
- "issueOrExpiryDate": "string",
- "documentDescription": "string",
- "documentString": "string",
- "fileType": 0
}{ }a new account group in the system.
| groupName | string |
| groupCode | string |
{- "groupName": "Retail Customers",
- "groupCode": "RC001"
}{ }Creates a new account group in the system.
| ibanList required | Array of strings non-empty [ items^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$ ] |
| accountGroupName required | string [ 2 .. 50 ] characters |
{- "ibanList": [
- "string"
], - "accountGroupName": "string"
}{ }Endpoint used to create account staff group mapping.
| accountGroupUserGroupName required | string [ 2 .. 50 ] characters ^[a-zA-Z0-9._-]+$ |
| accountGroupName required | string [ 2 .. 50 ] characters |
| userGroupName required | Array of strings |
{- "accountGroupUserGroupName": "string",
- "accountGroupName": "string",
- "userGroupName": [
- "string"
]
}{ }Endpoint used to extend account group.
| ibanList required | Array of strings non-empty [ items^[A-Z]{2}[0-9]{2}[A-Z0-9]{1,30}$ ] |
| accountGroupName required | string [ 2 .. 50 ] characters |
{- "ibanList": [
- "string"
], - "accountGroupName": "string"
}{ }Endpoint used to create corporate entity.
| companyName required | string [ 2 .. 50 ] characters |
| companyEmail required | string <email> |
| tradingName required | string [ 2 .. 50 ] characters |
| tinNumber | string [ 2 .. 15 ] characters |
| regNumber required | string [ 2 .. 15 ] characters |
| phoneNumber required | string [ 7 .. 15 ] characters |
| country required | string [ 2 .. 50 ] characters |
| companyUrl | string <uri-template> |
| whiteLabel required | string <uri-template> [ 2 .. 100 ] characters |
| entityType required | string [ 2 .. 15 ] characters Value: "corporate" |
{- "companyName": "string",
- "companyEmail": "user@example.com",
- "tradingName": "string",
- "tinNumber": "string",
- "regNumber": "string",
- "phoneNumber": "strings",
- "country": "string",
- "entityType": "corporate"
}{ }Endpoint used to create corporate staff.
| email required | string <email> |
| white-label required | string <uri-template> [ 2 .. 100 ] characters |
| corporate_id required | number |
{- "email": "user@example.com",
- "corporate_id": 0
}{ }Endpoint used to create IBANRequest.
| accountName required | string |
| currencyName required | string |
| providerId required | integer |
| entityId required | integer |
| isWalletUser | boolean |
| username | string |
{- "accountName": "string",
- "currencyName": "string",
- "providerId": 0,
- "entityId": 0,
- "isWalletUser": true,
- "username": "string"
}{ }| paymentMethod required | string [ 2 .. 50 ] characters Value: "SEPA-SCT" |
| fromAccountIBAN required | string [ 2 .. 50 ] characters |
| recipientName required | string [ 2 .. 140 ] characters |
| toAccountIBAN required | string [ 2 .. 50 ] characters |
| toBicCode required | string [ 7 .. 15 ] characters |
| paymentReference required | string [ 2 .. 35 ] characters |
| amount required | number |
{- "paymentMethod": "SEPA-SCT",
- "fromAccountIBAN": "string",
- "recipientName": "string",
- "toAccountIBAN": "string",
- "toBicCode": "strings",
- "paymentReference": "string",
- "amount": 0
}{ }Endpoint used to create payment GBP.
| paymentMethod | string [ 3 .. 15 ] characters Enum: "FPS" "CHAPS" |
| fromAccountNumber required | string = 8 characters |
| fromSortCode required | string = 6 characters |
| recipientName required | string [ 1 .. 140 ] characters |
| toAccountNumber required | string = 8 characters |
| toSortCode required | string = 6 characters |
| type | string Enum: "Personal" "Business" |
| paymentReference required | string [ 1 .. 35 ] characters |
| bankName required | string [ 1 .. 140 ] characters |
| amount required | number |
| beneficiaryCity | string [ 1 .. 140 ] characters |
| beneficiaryState | string [ 1 .. 140 ] characters |
{- "paymentMethod": "FPS",
- "beneficiaryCity": "string",
- "beneficiaryState": "string",
- "fromAccountNumber": "stringst",
- "fromSortCode": "string",
- "recipientName": "string",
- "toAccountNumber": "stringst",
- "toSortCode": "string",
- "type": "Personal",
- "paymentReference": "string",
- "bankName": "string",
- "amount": 0
}Endpoint used to create payment SWIFT.
| paymentMethod required | string [ 2 .. 50 ] characters Value: "SWIFT" |
| fromAccountIBAN required | string [ 2 .. 50 ] characters |
| toAccountIBAN required | string [ 2 .. 50 ] characters |
| currency required | string = 3 characters |
| type required | string [ 1 .. 15 ] characters |
| paymentReference required | string [ 1 .. 140 ] characters |
| amount required | number |
| beneficiaryName required | string [ 2 .. 140 ] characters |
| beneficiaryAddr1 required | string [ 2 .. 70 ] characters |
| beneficiaryCity required | string [ 2 .. 35 ] characters |
| beneficiaryState required | string [ 2 .. 35 ] characters |
| beneficiaryCountry required | string [ 2 .. 100 ] characters |
| beneficiaryPostCode required | string [ 2 .. 25 ] characters |
| beneficiaryBankName required | string [ 2 .. 140 ] characters |
| beneficiaryBankCodeType required | string [ 2 .. 25 ] characters Enum: "BIC" "ABA" |
| beneficiaryBankCode required | string [ 2 .. 25 ] characters |
{- "paymentMethod": "SWIFT",
- "fromAccountIBAN": "string",
- "toAccountIBAN": "string",
- "currency": "str",
- "type": "string",
- "paymentReference": "string",
- "amount": 0,
- "beneficiaryName": "string",
- "beneficiaryAddr1": "string",
- "beneficiaryCity": "string",
- "beneficiaryState": "string",
- "beneficiaryCountry": "string",
- "beneficiaryPostCode": "string",
- "beneficiaryBankName": "string",
- "beneficiaryBankCodeType": "BIC",
- "beneficiaryBankCode": "string"
}{ }