Veengu API provides key methods and attributes for managing a digital financial service by Tenants (service providers).
Also as a part of tenant onboarding, Veengu assignes an unique string code for the Tenant. You should always send your code in v-tenant
header.
#
Note your API keys carry many privileges, so be sure to keep them secure! Do not share your API keys in publicly accessible areas such as GitHub, client-side code, and so forth.
#
All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.
Veengu Access Token is JSON Web Token (JWT, tools.ietf.org). It consists of three concatenated Base64url-encoded strings, separated by dots .
:
Header: contains metadata about the type of the token and cryptographic algorithms used to secure its contents.
Payload: contains verifiable security statements, such as an identity of the user and permissions they are allowed.
Signature: used to validate that the token is trustworthy and has not been tampered with.
Each API request has an associated request identifier. You can find this value in response headers, under V-Request-Id
. If you need to contact us about a specific request, providing the request identifier will ensure the fastest possible resolution.
All dates in the JSON payloads are represented in ISO 8601 date-time format. All date-time fields in responses must include the timezone. You can find more information on Veengu Developer Guide API Overview.
To get transaction created date in customer local time you use createdAt
attribute in transaction response and transaction history.
During transaction initiation you can define transaction local timezone on application client site with sending localUTCOffset
attribute as an offset of user mobile device with the locale time zone in ISO 8601 as an offset from UTC formats:
In case localUTCOffset
attribute is not specified in transaction request Veengu processing core stores and responses createdAt
value as server time with Tenant timezone defines in settings.
All money in API defined as amount object with mandatory fields value and currency. Currency should be present as currency code in ISO 4217 alfa-3 format. The value field should be present as the float number of monetary units specified in an appropriate currency. Field pattern applies based on currency ISO 4217 definition.
When we make backwards-incompatible changes to the API, we release new, dated versions. The current version is 2.X.Y. Read our API changelog to learn more about backwards compatibility. Some versions could be deprecated which means you cannot choose this version in API settings and all requests return an API format error. To set the API version for a specific request use V-Version header. As a precaution, use API versioning to test a new API version before committing to an upgrade.
For error handling Veengu uses conventional HTTP response codes to indicate success or failure of an API request. In general, error codes in the 2xx
range indicate success. Codes in the 4xx
range indicate errors that failed given the information provided (e.g., a required parameter is missing, a failed transaction, etc.). Codes in the 5xx
range indicate errors with Veengu servers (these are rare).
Some 4xx
errors that could be handled programmatically (e.g., a transaction is declined) include an error code that briefly explains the error reported.
HTTP code | description |
---|---|
200 | Request processed successfully. |
201 | Request processed successfully. |
400 | The request cannot be not accepted, often due to missing a required parameter. |
401 | Not authenticated |
402 | The parameters were valid but the request failed. |
403 | The API key doesn't have permissions to perform the request. |
404 | The requested resource does not exist. |
409 | The request is conflicting with another request (perhaps due to using the same idempotent key) |
429 | Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. |
500 | Something went wrong on Veengu's end. (These are rare.) |
504 | Where an API is deprecated and no longer operationally supported by an Veengu. |
The Veengu API implements cursor-based pagination via the next
and prev
parameters. Both parameters take a unique key element that identifies the next or previous page. The prev
parameter returns objects listed before the current page. The next
parameter returns objects listed after the current page. Only one parameter next
or prev
should be used in the request. If both parameters are provided, only next
is used.
The returned object includes cursor object with next
/prev
parameters if there are more objects (for example, transactions) than the defined limit value in response. If the objects list fits in one page cursor object is empty.
All top-level API resources have support request to get object list via API methods. For instance, you can get customers, accounts, and transactions. These API methods share a common structure, taking at least these three parameters: limit
, next
and prev
.
The following parameters shall be provided to create a new Individual Customer profile with account:
For creating a new Business Customer account, the following setup parameters should be provided:
Retrieves solution-specific parameters
{- "countries": [
- {
- "id": "RS",
- "name": "Serbia",
- "tableData": {
- "id": 0
}, - "nameLocalized": "Serbia",
- "firstDayOfWeek": "SU",
- "businessLegalTypes": [
- {
- "name": "LLC",
- "documents": [
- {
- "type": "Authorized representative Identity Card",
- "primary": true,
- "mandatory": false,
- "pageNames": [ ],
- "parameters": [
- {
- "name": "number",
- "type": "number",
- "mandatory": true,
- "tableData": {
- "id": 0
}
}, - {
- "name": "dateOfIssue",
- "type": "date",
- "mandatory": true,
- "tableData": {
- "id": 1
}
}
]
}, - {
- "type": "Authorized representative passport",
- "primary": false,
- "mandatory": false,
- "tableData": {
- "id": 1
}, - "parameters": [
- {
- "name": "number",
- "type": "number",
- "mandatory": true,
- "tableData": {
- "id": 0
}
}, - {
- "mask": "",
- "name": "establishmentDate",
- "type": "date",
- "mandatory": true,
- "tableData": {
- "id": 1
}
}
]
}
], - "tableData": {
- "id": 0
}
}
], - "individualDocuments": [
- {
- "type": "National ID card",
- "pageNames": [
- "FIRST"
], - "tableData": {
- "id": 0
}, - "parameters": [
- {
- "mask": "",
- "name": "number",
- "type": "text",
- "mandatory": true,
- "tableData": {
- "id": 0
}
}, - {
- "name": "dateOfIssue",
- "type": "date",
- "mandatory": true,
- "tableData": {
- "id": 1
}
}
]
}
]
}
], - "kycLevels": [
- {
- "id": "verified",
- "name": "Verified",
- "priority": 200,
- "tableData": {
- "id": 1
}
}, - {
- "id": "basic",
- "name": "Non-Verified User",
- "priority": 100,
- "tableData": {
- "id": 0
}
}
], - "currencies": [
- {
- "id": "USD",
- "name": "US Dollar",
- "tableData": {
- "id": 0
}
}
], - "industries": [
- {
- "id": 1,
- "name": "Financial Services",
- "tableData": {
- "id": 0
}
}
], - "localizations": [
- {
- "id": "en-US",
- "name": "English",
- "tableData": {
- "id": 0
}
}
], - "merchantCategoryCodes": [
- {
- "id": 6011,
- "name": "Cash withdrawal",
- "tableData": {
- "id": 0
}
}
]
}
Retrieves country-specific parameters
id required | string country code |
{- "id": "AE",
- "name": "United Arab Emirates",
- "nameLocalized": "لإمارات العربية المتحدة",
- "businessLegalTypes": [
- {
- "name": "LTD",
- "documents": [
- {
- "type": "businessLicense",
- "primary": true,
- "mandatory": true,
- "parameters": [
- {
- "name": "NUMBER",
- "format": "[0-9].{8}",
- "mandatory": true
}, - {
- "name": "DATE_OF_ISSUE",
- "format": "DD-MM-YY",
- "mandatory": false
}, - {
- "name": "DATE_OF_EXPIRY",
- "format": "MMYY",
- "mandatory": true
}
]
}
]
}
], - "individualDocuments": [
- {
- "type": "passport",
- "pageNames": [
- "firstPage",
- "secondPage"
]
}
]
}
Define or change the user password. To set a password use V-Access-Token
received by sms or/and email OTP authentication and skip oldPassword
field.
newPassword required | string |
oldPassword | string |
{- "newPassword": "kxpworyewh234423",
- "oldPassword": "kxpworyewh234423"
}
Define or change the user secret word. To set a secret word use V-Access-Token
received by sms or/and email OTP authentication and skip oldSecretWord
field.
newSecretWord required | string |
oldSecretWord | string |
{- "newSecretWord": "secret",
- "oldSecretWord": "oldsecret"
}
As for now we allow only one key for one identity. Multiple keys may be allowed lately. Only tweetnacl
key type is supported.
keyType required | string <base64> |
key required | string |
required | object (device) |
{- "keyType": "tweetnacl",
- "key": "a6d735273f96",
- "device": {
- "applicationId": "com.veengu.pos",
- "applicationIdForVendor": "dd96dec43fb81c97",
- "deviceLabel": "CN-34857-S10",
- "osName": "Android",
- "osVersion": "10.0.1",
- "enrolledAt": "2019-08-24T14:15:22Z",
- "pushToken": "string",
- "details": "string"
}
}
{- "keyId": "1a76a6a8-c706-44b3-b008-a6d735273f96"
}
Upon logout mobile application should delete and clear its authentication key and push token.
id required | string An authentication key ID |
{- "keyId": "1a76a6a8-c706-44b3-b008-a6d735273f96"
}
User can have several identities, for example, user has individual wallet and employee account in business wallet.
{- "emailAddress": "sival14584@soowz.com",
- "username": "sival14584@soowz.com",
- "hasPassword": true,
- "name": "Kate Maison",
- "phoneNumber": "+447930954405",
- "roles": {
- "property1": [
- "BUSINESS_MANAGER",
- "BUSINESS_ADMINISTRATOR"
], - "property2": [
- "BUSINESS_MANAGER",
- "BUSINESS_ADMINISTRATOR"
]
}
}
First step for authentication by one-time password delivered by sms
phoneNumber | string |
{- "phoneNumber": "+44987654321"
}
{- "challengeToken": "45603924-194d-4b47-b6be-1e0705b5218b"
}
One-time password verification
challengeToken required | string |
otp required | string |
name | string |
{- "challengeToken": "45603924-194d-4b47-b6be-1e0705b5218b",
- "otp": "96240",
- "name": "David James"
}
First step for authentication by one-time password delivered by email
email required | string |
name | string |
{- "email": "gfbriemann@superpay.com",
- "name": "Georg Friedrich Bernhard"
}
{- "challengeToken": "45603924-194d-4b47-b6be-1e0705b5218b"
}
One-time password verification.
challengeToken required | string |
otp required | string |
{- "challengeToken": "45603924-194d-4b47-b6be-1e0705b5218b",
- "otp": "96240"
}
Begin key challenge
keyId | string |
object (device) |
{- "keyId": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "device": {
- "applicationId": "com.veengu.pos",
- "applicationIdForVendor": "dd96dec43fb81c97",
- "deviceLabel": "CN-34857-S10",
- "osName": "Android",
- "osVersion": "10.0.1",
- "enrolledAt": "2019-08-24T14:15:22Z",
- "pushToken": "string",
- "details": "string"
}
}
{- "challengeToken": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "challengeData": "1a76a6a8-c706-44b3-b008-a6d735273f96"
}
Authenticate with key
challengeToken | string |
signedChallengeData | string |
{- "challengeToken": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "signedChallengeData": "1a76a6a8-c706-44b3-b008-a6d735273f96"
}
Authentication by static password
username required | string A user login assigned by the Platform depending on a user registration flow |
password required | string A user password. For an employee, it is a five digits Access code provided by a manager via the Business Portal or Customer Support or delivered to a personal phone number via SMS. |
{- "username": "45603924-194d-4b47-b6be-1e0705b5218b",
- "password": "12345"
}
Retrieves profiles list for authenticated user.
[- {
- "id": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "type": "INDIVIDUAL",
- "title": "Leonhard Euler",
- "solutionId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "solutionName": "Consumer Wallet",
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "roles": "INDIVIDUAL",
- "features": {
- "veengu_individual_profile": { }
}
}
]
Retrieves profile limits for authenticated user.
id required | string The ID of the profile |
[- {
- "id": "d12fc044-4757-4aa5-9d23-fe9bcdde244a",
- "name": "Single remittance",
- "type": "SINGLE_AMOUNT",
- "editable": false,
- "active": true,
- "owner": {
- "type": "PROFILE",
- "id": "b116086b-0411-41b0-a35b-2605ecc9a1ec"
}, - "singleAmount": {
- "currency": "AED",
- "value": 5000
}
}, - {
- "id": "f1cffb05-ae90-47ce-8449-d9d1d543f491",
- "name": "Remittance daily",
- "type": "VELOCITY_CONTROL",
- "editable": false,
- "active": true,
- "owner": {
- "type": "PROFILE",
- "id": "b116086b-0411-41b0-a35b-2605ecc9a1ec"
}, - "velocityControl": {
- "amount": {
- "currency": "AED",
- "value": 5000
}, - "window": {
- "length": "P1D",
- "dateFrom": "2021-11-02T00:00:00Z",
- "dateTo": "2021-11-02T23:59:59.999999999Z",
- "amount": {
- "currency": "AED",
- "value": 0
}
}
}
}, - {
- "id": "182a6835-bb8c-4b54-b3fd-cb665589d24d",
- "name": "Remittance per month",
- "type": "VELOCITY_CONTROL",
- "editable": false,
- "active": true,
- "owner": {
- "type": "PROFILE",
- "id": "b116086b-0411-41b0-a35b-2605ecc9a1ec"
}, - "velocityControl": {
- "amount": {
- "currency": "AED",
- "value": "25000"
}, - "window": {
- "length": "P30D",
- "dateFrom": "2021-11-01T00:00:00Z",
- "dateTo": "2021-11-30T23:59:59.999999999Z",
- "amount": {
- "currency": "AED",
- "value": "0"
}
}
}
}
]
[- {
- "id": "71ea79e0-ff77-4fd9-9494-6c32f4d785a1",
- "solutionId": "6ea5263a-0226-4281-b71f-c10cf2d68eb8",
- "businessId": "322fcf3d-c210-49d0-9aa3-4da01ef21d9e",
- "name": "Head Office",
- "status": "ACTIVE",
- "createdAt": "2021-04-07T10:44:44.740175Z",
- "deleted": false,
- "address": {
- "city": "Harare",
- "region": "Mashonaland",
- "country": "RS",
- "postalCode": 10001,
- "addressLine": "15 Shortheath Road Chisipite"
}, - "merchantCategoryCode": 6011
}, - {
- "id": "e0f2821b-f955-478d-ace5-bf5ab4e9e750",
- "solutionId": "6ea5263a-0226-4281-b71f-c10cf2d68eb8",
- "businessId": "807219ed-7870-4b63-93e9-9f81ce3a37d9",
- "name": "John Dow",
- "status": "ACTIVE",
- "createdAt": "2021-04-07T10:44:47.252152Z",
- "deleted": false,
- "branding": {
- "icon": {
- "id": "97f10788-157d-42cf-bf11-aa2646613225",
- "name": "payment-providers.png",
- "mimeType": "image/png"
}, - "photos": [
- {
- "id": "a05b06ae-5ccb-439f-a5d7-6dcfd8afa14a",
- "name": "payment-providers.png",
- "mimeType": "image/png"
}, - {
- "id": "fcffa8f5-4056-4947-aabf-e55030e44333",
- "name": "BLOCKED.svg",
- "mimeType": "image/svg+xml"
}, - {
- "id": "f1e99484-3626-4b27-ae44-1861c3709990",
- "name": "close.svg",
- "mimeType": "image/svg+xml"
}
]
}, - "address": {
- "city": "London",
- "region": "England",
- "country": "RS",
- "postalCode": 2225447,
- "addressLine": "George prince st.",
- "geolocation": {
- "latitude": -17.7862458,
- "longitude": 31.1160001
}, - "cityLocalized": "London",
- "note": "Note"
}, - "schedule": {
- "MO": {
- "workingHours": [
- {
- "to": "08:07",
- "from": "03:03"
}, - {
- "to": "14:14",
- "from": "14:09"
}, - {
- "to": "19:00",
- "from": "14:17"
}
]
}
}, - "merchantCategoryCode": 6011
}
]
Uploads files, for example user avatar or business logo
mimeType | string |
data required | string <binary> |
name | string |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Retrieves files by id
id required | string file id |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Creates a new individual customer profile with specified phone number within Tenant's space. New account will be created if default product is configured in Onboarding feature of the specified Solution. Phone number shall not be used yet by another individual profile within the same Tenant space.
id | string <uuid> Profile identifier |
phoneNumber required | string Individual consumer phone number |
solutionId required | string <uuid> Solution id should be specified for individual customer on-boarding |
country | string Individual consumer address Country in ISO 3166-1 alpha-2 . Value from country handbook. |
firstName | string Individual consumer First name |
lastName | string Individual consumer Last name |
addNames | Array of strings |
birthDate | string <date> Individual consumer date of birth |
gender | string Enum: "MALE" "FEMALE" Individual consumer gender |
status | string Enum: "ACTIVE" "BLOCKED" Individual consumer status |
Array of objects | |
object (file) | |
kycLevel | string Individual consumer KYC level. Tenant's handbook could be customized by Veengu team. |
kycStatus | string Individual consumer KYC state defines the current state of a user KYC process |
kycState | string Individual consumer KYC state defines the current state of a user KYC process |
Array of objects (document) | |
object (address) | |
object [ 0 .. 10 ] properties Any other extra profile properties may appear in this section |
{- "phoneNumber": "+441234563421",
- "solutionId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "country": "AE",
- "firstName": "Leonhard",
- "lastName": "Euler",
- "birthDate": "1983-09-18",
- "gender": "MALE"
}
{- "lastName": "Euler",
- "firstName": "Leonhard",
- "kycLevel": "basic",
- "phoneNumber": "+441234563421",
- "gender": "MALE",
- "createdAt": "2020-03-10T12:45:02+02:00",
- "solutionId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "country": "AE",
- "id": "95e656f0-68d7-475f-9429-f7a6e0263ad4",
- "status": "ACTIVE"
}
Retrieves full individual profile data by individual customer id.
id required | string individual profile id |
{- "id": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "phoneNumber": "+441234563421",
- "solutionId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "country": "AE",
- "firstName": "Leonhard",
- "lastName": "Euler",
- "addNames": [
- "string"
], - "birthDate": "1983-09-18",
- "gender": "MALE",
- "status": "ACTIVE",
- "contacts": [
- {
- "channel": "EMAIL",
- "id": "leonardE@gmail.com"
}
], - "icon": {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}, - "kycLevel": "basic",
- "kycStatus": "ACTIVE",
- "kycState": "VERIFIED",
- "documents": [
- {
- "number": "string",
- "type": "string",
- "dateOfExpiry": "2019-08-24",
- "dateOfIssue": "2019-08-24",
- "files": [
- {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}
], - "additionalProperties": {
- "placeOfIssue": "CA, USA"
}
}
], - "address": {
- "country": "AE",
- "region": "string",
- "city": "Dubai",
- "cityLocalized": "دبي",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "building": "Burj Khalifa",
- "note": "the tallest structure and building in the world",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727",
- "plusCode": "7HQQ57WF+VP"
}
}, - "additionalProperties": {
- "isSuperUser": true
}
}
Updates individual customer profile. To update a particular field or a subset of fields all other fields in the request body with current values shall be provided, otherwise the current values will be erased.
id required | string Individual customer profile id |
id | string <uuid> Profile identifier |
phoneNumber required | string Individual consumer phone number |
solutionId required | string <uuid> Solution id should be specified for individual customer on-boarding |
country | string Individual consumer address Country in ISO 3166-1 alpha-2 . Value from country handbook. |
firstName | string Individual consumer First name |
lastName | string Individual consumer Last name |
addNames | Array of strings |
birthDate | string <date> Individual consumer date of birth |
gender | string Enum: "MALE" "FEMALE" Individual consumer gender |
status | string Enum: "ACTIVE" "BLOCKED" Individual consumer status |
Array of objects | |
object (file) | |
kycLevel | string Individual consumer KYC level. Tenant's handbook could be customized by Veengu team. |
kycStatus | string Individual consumer KYC state defines the current state of a user KYC process |
kycState | string Individual consumer KYC state defines the current state of a user KYC process |
Array of objects (document) | |
object (address) | |
object [ 0 .. 10 ] properties Any other extra profile properties may appear in this section |
{- "lastName": "Euler",
- "firstName": "Leonhard",
- "kycLevel": "basic",
- "phoneNumber": "+441234563421",
- "gender": "MALE",
- "createdAt": "2020-03-10T12:45:02+02:00",
- "solutionId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "country": "AE",
- "id": "95e656f0-68d7-475f-9429-f7a6e0263ad4",
- "status": "ACTIVE"
}
{- "lastName": "Euler",
- "firstName": "Leonhard",
- "kycLevel": "basic",
- "phoneNumber": "+441234563421",
- "gender": "MALE",
- "createdAt": "2020-03-10T12:45:02+02:00",
- "solutionId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "country": "AE",
- "id": "95e656f0-68d7-475f-9429-f7a6e0263ad4",
- "status": "ACTIVE"
}
Create a business customer profile
id | string <uuid> Profile identifier |
string Primary business profile email | |
required | object |
solutionId required | string Solution id should be specified for business customer |
country required | string Enum: "GB" "FR" "SA" "AE" "CH" Business consumer address Country in ISO 3166-1 alpha-2 . Value from country handbook. |
status | string Enum: "ACTIVE" "BLOCKED" Business consumer status |
localizations | string Value from country handbook. English is default lagnuage. |
legalName | string Business consumer legalName name |
legalType required | string Business consumer legal type. Available legal types are defined in country handbook |
tradeName | string Business consumer trade name |
tradeNameLocalized | string Business consumer trade name in local language |
Array of objects | |
description | string Business entity description |
industry | string Business entity industry |
merchantCategoryCode | string Merchant Category Code |
kycLevel | string Business consumer KYC level. Tenant's handbook could be customized by Veengu team. |
Array of objects (document) | |
object (address) | |
object | |
object [ 0 .. 10 ] properties Any other extra profile properties may appear in this section |
{- "legalType": "LLC",
- "solutionId": "6ea5263a-0226-4281-b71f-c10cf2d68eb8",
- "primaryDocument": {
- "Number": 298347028374,
- "type": "Business licence"
}, - "email": "gfbriemann@superpay.com",
- "country": "AE",
- "legalName": "Costa Coffee XVIII",
- "phoneNumber": 447930954444
}
{- "id": "a00dd671-6217-43ce-83c9-c5d4d75f9c42",
- "solutionId": "6ea5263a-0226-4281-b71f-c10cf2d68eb8",
- "kycLevel": "bronze",
- "status": "active",
- "createdAt": "2020-10-20T09:38:44.705654Z",
- "country": "AE",
- "legalName": "Costa Coffee XVIII",
- "legalType": "LLC",
- "phoneNumber": "+447930954444",
- "primaryDocument": {
- "type": "Business licence",
- "Number": "298347028374"
}
}
Get business customer profile info
id required | string Business customer profile id |
{- "id": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "email": "gfbriemann@superpay.com",
- "primaryDocument": {
- "type": "businessLicense",
- "number": "4030303030",
- "dateOfIssue": "2015-09-01",
- "dateOfExpiry": "2025-09-01",
- "files": [
- {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}
]
}, - "solutionId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "country": "AE",
- "status": "ACTIVE",
- "localizations": "ar",
- "legalName": "BigNumbersCorporation Ltd.",
- "legalType": "LTD",
- "tradeName": "Big Numbers",
- "tradeNameLocalized": "أعداد كبيرة",
- "contacts": [
- {
- "channel": "EMAIL",
- "id": "info@bn.com"
}
], - "description": "Super Company",
- "industry": "Finance",
- "merchantCategoryCode": 780,
- "kycLevel": "basic",
- "documents": [
- {
- "number": "string",
- "type": "string",
- "dateOfExpiry": "2019-08-24",
- "dateOfIssue": "2019-08-24",
- "files": [
- {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}
], - "additionalProperties": {
- "placeOfIssue": "CA, USA"
}
}
], - "address": {
- "country": "AE",
- "region": "string",
- "city": "Dubai",
- "cityLocalized": "دبي",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "building": "Burj Khalifa",
- "note": "the tallest structure and building in the world",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727",
- "plusCode": "7HQQ57WF+VP"
}
}, - "branding": {
- "icon": {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}, - "color": "#ff80b3"
}, - "additionalProperties": {
- "international": true
}
}
Edit business customer profile.
id required | string Business customer profile id |
id | string <uuid> Profile identifier |
string Primary business profile email | |
required | object |
solutionId required | string Solution id should be specified for business customer |
country required | string Enum: "GB" "FR" "SA" "AE" "CH" Business consumer address Country in ISO 3166-1 alpha-2 . Value from country handbook. |
status | string Enum: "ACTIVE" "BLOCKED" Business consumer status |
localizations | string Value from country handbook. English is default lagnuage. |
legalName | string Business consumer legalName name |
legalType required | string Business consumer legal type. Available legal types are defined in country handbook |
tradeName | string Business consumer trade name |
tradeNameLocalized | string Business consumer trade name in local language |
Array of objects | |
description | string Business entity description |
industry | string Business entity industry |
merchantCategoryCode | string Merchant Category Code |
kycLevel | string Business consumer KYC level. Tenant's handbook could be customized by Veengu team. |
Array of objects (document) | |
object (address) | |
object | |
object [ 0 .. 10 ] properties Any other extra profile properties may appear in this section |
{- "id": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "email": "gfbriemann@superpay.com",
- "primaryDocument": {
- "type": "businessLicense",
- "number": "4030303030",
- "dateOfIssue": "2015-09-01",
- "dateOfExpiry": "2025-09-01",
- "files": [
- {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}
]
}, - "solutionId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "country": "AE",
- "status": "ACTIVE",
- "localizations": "ar",
- "legalName": "BigNumbersCorporation Ltd.",
- "legalType": "LTD",
- "tradeName": "Big Numbers",
- "tradeNameLocalized": "أعداد كبيرة",
- "contacts": [
- {
- "channel": "EMAIL",
- "id": "info@bn.com"
}
], - "description": "Super Company",
- "industry": "Finance",
- "merchantCategoryCode": 780,
- "kycLevel": "basic",
- "documents": [
- {
- "number": "string",
- "type": "string",
- "dateOfExpiry": "2019-08-24",
- "dateOfIssue": "2019-08-24",
- "files": [
- {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}
], - "additionalProperties": {
- "placeOfIssue": "CA, USA"
}
}
], - "address": {
- "country": "AE",
- "region": "string",
- "city": "Dubai",
- "cityLocalized": "دبي",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "building": "Burj Khalifa",
- "note": "the tallest structure and building in the world",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727",
- "plusCode": "7HQQ57WF+VP"
}
}, - "branding": {
- "icon": {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}, - "color": "#ff80b3"
}, - "additionalProperties": {
- "international": true
}
}
{- "id": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "email": "gfbriemann@superpay.com",
- "primaryDocument": {
- "type": "businessLicense",
- "number": "4030303030",
- "dateOfIssue": "2015-09-01",
- "dateOfExpiry": "2025-09-01",
- "files": [
- {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}
]
}, - "solutionId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "country": "AE",
- "status": "ACTIVE",
- "localizations": "ar",
- "legalName": "BigNumbersCorporation Ltd.",
- "legalType": "LTD",
- "tradeName": "Big Numbers",
- "tradeNameLocalized": "أعداد كبيرة",
- "contacts": [
- {
- "channel": "EMAIL",
- "id": "info@bn.com"
}
], - "description": "Super Company",
- "industry": "Finance",
- "merchantCategoryCode": 780,
- "kycLevel": "basic",
- "documents": [
- {
- "number": "string",
- "type": "string",
- "dateOfExpiry": "2019-08-24",
- "dateOfIssue": "2019-08-24",
- "files": [
- {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}
], - "additionalProperties": {
- "placeOfIssue": "CA, USA"
}
}
], - "address": {
- "country": "AE",
- "region": "string",
- "city": "Dubai",
- "cityLocalized": "دبي",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "building": "Burj Khalifa",
- "note": "the tallest structure and building in the world",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727",
- "plusCode": "7HQQ57WF+VP"
}
}, - "branding": {
- "icon": {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}, - "color": "#ff80b3"
}, - "additionalProperties": {
- "international": true
}
}
Create new location for business customer
id | string <uuid> |
businessId required | string <uuid> |
name required | string |
status | string Enum: "ACTIVE" "BLOCKED" "CLOSED" |
merchantCategoryCode | string |
object (address) | |
object [ 0 .. 10 ] properties Any other extra profile properties may appear in this section |
{- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "name": "Bright Flowers",
- "merchantCategoryCode": "0780",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd"
}, - "additionalProperties": {
- "isHeadOffice": true
}
}
{- "id": "b34a0a7a-a748-48b5-8e8d-7b44aa27b5d1",
- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "name": "Bright Flowers",
- "status": "ACTIVE",
- "merchantCategoryCode": "0780",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd"
}, - "additionalProperties": {
- "isHeadOffice": true
}
}
Get all locations for a business customer
status | string Example: status=active Location status |
city | string Full context search by location address city |
region | string Full context search by location address region |
name | string Full context search by location name |
ids | string The list of locations could be filtered by the list of ids. If |
page required | string Example: page=1 For pagination is supported offset-based pagination - |
perPage required | string Example: perPage=10 Number of rows on one page to be returned. Number of rows can range between 1 and 100, and the default is 10. |
[- {
- "id": "b34a0a7a-a748-48b5-8e8d-7b44aa27b5d1",
- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "name": "Bright Flowers",
- "status": "NOT_ACTIVATED",
- "merchantCategoryCode": "0780",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd"
}, - "additionalProperties": {
- "isHeadOffice": true
}
}, - {
- "id": "d74b696a-4878-4b83-bd79-6290ceff703b",
- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "name": "Green Lawn",
- "status": "BLOCKED",
- "merchantCategoryCode": "0780",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "26 Sheikh Mohammed bin Rashid Blvd"
}, - "additionalProperties": {
- "isHeadOffice": false
}
}
]
Get location for business customer
id required | string business location id |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "businessId": "50092e54-cd12-4059-9828-e8c4ee9a3cf5",
- "name": "string",
- "status": "ACTIVE",
- "merchantCategoryCode": "string",
- "address": {
- "country": "AE",
- "region": "string",
- "city": "Dubai",
- "cityLocalized": "دبي",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "building": "Burj Khalifa",
- "note": "the tallest structure and building in the world",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727",
- "plusCode": "7HQQ57WF+VP"
}
}, - "additionalProperties": {
- "isHeadOffice": true
}
}
Edit location details
id required | string Location ID |
id | string <uuid> |
businessId required | string <uuid> |
name required | string |
status | string Enum: "ACTIVE" "BLOCKED" "CLOSED" |
merchantCategoryCode | string |
object (address) | |
object [ 0 .. 10 ] properties Any other extra profile properties may appear in this section |
{- "id": "b34a0a7a-a748-48b5-8e8d-7b44aa27b5d1",
- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "name": "Bright Flowers",
- "status": "NOT_ACTIVATED",
- "merchantCategoryCode": "0780",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727"
}
}, - "additionalProperties": {
- "isHeadOffice": true
}
}
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "businessId": "50092e54-cd12-4059-9828-e8c4ee9a3cf5",
- "name": "string",
- "status": "ACTIVE",
- "merchantCategoryCode": "string",
- "address": {
- "country": "AE",
- "region": "string",
- "city": "Dubai",
- "cityLocalized": "دبي",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "building": "Burj Khalifa",
- "note": "the tallest structure and building in the world",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727",
- "plusCode": "7HQQ57WF+VP"
}
}, - "additionalProperties": {
- "isHeadOffice": true
}
}
Change location status to closed
and marked as deleted true
id required | string Business location id |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Create a terminal for a business customer
id | string <uuid> |
businessId required | string <uuid> |
locationId | string <uuid> |
accountId required | string <uuid> |
label required | string |
object (device) | |
status | string Enum: "NOT_ACTIVATED" "ACTIVE" "BLOCKED" "CLOSED" |
linkedPhone | string |
object [ 0 .. 10 ] properties Any other extra profile properties may appear in this section |
{- "locationId": "b34a0a7a-a748-48b5-8e8d-7b44aa27b5d1",
- "label": "T0001",
- "linkedPhone": "+445755748793",
- "additionalProperties": {
- "NFCTerminal": "STICKER_TAG"
}
}
{- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "businessId": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "locationId": "b34a0a7a-a748-48b5-8e8d-7b44aa27b5d1",
- "label": "T0001",
- "status": "NOT_ACTIVATED",
- "linkedPhone": "+445755748793",
- "additionalProperties": {
- "NFCTerminal": "STICKER_TAG"
}
}
Get all terminals for a business customer
status | string Example: status=active |
page required | string Example: page=1 For pagination is supported offset-based pagination - |
perPage required | string Example: perPage=10 Number of rows on one page to be returned. Number of rows can range between 1 and 100, and the default is 10. |
[- {
- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "businessId": "50092e54-cd12-4059-9828-e8c4ee9a3cf5",
- "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "label": "T-0001",
- "device": {
- "applicationId": "com.veengu.pos",
- "applicationIdForVendor": "dd96dec43fb81c97",
- "deviceLabel": "CN-34857-S10",
- "osName": "Android",
- "osVersion": "10.0.1",
- "enrolledAt": "2019-08-24T14:15:22Z",
- "pushToken": "string",
- "details": "string"
}, - "status": "NOT_ACTIVATED",
- "linkedPhone": "+445755748793",
- "additionalProperties": {
- "NFCTerminal": "STICKER_TAG"
}
}
]
Edit terminal details
id required | string Business terminal id |
id | string <uuid> |
businessId required | string <uuid> |
locationId | string <uuid> |
accountId required | string <uuid> |
label required | string |
object (device) | |
status | string Enum: "NOT_ACTIVATED" "ACTIVE" "BLOCKED" "CLOSED" |
linkedPhone | string |
object [ 0 .. 10 ] properties Any other extra profile properties may appear in this section |
{- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "businessId": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "locationId": "b34a0a7a-a748-48b5-8e8d-7b44aa27b5d1",
- "label": "T0001",
- "status": "NOT_ACTIVATED",
- "linkedPhone": "+445755778354",
- "additionalProperties": {
- "NFCTerminal": null
}
}
{- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "businessId": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "locationId": "b34a0a7a-a748-48b5-8e8d-7b44aa27b5d1",
- "label": "T0001",
- "status": "NOT_ACTIVATED",
- "linkedPhone": "+445755778354",
- "additionalProperties": {
- "NFCTerminal": null
}
}
Get business terminal details by terminal id
id required | string Business terminal id |
{- "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
- "businessId": "50092e54-cd12-4059-9828-e8c4ee9a3cf5",
- "locationId": "1a5515a3-ba81-4a42-aee7-ad9ffc090a54",
- "accountId": "3d07c219-0a88-45be-9cfc-91e9d095a1e9",
- "label": "T-0001",
- "device": {
- "applicationId": "com.veengu.pos",
- "applicationIdForVendor": "dd96dec43fb81c97",
- "deviceLabel": "CN-34857-S10",
- "osName": "Android",
- "osVersion": "10.0.1",
- "enrolledAt": "2019-08-24T14:15:22Z",
- "pushToken": "string",
- "details": "string"
}, - "status": "NOT_ACTIVATED",
- "linkedPhone": "+445755748793",
- "additionalProperties": {
- "NFCTerminal": "STICKER_TAG"
}
}
Get list of currencies for purchase acceptance available for specified terminal
id required | string Business terminal id |
[- {
- "id": "XTS",
- "name": "Test currency"
}
]
Change terminal status to blocked
id required | string Business terminal id |
{- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "businessId": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "locationId": "b34a0a7a-a748-48b5-8e8d-7b44aa27b5d1",
- "label": "T0001",
- "device": {
- "applicationId": "com.veengu.pos",
- "applicationIdForVendor": "dd96dec43fb81c97",
- "deviceLabel": "Galaxy A10 CN-34857-S10",
- "osName": "Android",
- "osVersion": "10.0.1",
- "enrolledAt": "2020-05-10T14:28:46.000Z"
}, - "status": "BLOCKED"
}
Create activation code for terminal activation on cashier device
id required | string Business terminal id |
phone | string |
{- "phone": "+445755748793"
}
{- "id": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "businessId": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "value": "8560864289978243",
- "terminalId": "d5c641c5-6678-4a92-970c-22222227d",
- "expires": "2020-05-10T00:00:00.000Z",
- "createdAt": "2020-11-26T21:35:20.33227Z",
- "status": "VALID",
- "phone": "+445755748793"
}
Activate terminal on cashier device
code required | string |
keyType required | string As for now we allow only one key for one identity. Multiple keys may be allowed lately. Only |
key required | string <byte> base-64 key |
required | object (device) |
{- "code": "AED48-DHE39-P3802-026JU",
- "keyType": "tweetnacl",
- "key": "U3dhZ2dlciByb2Nrcw==",
- "device": {
- "applicationId": "com.veengu.pos",
- "applicationIdForVendor": "dd96dec43fb81c97",
- "deviceLabel": "Galaxy A10 CN-34857-S10",
- "pushToken": "c0ad68adccf",
- "osName": "Android",
- "osVersion": "10.0.1",
- "enrolledAt": "2020-05-10T14:28:46.000Z"
}
}
{- "keyId": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJleUp3Y205MmFXUmxja2xFSWpvaWRtVmxibWQxSWl3aWNISnZkbWxrWlhKTFpYa2lPaUpZVkVOZlZrNUhWUzh5SW4wPSIsImlzcyI6InBsYXktc2lsaG91ZXR0ZSIsImV4cCI6MTU4MzQ3MzI0OSwiaWF0IjoxNTgzNDMwMDQ5LCJqdGkiOiIyY2RmOTljNzA2NjNhMjU2NTczZGU4MDlhYWRkMzA4Mjc2ODYyYzEyZmVmOWM0YTYxNDc4MDBhMDUxOWUwNmU0ZWJhYmVmNTAwYmUwOTU1MjgyMGUzNjlmYjQ3YzgyZTdkZmVjMGJkODQyODcxMjg5OTc3YjhlMGZiYTg3MWI1MDE5MWQ3Yzc3OGU5ZGI2YjkyZjRjNGQwZDFhM2I4NTU5ODQ3MmM0MWU4ZTJhMDEwYmY1ZDUxMGVmODVjZDlkNmIyYzFkYTVmYzI5OTE5MTNlMmFlZGEwYjA1NTVhMTAxZDkxZGM3YWM4MjY0NmM2NzA2MGQzMTkzZDAwZDdlYTkyIn0.fc8Ls7z1F9SXzJuR7s667qBxIitAmgVK2Rdtk36reBw",
- "terminalId": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}
Retrieve Cashiers list for activated Terminal
id required | string Business terminal id |
page required | string Example: page=1 For pagination is supported offset-based pagination - |
perPage required | string Example: perPage=10 Number of rows on one page to be returned. Number of rows can range between 1 and 100, and the default is 10. |
[- {
- "id": "90907d70-8770-4a0c-a53c-8bb7e3e5d4e1",
- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "firstName": "Georg Friedrich Bernhard",
- "lastName": "Riemann",
- "phoneNumber": "+44985585843",
- "email": "gfbriemann@superpay.com",
- "document": {
- "type": "passport",
- "number": "4030303030"
}, - "authority": {
- "owner": false,
- "executive": true,
- "position": "Main Galactic CEO"
}, - "roles": [
- "BUSINESS_CASHIER"
], - "terminalId": "d5c641c5-6678-4a92-970c-295f7777d"
}, - {
- "id": "4dcd7962-4b71-4a38-994b-393832b068dd",
- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "firstName": "Mary",
- "lastName": "Gleichner",
- "phoneNumber": "+441587739440",
- "email": "Mary.Gleichner@yahoo.com",
- "terminalId": "d5c641c5-6678-4a92-970c-295f7777d",
- "document": {
- "type": "passport",
- "number": "40307463759"
}, - "authority": {
- "owner": false,
- "executive": false
}, - "roles": [
- "BUSINESS_CASHIER",
- "BUSINESS_MANAGER"
]
}
]
Get transactions history for a specified terminal
id required | string Terminal id |
fromCreatedAt | string Example: fromCreatedAt=2020-03-01T12:45:02+02:00 Datetime in the past or today to define beginning for requested period. |
toCreatedAt | string Example: toCreatedAt=2020-03-04T12:45:02+02:00 Datetime in the past or today to define end for requested period. Sysdate is used in case the value is not specified. |
next | string Example: next=eyJsYXN0RHQiOiIyMDIwLTA0LTEwVDEzOjM1OjA5LjMyMVoiLCJvZmZzZXQiOjEsImZyb20iOiIyMDIwLTA0LTEwVDE4OjAzOjQ2LjQ2NVoiLCJhY2NvdW50T3duZXJJZCI6IjAyZjRmNmIxLWYxYzMtNDA3MS05Mzg1LTMzYzkyNTZhNGMwNiJ9 For pagination is supported cursor/limit-based pagination - |
prev | string For pagination is supported cursor/limit-based pagination - |
limit | string Example: limit=10 Number of rows on one page to be returned. Limit can range between 1 and 100, and the default is 10. |
{- "cursors": {
- "next": "eyJsYXN0RHQiOiIyMDIwLTA0LTEwVDEzOjM1OjA5LjMyMVoiLCJvZmZzZXQiOjEsImZyb20iOiIyMDIwLTA0LTEwVDE4OjAzOjQ2LjQ2NVoiLCJhY2NvdW50T3duZXJJZCI6IjAyZjRmNmIxLWYxYzMtNDA3MS05Mzg1LTMzYzkyNTZhNGMwNiJ9"
}, - "transactions": [
- {
- "id": "4fdaabb45-2988-41a4-aafr3848943",
- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "COMPLETED",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "PURCHASE",
- "headTransactionId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "headOperationType": "PURCHASE",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "VAT",
- "description": "VAT included",
- "amount": {
- "value": -0.001,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 780,
- "description": "Purchase 4,5 XTS at Bright Flowers with comment SALE",
- "details": {
- "comment": "SALE",
- "tradeName": "Big Numbers",
- "location": {
- "name": "Bright Flowers",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727"
}
}
}, - "terminal": {
- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "label": "T0002"
}, - "employee": {
- "id": "90907d70-8770-4a0c-a53c-8bb7e3e5d4e1"
}, - "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ff80b3",
- "referenceNumber": "0012E1A93FO3230Q",
- "additionalFlags": [
- "ecommerce"
]
}
}, - {
- "id": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "COMPLETED",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "PURCHASE",
- "headTransactionId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "headOperationType": "PURCHASE",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "baseAmount": {
- "value": -14.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -14.5,
- "currency": "XTS"
}, - "amount": {
- "value": -14.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -14.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -14.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -14.5,
- "currency": "XTS"
}
}, - {
- "category": "VAT",
- "description": "VAT included",
- "amount": {
- "value": -0.001,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 780,
- "description": "Purchase 14,5 XTS at Bright Flowers",
- "details": {
- "tradeName": "Big Numbers",
- "location": {
- "name": "Bright Flowers",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727"
}
}
}, - "terminal": {
- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "label": "T0002"
}, - "employee": {
- "id": "90907d70-8770-4a0c-a53c-8bb7e3e5d4e1"
}, - "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ff80b3",
- "referenceNumber": "0012E1A93FO3230Q"
}
}
]
}
Create new employees for business customer
id | string <uuid> |
businessId required | string <uuid> |
firstName required | string |
lastName required | string |
phoneNumber | string |
string | |
Array of objects (document) | |
object | |
roles required | Array of strings Items Enum: "BUSINESS_ADMINISTRATOR" "BUSINESS_MANAGER" "BUSINESS_CASHIER" |
terminalId | string <uuid> |
{- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "firstName": "Georg Friedrich Bernhard",
- "lastName": "Riemann",
- "phoneNumber": "+44985585843",
- "email": "gfbriemann@superpay.com",
- "document": {
- "type": "passport",
- "number": "4030303030"
}, - "authority": {
- "owner": false,
- "executive": true,
- "position": "Main Galactic CEO"
}, - "roles": [
- "BUSINESS_MANAGER"
]
}
{- "id": "90907d70-8770-4a0c-a53c-8bb7e3e5d4e1",
- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "firstName": "Georg Friedrich Bernhard",
- "lastName": "Riemann",
- "phoneNumber": "+44985585843",
- "email": "gfbriemann@superpay.com",
- "document": {
- "type": "passport",
- "number": "4030303030"
}, - "authority": {
- "owner": false,
- "executive": true,
- "position": "Main Galactic CEO"
}, - "roles": [
- "BUSINESS_MANAGER"
]
}
Get all employees for business customer
role | string Employee role enum value |
owner | boolean The flag to filter employees with |
executive | boolean The flag to filter employees with |
name | string Full context search by employees's fist name and last name |
ids | string The list of employees could be filtered by the list of ids. If |
page required | string Example: page=1 For pagination is supported offset-based pagination - |
perPage required | string Example: perPage=10 Number of rows on one page to be returned. Number of rows can range between 1 and 100, and the default is 10. |
[- {
- "id": "90907d70-8770-4a0c-a53c-8bb7e3e5d4e1",
- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "firstName": "Georg Friedrich Bernhard",
- "lastName": "Riemann",
- "phoneNumber": "+44985585843",
- "email": "gfbriemann@superpay.com",
- "document": {
- "type": "passport",
- "number": "4030303030"
}, - "authority": {
- "owner": false,
- "executive": true,
- "position": "Main Galactic CEO"
}, - "roles": [
- "BUSINESS_CASHIER"
], - "terminalId": "d5c641c5-6678-4a92-970c-295f7777d"
}, - {
- "id": "4dcd7962-4b71-4a38-994b-393832b068dd",
- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "firstName": "Mary",
- "lastName": "Gleichner",
- "phoneNumber": "+441587739440",
- "email": "Mary.Gleichner@yahoo.com",
- "terminalId": "d5c641c5-6678-4a92-970c-295f7777d",
- "document": {
- "type": "passport",
- "number": "40307463759"
}, - "authority": {
- "owner": false,
- "executive": false
}, - "roles": [
- "BUSINESS_CASHIER",
- "BUSINESS_MANAGER"
]
}
]
Get a employee by employee id
id required | string Employee id |
{- "id": "d5c641c5-6678-4a92-970c-295f7777d",
- "businessId": "35873485973052",
- "firstName": "Georg Friedrich Bernhard",
- "lastName": "Riemann",
- "phoneNumber": "+44985585843",
- "email": "gfbriemann@superpay.com",
- "document": {
- "type": "passport",
- "number": "4030303030"
}, - "authority": {
- "owner": true,
- "executive": true,
- "position": "Main Galactic CEO"
}, - "roles": [
- "BUSINESS_MANAGER"
]
}
Edit employees details
id required | string Employee id |
id | string <uuid> |
businessId required | string <uuid> |
firstName required | string |
lastName required | string |
phoneNumber | string |
string | |
Array of objects (document) | |
object | |
roles required | Array of strings Items Enum: "BUSINESS_ADMINISTRATOR" "BUSINESS_MANAGER" "BUSINESS_CASHIER" |
terminalId | string <uuid> |
{- "id": "d5c641c5-6678-4a92-970c-295f7777d",
- "businessId": "b6c8556c-b678-42d6-bec8-8452ed69c303",
- "firstName": "Georg Friedrich Bernhard",
- "lastName": "Riemann",
- "phoneNumber": "+44985585843",
- "email": "gfbriemann@superpay.com",
- "documents": [
- {
- "number": "string",
- "type": "string",
- "dateOfExpiry": "2019-08-24",
- "dateOfIssue": "2019-08-24",
- "files": [
- {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}
], - "additionalProperties": {
- "placeOfIssue": "CA, USA"
}
}
], - "authority": {
- "owner": true,
- "executive": true,
- "position": "Main Galactic CEO"
}, - "roles": [
- "BUSINESS_MANAGER"
], - "terminalId": "d5c641c5-6678-4a92-970c-295f7777d"
}
{- "id": "d5c641c5-6678-4a92-970c-295f7777d",
- "businessId": "b6c8556c-b678-42d6-bec8-8452ed69c303",
- "firstName": "Georg Friedrich Bernhard",
- "lastName": "Riemann",
- "phoneNumber": "+44985585843",
- "email": "gfbriemann@superpay.com",
- "documents": [
- {
- "number": "string",
- "type": "string",
- "dateOfExpiry": "2019-08-24",
- "dateOfIssue": "2019-08-24",
- "files": [
- {
- "id": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "name": "image20200325.png",
- "mimeType": "string",
- "size": 0
}
], - "additionalProperties": {
- "placeOfIssue": "CA, USA"
}
}
], - "authority": {
- "owner": true,
- "executive": true,
- "position": "Main Galactic CEO"
}, - "roles": [
- "BUSINESS_MANAGER"
], - "terminalId": "d5c641c5-6678-4a92-970c-295f7777d"
}
Delete a employee within specified employee id
id required | string Employee id |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Create new access code for an employee. After successful creation previous access code is not valid anymore.
id required | string Employee id |
accessCode required | string |
{- "accessCode": "12345"
}
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Retrieve Cashiers list for activated Terminal
id required | string Business terminal id |
page required | string Example: page=1 For pagination is supported offset-based pagination - |
perPage required | string Example: perPage=10 Number of rows on one page to be returned. Number of rows can range between 1 and 100, and the default is 10. |
[- {
- "id": "90907d70-8770-4a0c-a53c-8bb7e3e5d4e1",
- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "firstName": "Georg Friedrich Bernhard",
- "lastName": "Riemann",
- "phoneNumber": "+44985585843",
- "email": "gfbriemann@superpay.com",
- "document": {
- "type": "passport",
- "number": "4030303030"
}, - "authority": {
- "owner": false,
- "executive": true,
- "position": "Main Galactic CEO"
}, - "roles": [
- "BUSINESS_CASHIER"
], - "terminalId": "d5c641c5-6678-4a92-970c-295f7777d"
}, - {
- "id": "4dcd7962-4b71-4a38-994b-393832b068dd",
- "businessId": "d5c641c5-6678-4a92-970c-295f7777d",
- "firstName": "Mary",
- "lastName": "Gleichner",
- "phoneNumber": "+441587739440",
- "email": "Mary.Gleichner@yahoo.com",
- "terminalId": "d5c641c5-6678-4a92-970c-295f7777d",
- "document": {
- "type": "passport",
- "number": "40307463759"
}, - "authority": {
- "owner": false,
- "executive": false
}, - "roles": [
- "BUSINESS_CASHIER",
- "BUSINESS_MANAGER"
]
}
]
Static payment details generated by the Platform via Dashboard or Business Portal
id required | string <uui> |
object (amount) Money object specified by value and currency | |
businessId required | string <uuid> |
comment | string |
createdAt | string <date-time> |
name required | string |
operationType required | string Enum: "PURCHASE" "CASH_DEPOSIT" "CASH_WITHDRAWAL" "P2P_TRANSFER" |
solutionId required | string <uuid> |
terminalId required | string <uuid> |
{- "amount": {
- "currency": "USD",
- "value": 3.99
}, - "businessId": "f5b9cd97-ca4f-463d-9430-ad555b996789",
- "comment": "Cappuccino Large",
- "name": "Cappuccino L",
- "operationType": "PURCHASE",
- "solutionId": "6ea5263a-0226-4281-b71f-c10cf2d68eb8",
- "terminalId": "877e2ce6-887b-480c-9c9c-e73851a833ab"
}
{- "amount": {
- "currency": "USD",
- "value": 3.99
}, - "businessId": "f5b9cd97-ca4f-463d-9430-ad555b996789",
- "comment": "Cappuccino Large",
- "createdAt": "2020-11-02T06:53:59.557829Z",
- "id": "cd8c69d8-557b-4484-9280-5bc13e08b714",
- "name": "Cappuccino L",
- "operationType": "PURCHASE",
- "solutionId": "6ea5263a-0226-4281-b71f-c10cf2d68eb8",
- "terminalId": "877e2ce6-887b-480c-9c9c-e73851a833ab"
}
Get all static payment details (QR) for business customer
terminalId | string Search static payment details (QR) by terminal id |
page required | string Example: page=1 For pagination is supported offset-based pagination - |
perPage required | string Example: perPage=10 Number of rows on one page to be returned. Number of rows can range between 1 and 100, and the default is 10. |
[- {
- "id": "cd8c69d8-557b-4484-9280-5bc13e08b714",
- "businessId": "f5b9cd97-ca4f-463d-9430-ad555b996789",
- "amount": {
- "currency": "USD",
- "value": 3.99
}, - "comment": "Cappuccino Large",
- "createdAt": "2020-11-02T06:53:59.557829Z",
- "name": "Cappuccino L",
- "operationType": "PURCHASE",
- "solutionId": "6ea5263a-0226-4281-b71f-c10cf2d68eb8",
- "terminalId": "877e2ce6-887b-480c-9c9c-e73851a833ab"
}, - {
- "id": "636e4d22-1616-4d6b-8d2b-0025dac1556f",
- "businessId": "f5b9cd97-ca4f-463d-9430-ad555b996789",
- "amount": {
- "currency": "USD",
- "value": 3.1
}, - "comment": "Small Latte",
- "createdAt": "2020-11-02T06:53:59.792137Z",
- "name": "Latte S",
- "operationType": "PURCHASE",
- "solutionId": "6ea5263a-0226-4281-b71f-c10cf2d68eb8",
- "terminalId": "877e2ce6-887b-480c-9c9c-e73851a833ab"
}
]
Get a static payment details (QR) by id
id required | string Static payment details (QR) id |
{- "amount": {
- "currency": "USD",
- "value": 3.99
}, - "businessId": "f5b9cd97-ca4f-463d-9430-ad555b996789",
- "comment": "Cappuccino Large",
- "createdAt": "2020-11-02T06:53:59.557829Z",
- "id": "cd8c69d8-557b-4484-9280-5bc13e08b714",
- "name": "Cappuccino L",
- "operationType": "PURCHASE",
- "solutionId": "6ea5263a-0226-4281-b71f-c10cf2d68eb8",
- "terminalId": "877e2ce6-887b-480c-9c9c-e73851a833ab"
}
Edit static payment details (QR)
id required | string Static Payment Details id |
id required | string <uui> |
object (amount) Money object specified by value and currency | |
businessId required | string <uuid> |
comment | string |
createdAt | string <date-time> |
name required | string |
operationType required | string Enum: "PURCHASE" "CASH_DEPOSIT" "CASH_WITHDRAWAL" "P2P_TRANSFER" |
solutionId required | string <uuid> |
terminalId required | string <uuid> |
{- "id": "cd8c69d8-557b-4484-9280-5bc13e08b714",
- "amount": {
- "value": 0,
- "currency": "XTS"
}, - "businessId": "f5b9cd97-ca4f-463d-9430-ad555b996789",
- "comment": "Cappuccino Large",
- "createdAt": "2020-11-02T06:53:59.557829Z",
- "name": "Cappuccino L",
- "operationType": "PURCHASE",
- "solutionId": "6ea5263a-0226-4281-b71f-c10cf2d68eb8",
- "terminalId": "877e2ce6-887b-480c-9c9c-e73851a833ab"
}
{- "id": "cd8c69d8-557b-4484-9280-5bc13e08b714",
- "amount": {
- "value": 0,
- "currency": "XTS"
}, - "businessId": "f5b9cd97-ca4f-463d-9430-ad555b996789",
- "comment": "Cappuccino Large",
- "createdAt": "2020-11-02T06:53:59.557829Z",
- "name": "Cappuccino L",
- "operationType": "PURCHASE",
- "solutionId": "6ea5263a-0226-4281-b71f-c10cf2d68eb8",
- "terminalId": "877e2ce6-887b-480c-9c9c-e73851a833ab"
}
Delete a static payment details (QR) by id
id required | string Static payment details (QR) id |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Retrieves the list of all accounts owned by profile with specified id.
[- {
- "id": "1a76a6a8-c706-44b3-b008-3487538475983",
- "number": 1920323819235,
- "type": "CURRENT",
- "ownerId": "1a76a6a8-c706-44b3-b008-a6d735273f96",
- "solutionId": "1a76a6a8-c706-44b3-b008-3798dddd7",
- "product": "SMESimple",
- "openDate": "2020-03-10",
- "status": "ACTIVE",
- "balances": [
- {
- "balanceType": "CURRENT",
- "amount": {
- "value": 100500,
- "currency": "XTS"
}
}
]
}
]
Get transactions history for a specified individual customer account
id required | string Customer account id |
fromCreatedAt | string Example: fromCreatedAt=2020-03-01T12:45:02+02:00 Datetime in the past or today to define beginning for requested period. |
toCreatedAt | string Example: toCreatedAt=2020-03-04T12:45:02+02:00 Datetime in the past or today to define end for requested period. Sysdate is used in case the value is not specified. |
next | string Example: next=eyJsYXN0RHQiOiIyMDIwLTA0LTEwVDEzOjM1OjA5LjMyMVoiLCJvZmZzZXQiOjEsImZyb20iOiIyMDIwLTA0LTEwVDE4OjAzOjQ2LjQ2NVoiLCJhY2NvdW50T3duZXJJZCI6IjAyZjRmNmIxLWYxYzMtNDA3MS05Mzg1LTMzYzkyNTZhNGMwNiJ9 For pagination is supported cursor/limit-based pagination - |
prev | string For pagination is supported cursor/limit-based pagination - |
limit | string Example: limit=10 Number of rows on one page to be returned. Limit can range between 1 and 100, and the default is 10. |
{- "cursors": {
- "next": "eyJsYXN0RHQiOiIyMDIwLTA0LTEwVDEzOjM1OjA5LjMyMVoiLCJvZmZzZXQiOjEsImZyb20iOiIyMDIwLTA0LTEwVDE4OjAzOjQ2LjQ2NVoiLCJhY2NvdW50T3duZXJJZCI6IjAyZjRmNmIxLWYxYzMtNDA3MS05Mzg1LTMzYzkyNTZhNGMwNiJ9"
}, - "transactions": [
- {
- "id": "916cca88-e637-46a2-9312-1dddb5098903.1601903307",
- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "COMPLETED",
- "createdAt": "2020-03-03T10:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "P2P_TRANSFER",
- "headTransactionId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "headOperationType": "P2P_TRANSFER",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE120001309073148856116",
- "accountId": "039b6b28-b16a-4b70-b630-f5c6d0df293c",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.51,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -4.51,
- "currency": "XTS"
}, - "fees": [
- {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": -0.01,
- "currency": "XTS"
}
}
], - "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "description": "Transfer 4,5 XTS to Elon M with comment Thanks for lunch ",
- "merchantCategoryCode": "6538",
- "details": {
- "OTPSMSPassed": "no",
- "recipientPhoneNumber": "+441237543442",
- "recipientName": "Elon M",
- "comment": "Thanks for lunch"
}
}, - {
- "id": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "COMPLETED",
- "createdAt": "2020-0-04T14:00:20+02:34",
- "postingDate": "2020-03-04",
- "operationType": "P2P_TRANSFER",
- "headTransactionId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "headOperationType": "P2P_TRANSFER",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE120001309073148856116",
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -6.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -6.5,
- "currency": "XTS"
}, - "amount": {
- "value": -6.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -6.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -6.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -6.5,
- "currency": "XTS"
}
}
], - "description": "Transfer 6,5 XTS from Elon M with comment Taxi sharing ",
- "merchantCategoryCode": "6538",
- "details": {
- "senderName": "Elon M",
- "comment": "Taxi sharing"
}
}
]
}
Get the list of limits for a specified account
id required | string Customer account id |
[- {
- "id": "14d1eb0d-08da-40b4-b6fc-4b5655b06e46",
- "name": "Purchase per month",
- "type": "VELOCITY_CONTROL",
- "editable": false,
- "active": true,
- "owner": {
- "type": "ACCOUNT",
- "id": "1a76a6a8-c706-44b3-b008-3487538475983"
}, - "velocityControl": {
- "count": 10,
- "amount": {
- "value": 10000,
- "currency": "XTS"
}, - "window": {
- "id": "1a76a6a8-c706-44b3-b008-3487538475983",
- "length": "PT1M",
- "dateFrom": "2020-06-01T10:00:20+02:34",
- "dateTo": "2020-07-01T10:00:20+02:34",
- "count": 3,
- "amount": {
- "value": 316,
- "currency": "XTS"
}
}
}, - "details": {
- "merchantCategoryCodes": [
- "6538",
- "4582",
- "8931"
]
}
}, - {
- "id": "f5e4fb28-46fb-4e92-8458-908fce650cde",
- "name": "P2P transfer",
- "type": "SINGLE_AMOUNT",
- "editable": false,
- "active": true,
- "owner": {
- "type": "ACCOUNT",
- "id": "1a76a6a8-c706-44b3-b008-3487538475983"
}, - "singleAmount": {
- "value": 100000,
- "currency": "XTS"
}
}, - {
- "id": "00ad9396-24ae-4a45-9e47-a3753010ea19",
- "name": "Individual Wallet",
- "type": "BALANCE",
- "editable": false,
- "active": true,
- "owner": {
- "type": "ACCOUNT",
- "id": "1a76a6a8-c706-44b3-b008-3487538475983"
}, - "maxBalance": {
- "value": 500000,
- "currency": "XTS"
}
}
]
Retrieves the list of available card types id, name and payment system.
[- {
- "id": "mastercard.standard",
- "name": "Mastercard Standard",
- "paymentSystem": "MASTERCARD"
}, - {
- "id": "mastercard.gold",
- "name": "Mastercard Gold",
- "paymentSystem": "MASTERCARD"
}
]
Instant card issuing for the profile with specified id in v-profile
header. This option is available only if card management system supports.
cardType required | string |
accountId required | string |
alias | string |
{- "cardType": "mastercard.gold",
- "accountId": "df3cb043-d835-4351-8124-3b07bd60d9c5",
- "alias": "My first card"
}
{- "id": "cd070b80-9ec8-4421-bf45-bf4fcae0b6ec",
- "profileId": "9356eeb8-d2fe-4bb6-892f-2e62373ccd72",
- "accountId": "df3cb043-d835-4351-8124-3b07bd60d9c5",
- "paymentSystem": "MASTERCARD",
- "cardType": "mastercard.gold",
- "lastFour": 1028,
- "alias": "My first card",
- "cardholderName": "DIGITAL CARD",
- "expirationDate": "23-11",
- "status": "ACTIVE"
}
Retrieves the list of all cards owned by profile with specified id in v-profile
header.
[- {
- "id": "cd070b80-9ec8-4421-bf45-bf4fcae0b6ec",
- "profileId": "9356eeb8-d2fe-4bb6-892f-2e62373ccd72",
- "accountId": "df3cb043-d835-4351-8124-3b07bd60d9c5",
- "paymentSystem": "MASTERCARD",
- "cardType": "mastercard.gold",
- "lastFour": 1028,
- "alias": "My first card",
- "cardholderName": "DIGITAL CARD",
- "expirationDate": "23-11",
- "status": "ACTIVE"
}
]
User can define some custom name for the card
id required | string The ID of the card |
alias required | string |
{- "alias": "My first card"
}
{- "id": "cd070b80-9ec8-4421-bf45-bf4fcae0b6ec",
- "profileId": "9356eeb8-d2fe-4bb6-892f-2e62373ccd72",
- "accountId": "df3cb043-d835-4351-8124-3b07bd60d9c5",
- "paymentSystem": "MASTERCARD",
- "cardType": "mastercard.gold",
- "lastFour": 1028,
- "alias": "My first card",
- "cardholderName": "DIGITAL CARD",
- "expirationDate": "23-11",
- "status": "ACTIVE"
}
Send request to card management system to close the card
id required | string The ID of the card |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Temporary block card
id required | string The ID of the card |
{- "id": "cd070b80-9ec8-4421-bf45-bf4fcae0b6ec",
- "accountId": "df3cb043-d835-4351-8124-3b07bd60d9c5",
- "paymentSystem": "MASTERCARD",
- "cardType": "mastercard.gold",
- "lastFour": 1028,
- "alias": "My first card",
- "cardholderName": "DIGITAL CARD",
- "expirationDate": "23-11",
- "status": "BLOCKED"
}
Make blocked card active
id required | string The ID of the card |
{- "id": "cd070b80-9ec8-4421-bf45-bf4fcae0b6ec",
- "profileId": "9356eeb8-d2fe-4bb6-892f-2e62373ccd72",
- "accountId": "df3cb043-d835-4351-8124-3b07bd60d9c5",
- "paymentSystem": "MASTERCARD",
- "cardType": "mastercard.gold",
- "lastFour": 1028,
- "alias": "My first card",
- "cardholderName": "DIGITAL CARD",
- "expirationDate": "23-11",
- "status": "ACTIVE"
}
Send request to card management system to create new card PIN
id required | string The ID of the card |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Retrieves a list of payment groups. Each group contains a list of payment services.
[- {
- "id": "CM",
- "name": "Cameroon",
- "branding": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ffc768"
}, - "index": 1
}, - {
- "id": "RW",
- "name": "Rwanda",
- "branding": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be472f",
- "color": "#ffc769"
}, - "index": 2
}
]
Retrieves the specific payment group by id.
id required | string Example: CM Payment group id |
{- "id": "CM",
- "name": "Cameroon",
- "branding": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ffc768"
}, - "index": 1
}
Retrieves icon by id
id required | string Example: afb24091-a769-4b7f-b6a3-4ed531be471f Image id |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Request to get the list of available payment services that is defined as a list of service records. To get the list for a specific group use the filter parameter group
.
group | string Example: group=CM Menu group id |
next | string Example: next=eyJsYXN0RHQ...1LTMzYzkyNTZhNGMwNiJ9 For pagination is supported cursor/limit-based pagination - |
prev | string Example: prev=eyJsYXN0RHQ...1LTMzYzkyNTZhNGMwNiJ9 For pagination is supported cursor/limit-based pagination - |
limit | string Number of rows on one page to be returned. Limit can range between 1 and 100, and the default is 10. |
{- "cursors": {
- "next": "eyJsYXN0RHQiOiIyMDIwLTA0LTEwVDEzOjM1OjA5LjMyMVoiLCJvZmZzZXQiOjEsImZyb20iOiIyMDIwLTA0LTEwVDE4OjAzOjQ2LjQ2NVoiLCJhY2NvdW50T3duZXJJZCI6IjAyZjRmNmIxLWYxYzMtNDA3MS05Mzg1LTMzYzkyNTZhNGMwNiJ9"
}, - "services": [
- {
- "id": "ecobank_cm",
- "operationType": "PAYOUT",
- "category": "BANK_TRANSFER",
- "name": "Ecobank",
- "parameterGroups": {
- "DETAILS": {
- "name": "Details"
}, - "BENEFICIARY": {
- "name": "Beneficiary"
}
}, - "parameters": {
- "reference": {
- "name": "Your reference",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "mandatory": false,
- "index": 8
}, - "purposeOfTransaction": {
- "name": "Purpose of transaction",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Family Support",
- "value": "Family Support"
}, - {
- "name": "Living Expenses",
- "value": "Living Expenses"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Education/School Fee",
- "value": "Education/School Fee"
}, - {
- "name": "Rent/Mortgage",
- "value": "Rent/Mortgage"
}, - {
- "name": "Emergency/Medical Aid",
- "value": "Emergency/Medical Aid"
}, - {
- "name": "Travel Expense",
- "value": "Travel Expenses"
}, - {
- "name": "Charity/Aid Payment",
- "value": "Charity/Aid Payment"
}, - {
- "name": "Alimony",
- "value": "Alimony"
}, - {
- "name": "Other",
- "value": "Other"
}
], - "index": 6
}, - "beneficiaryLastName": {
- "name": "Last name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 2
}, - "senderReportingCategory": {
- "name": "Sender category",
- "groupId": "DETAILS",
- "type": "ENUM",
- "enum": [
- {
- "name": "401 Gifts",
- "value": "401"
}, - {
- "name": "416",
- "value": "416 Migrant worker remittances"
}, - {
- "name": "417",
- "value": "417 Foreign national contract worker remittances"
}
], - "readonly": true,
- "index": 10
}, - "beneficiaryCountry": {
- "name": "Country",
- "groupId": "BENEFICIARY",
- "type": "string",
- "format": "COUNTRY",
- "readonly": true,
- "index": 4
}, - "beneficiaryFirstName": {
- "name": "First name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 1
}, - "account": {
- "name": "Account number",
- "groupId": "DETAILS",
- "type": "string",
- "mandatory": true,
- "validation": "regex:^[a-zA-Z0-9]{1,25}$",
- "hint": "Account number should contain less than 25 characters",
- "index": 5
}, - "sourceOfFunds": {
- "name": "Source of funds",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Salary",
- "value": "Salary"
}, - {
- "name": "Savings",
- "value": "Savings"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Pension",
- "value": "Pension"
}
], - "index": 7
}, - "beneficiaryPhoneNumber": {
- "name": "Phone number",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 3
}, - "senderName": {
- "name": "Sender",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "readonly": true,
- "index": 9
}
}, - "branding": {
- "icon": "401ce1e6-6412-49c9-b173-5584adbdb21b",
- "color": "#009fd1"
}, - "status": "ACTIVE",
- "amount": {
- "XAF": {
- "min": 10,
- "max": 1000,
- "denomination": -1,
- "hint": "Amount shall be between 10 and 100 XAF"
}
}, - "deal": {
- "beneficiary": true
}
}, - {
- "id": "expressunion_cm",
- "operationType": "REMITTANCE",
- "category": "CASH_REMITTANCE",
- "name": "Express Union",
- "parameterGroups": {
- "DETAILS": {
- "name": "Details"
}, - "BENEFICIARY": {
- "name": "Beneficiary"
}
}, - "parameters": {
- "reference": {
- "name": "Your reference",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "mandatory": false,
- "index": 7
}, - "purposeOfTransaction": {
- "name": "Purpose of transaction",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Family Support",
- "value": "Family Support"
}, - {
- "name": "Living Expenses",
- "value": "Living Expenses"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Education/School Fee",
- "value": "Education/School Fee"
}, - {
- "name": "Rent/Mortgage",
- "value": "Rent/Mortgage"
}, - {
- "name": "Emergency/Medical Aid",
- "value": "Emergency/Medical Aid"
}, - {
- "name": "Travel Expense",
- "value": "Travel Expenses"
}, - {
- "name": "Charity/Aid Payment",
- "value": "Charity/Aid Payment"
}, - {
- "name": "Alimony",
- "value": "Alimony"
}, - {
- "name": "Other",
- "value": "Other"
}
], - "index": 5
}, - "beneficiaryLastName": {
- "name": "Last name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 2
}, - "senderReportingCategory": {
- "name": "Sender category",
- "groupId": "DETAILS",
- "type": "ENUM",
- "enum": [
- {
- "name": "401 Gifts",
- "value": "401"
}, - {
- "name": "416",
- "value": "416 Migrant worker remittances"
}, - {
- "name": "417",
- "value": "417 Foreign national contract worker remittances"
}
], - "readonly": true,
- "index": 10
}, - "beneficiaryCountry": {
- "name": "Country",
- "groupId": "BENEFICIARY",
- "type": "string",
- "format": "COUNTRY",
- "readonly": true,
- "index": 4
}, - "beneficiaryFirstName": {
- "name": "First name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 1
}, - "sourceOfFunds": {
- "name": "Source of funds",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Salary",
- "value": "Salary"
}, - {
- "name": "Savings",
- "value": "Savings"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Pension",
- "value": "Pension"
}
], - "index": 6
}, - "beneficiaryPhoneNumber": {
- "name": "Phone number",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 3
}, - "senderName": {
- "name": "Sender",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "readonly": true,
- "index": 9
}
}, - "branding": {
- "icon": "bf001c8c-9d82-4539-a215-61626d38a110",
- "color": "#009fd1"
}, - "status": "ACTIVE",
- "amount": {
- "XAF": {
- "min": 10,
- "max": 1000,
- "denomination": -1,
- "hint": "Amount shall be between 10 and 100 XAF"
}
}, - "deal": {
- "beneficiary": true
}
}
]
}
Retrieves the service record by id
id required | string Example: DU_ABUDHABI Service Id |
{- "id": "ecobank_cm",
- "operationType": "PAYOUT",
- "category": "BANK_TRANSFER",
- "name": "Ecobank",
- "parameterGroups": {
- "DETAILS": {
- "name": "Details"
}, - "BENEFICIARY": {
- "name": "Beneficiary"
}
}, - "parameters": {
- "reference": {
- "name": "Your reference",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "mandatory": false,
- "index": 8
}, - "purposeOfTransaction": {
- "name": "Purpose of transaction",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Family Support",
- "value": "Family Support"
}, - {
- "name": "Living Expenses",
- "value": "Living Expenses"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Education/School Fee",
- "value": "Education/School Fee"
}, - {
- "name": "Rent/Mortgage",
- "value": "Rent/Mortgage"
}, - {
- "name": "Emergency/Medical Aid",
- "value": "Emergency/Medical Aid"
}, - {
- "name": "Travel Expense",
- "value": "Travel Expenses"
}, - {
- "name": "Charity/Aid Payment",
- "value": "Charity/Aid Payment"
}, - {
- "name": "Alimony",
- "value": "Alimony"
}, - {
- "name": "Other",
- "value": "Other"
}
], - "index": 6
}, - "beneficiaryLastName": {
- "name": "Last name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 2
}, - "senderReportingCategory": {
- "name": "Sender category",
- "groupId": "DETAILS",
- "type": "ENUM",
- "enum": [
- {
- "name": "401 Gifts",
- "value": "401"
}, - {
- "name": "416",
- "value": "416 Migrant worker remittances"
}, - {
- "name": "417",
- "value": "417 Foreign national contract worker remittances"
}
], - "readonly": true,
- "index": 10
}, - "beneficiaryCountry": {
- "name": "Country",
- "groupId": "BENEFICIARY",
- "type": "string",
- "format": "COUNTRY",
- "readonly": true,
- "index": 4
}, - "beneficiaryFirstName": {
- "name": "First name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 1
}, - "account": {
- "name": "Account number",
- "groupId": "DETAILS",
- "type": "string",
- "mandatory": true,
- "validation": "regex:^[a-zA-Z0-9]{1,25}$",
- "hint": "Account number should contain less than 25 characters",
- "index": 5
}, - "sourceOfFunds": {
- "name": "Source of funds",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Salary",
- "value": "Salary"
}, - {
- "name": "Savings",
- "value": "Savings"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Pension",
- "value": "Pension"
}
], - "index": 7
}, - "beneficiaryPhoneNumber": {
- "name": "Phone number",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 3
}, - "senderName": {
- "name": "Sender",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "readonly": true,
- "index": 9
}
}, - "branding": {
- "icon": "401ce1e6-6412-49c9-b173-5584adbdb21b",
- "color": "#009fd1"
}, - "status": "ACTIVE",
- "amount": {
- "XAF": {
- "min": 10,
- "max": 1000,
- "denomination": -1,
- "hint": "Amount shall be between 10 and 100 XAF"
}
}, - "deal": {
- "beneficiary": true
}
}
Retrieves icon by id
id required | string Example: afb24091-a769-4b7f-b6a3-4ed531be471f Image id |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Fills values for calculated field for a user and selected beneficiary.
serviceId required | string |
beneficiaryId required | string <uuid> |
object |
{- "serviceId": "string",
- "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
- "parameters": {
- "property1": "string",
- "property2": "string"
}
}
{- "parameters": {
- "beneficiaryPhoneNumber": "+237676641000",
- "beneficiaryLastName": "Dow",
- "beneficiaryCountry": "CM",
- "beneficiaryFirstName": "John",
- "mfsSenderDetails": {
- "idType": "ID",
- "idNumber": "6071245822964",
- "idExpiryDate": "2200-01-01",
- "addressLine": "Thanks",
- "city": "Thanks",
- "postalCode": "5555",
- "dateOfBirth": "1973-08-02"
}
}
}
Retrieves the full list of configured sending and destination countries, currency pairs for requesting currency rates and the min value for the remitter amount.
{- "remitter": {
- "AE": {
- "AED": {
- "min": 13
}
}
}, - "beneficiary": {
- "BJ": {
- "XOF": { }
}, - "BF": {
- "XOF": { }
}, - "BI": {
- "BIF": { }
}, - "CM": {
- "XAF": { }
}, - "TD": {
- "XAF": { }
}, - "CG": {
- "XAF": { }
}, - "CI": {
- "XOF": { }
}, - "CD": {
- "CDF": { },
- "USD": { }
}, - "ET": {
- "ETB": { }
}, - "GA": {
- "XAF": { }
}, - "GM": {
- "GMD": { }
}, - "GH": {
- "GHS": { }
}, - "GW": {
- "XOF": { }
}, - "GN": {
- "GNF": { }
}, - "KE": {
- "KES": { }
}, - "LR": {
- "USD": { }
}, - "MG": {
- "MGA": { }
}, - "MW": {
- "MWK": { }
}, - "ML": {
- "XOF": { }
}, - "MA": {
- "MAD": { }
}, - "MZ": {
- "MZN": { }
}, - "NE": {
- "XOF": { }
}, - "NG": {
- "NGN": { }
}, - "RW": {
- "RWF": { }
}, - "SN": {
- "XOF": { },
- "USD": { }
}, - "SL": {
- "SLL": { }
}, - "SS": {
- "SDG": { }
}, - "TZ": {
- "TZS": { }
}, - "TG": {
- "XOF": { }
}, - "UG": {
- "UGX": { }
}, - "ZM": {
- "USD": { }
}, - "ZW": {
- "USD": { }
}, - "BW": {
- "BWP": { }
}, - "SZ": {
- "SZL": { }
}
}
}
Retrieves currency rates in any direction whether from sender currency to destination currency or vice versa with fees included to senderAmount
.
To get beneficiary amount in destination currency send senderAmount
currency and value, amount
object value must be 0.
To get sender amount (to be paid) value only the amount
object must be sent.
country required | string Money remittance beneficiary country in ISO 3166-1 alpha-2. Required, but temporary configured as optional for backward compatibility. |
recipientCurrency | string Deprecated, but supported for backward compatibility. Currency code in ISO 4217 alfa-3 format. |
object (amount) Money object specified by value and currency | |
required | object (amount) Money object specified by value and currency |
{- "country": "BF",
- "senderAmount": {
- "currency": "AED",
- "value": 100
}, - "amount": {
- "currency": "XOF",
- "value": 0
}
}
{- "baseAmount": {
- "currency": "AED",
- "value": 100
}, - "remitterAmount": {
- "currency": "AED",
- "value": 100
}, - "totalAmount": {
- "currency": "AED",
- "value": -100
}, - "instructedAmount": {
- "currency": "AED",
- "value": 100
}, - "beneficiaryAmount": {
- "currency": "XOF",
- "value": 3056
}, - "entries": [
- {
- "category": "TRANSACTION",
- "amount": {
- "currency": "AED",
- "value": -92
}, - "description": "",
- "outgoing": true
}, - {
- "category": "FEE",
- "amount": {
- "currency": "ZAR",
- "value": -8
}, - "description": "Send money fee",
- "outgoing": true
}
], - "details": {
- "currencyConversion": {
- "sender": {
- "ratesId": "bbe8417e-5e12-478e-a4c7-ae23b1b9a378",
- "rate": 0.030106
}
}
}
}
Creates a new beneficiary record with a specified phone number. A beneficiary profile is linked to the Individual profile.
firstName required | string Beneficiary First name |
lastName required | string Beneficiary Last name |
phoneNumber required | string Beneficiary phone number |
country required | string Beneficiary residence Country in ISO 3166-1 alpha-2 . Value from country handbook. |
type | string Default: "INDIVIDUAL" Enum: "INDIVIDUAL" "BUSINESS" Type of beneficiary |
{- "country": "US",
- "firstName": "Benjamin",
- "lastName": "Comondo",
- "phoneNumber": "+16507599755",
- "type": "INDIVIDUAL"
}
{- "id": "25394fa2-b60b-47d6-aa5d-af44ec8aa540",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileId": "9a0cf434-71c8-4422-a40c-d2e082e7cd0f",
- "name": "Benjamin Comondo",
- "country": "US",
- "phoneNumber": "+16507599755",
- "status": "ACTIVE",
- "createdAt": "2021-10-22T10:38:52.847905Z",
- "deleted": false,
- "lastName": "Comondo",
- "firstName": "Benjamin",
- "type": "INDIVIDUAL"
}
Retrieves a list of all beneficiaries including active
, pending
and rejected
.
page required | string Example: page=1 For pagination is supported offset-based pagination - |
perPage required | string Example: perPage=10 Number of rows on one page to be returned. Number of rows can range between 1 and 100, and the default is 10. |
[- {
- "id": "25394fa2-b60b-47d6-aa5d-af44ec8aa540",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileId": "9a0cf434-71c8-4422-a40c-d2e082e7cd0f",
- "name": "Benjamin Comondo",
- "country": "US",
- "phoneNumber": "+16507599755",
- "status": "ACTIVE",
- "createdAt": "2021-10-22T10:38:52.847905Z",
- "deleted": false,
- "lastName": "Comondo",
- "firstName": "Benjamin",
- "type": "INDIVIDUAL"
}, - {
- "id": "6b5a8a4f-d583-4db0-923f-ed53512012cb",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileId": "9a0cf434-71c8-4422-a40c-d2e082e7cd0f",
- "name": "Benjamin Comondo",
- "country": "US",
- "phoneNumber": "+16507596346",
- "status": "ACTIVE",
- "createdAt": "2021-10-22T11:10:00.709632Z",
- "deleted": false,
- "lastName": "Comondo",
- "firstName": "Benjamin",
- "type": "INDIVIDUAL"
}
]
Retrieves a beneficiary record by id to let a user review the beneficiary data.
id required | string Beneficiary id |
{- "id": "25394fa2-b60b-47d6-aa5d-af44ec8aa540",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileId": "9a0cf434-71c8-4422-a40c-d2e082e7cd0f",
- "name": "Benjamin Comondo",
- "country": "US",
- "phoneNumber": "+16507599755",
- "status": "ACTIVE",
- "createdAt": "2021-10-22T10:38:52.847905Z",
- "deleted": false,
- "lastName": "Comondo",
- "firstName": "Benjamin",
- "type": "INDIVIDUAL"
}
Edits a beneficiary record.
id required | string Beneficiary id |
firstName required | string Beneficiary First name |
lastName required | string Beneficiary Last name |
phoneNumber required | string Beneficiary phone number |
country required | string Enum: "GB" "FR" "SA" "AE" "CH" Beneficiary residence Country in ISO 3166-1 alpha-2 . Value from country handbook. |
type | string Default: "INDIVIDUAL" Enum: "INDIVIDUAL" "BUSINESS" Type of beneficiary |
{- "country": "GB",
- "firstName": "Benjamin",
- "lastName": "Comondo",
- "phoneNumber": "+16507599755",
- "type": "INDIVIDUAL"
}
{- "id": "25394fa2-b60b-47d6-aa5d-af44ec8aa540",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileId": "9a0cf434-71c8-4422-a40c-d2e082e7cd0f",
- "name": "Benjamin Comondo",
- "country": "US",
- "phoneNumber": "+16507599755",
- "status": "ACTIVE",
- "createdAt": "2021-10-22T10:38:52.847905Z",
- "deleted": false,
- "lastName": "Comondo",
- "firstName": "Benjamin",
- "type": "INDIVIDUAL"
}
Marks beneficiary as deleted true
.
id required | string Beneficiary id |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Retrieves a list of payment groups. Each group contains a list of payment services.
[- {
- "id": "CM",
- "name": "Cameroon",
- "branding": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ffc768"
}, - "index": 1
}, - {
- "id": "RW",
- "name": "Rwanda",
- "branding": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be472f",
- "color": "#ffc769"
}, - "index": 2
}
]
Retrieves the specific payment group by id.
id required | string Example: CM Payment group id |
{- "id": "CM",
- "name": "Cameroon",
- "branding": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ffc768"
}, - "index": 1
}
Retrieves icon by id
id required | string Example: afb24091-a769-4b7f-b6a3-4ed531be471f Image id |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Request to get the list of available payment services that is defined as a list of service records. To get the list for a specific group use the filter parameter group
.
group | string Example: group=CM Menu group id |
next | string Example: next=eyJsYXN0RHQ...1LTMzYzkyNTZhNGMwNiJ9 For pagination is supported cursor/limit-based pagination - |
prev | string Example: prev=eyJsYXN0RHQ...1LTMzYzkyNTZhNGMwNiJ9 For pagination is supported cursor/limit-based pagination - |
limit | string Number of rows on one page to be returned. Limit can range between 1 and 100, and the default is 10. |
{- "cursors": {
- "next": "eyJsYXN0RHQiOiIyMDIwLTA0LTEwVDEzOjM1OjA5LjMyMVoiLCJvZmZzZXQiOjEsImZyb20iOiIyMDIwLTA0LTEwVDE4OjAzOjQ2LjQ2NVoiLCJhY2NvdW50T3duZXJJZCI6IjAyZjRmNmIxLWYxYzMtNDA3MS05Mzg1LTMzYzkyNTZhNGMwNiJ9"
}, - "services": [
- {
- "id": "ecobank_cm",
- "operationType": "PAYOUT",
- "category": "BANK_TRANSFER",
- "name": "Ecobank",
- "parameterGroups": {
- "DETAILS": {
- "name": "Details"
}, - "BENEFICIARY": {
- "name": "Beneficiary"
}
}, - "parameters": {
- "reference": {
- "name": "Your reference",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "mandatory": false,
- "index": 8
}, - "purposeOfTransaction": {
- "name": "Purpose of transaction",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Family Support",
- "value": "Family Support"
}, - {
- "name": "Living Expenses",
- "value": "Living Expenses"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Education/School Fee",
- "value": "Education/School Fee"
}, - {
- "name": "Rent/Mortgage",
- "value": "Rent/Mortgage"
}, - {
- "name": "Emergency/Medical Aid",
- "value": "Emergency/Medical Aid"
}, - {
- "name": "Travel Expense",
- "value": "Travel Expenses"
}, - {
- "name": "Charity/Aid Payment",
- "value": "Charity/Aid Payment"
}, - {
- "name": "Alimony",
- "value": "Alimony"
}, - {
- "name": "Other",
- "value": "Other"
}
], - "index": 6
}, - "beneficiaryLastName": {
- "name": "Last name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 2
}, - "senderReportingCategory": {
- "name": "Sender category",
- "groupId": "DETAILS",
- "type": "ENUM",
- "enum": [
- {
- "name": "401 Gifts",
- "value": "401"
}, - {
- "name": "416",
- "value": "416 Migrant worker remittances"
}, - {
- "name": "417",
- "value": "417 Foreign national contract worker remittances"
}
], - "readonly": true,
- "index": 10
}, - "beneficiaryCountry": {
- "name": "Country",
- "groupId": "BENEFICIARY",
- "type": "string",
- "format": "COUNTRY",
- "readonly": true,
- "index": 4
}, - "beneficiaryFirstName": {
- "name": "First name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 1
}, - "account": {
- "name": "Account number",
- "groupId": "DETAILS",
- "type": "string",
- "mandatory": true,
- "validation": "regex:^[a-zA-Z0-9]{1,25}$",
- "hint": "Account number should contain less than 25 characters",
- "index": 5
}, - "sourceOfFunds": {
- "name": "Source of funds",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Salary",
- "value": "Salary"
}, - {
- "name": "Savings",
- "value": "Savings"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Pension",
- "value": "Pension"
}
], - "index": 7
}, - "beneficiaryPhoneNumber": {
- "name": "Phone number",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 3
}, - "senderName": {
- "name": "Sender",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "readonly": true,
- "index": 9
}
}, - "branding": {
- "icon": "401ce1e6-6412-49c9-b173-5584adbdb21b",
- "color": "#009fd1"
}, - "status": "ACTIVE",
- "amount": {
- "XAF": {
- "min": 10,
- "max": 1000,
- "denomination": -1,
- "hint": "Amount shall be between 10 and 100 XAF"
}
}, - "deal": {
- "beneficiary": true
}
}, - {
- "id": "expressunion_cm",
- "operationType": "REMITTANCE",
- "category": "CASH_REMITTANCE",
- "name": "Express Union",
- "parameterGroups": {
- "DETAILS": {
- "name": "Details"
}, - "BENEFICIARY": {
- "name": "Beneficiary"
}
}, - "parameters": {
- "reference": {
- "name": "Your reference",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "mandatory": false,
- "index": 7
}, - "purposeOfTransaction": {
- "name": "Purpose of transaction",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Family Support",
- "value": "Family Support"
}, - {
- "name": "Living Expenses",
- "value": "Living Expenses"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Education/School Fee",
- "value": "Education/School Fee"
}, - {
- "name": "Rent/Mortgage",
- "value": "Rent/Mortgage"
}, - {
- "name": "Emergency/Medical Aid",
- "value": "Emergency/Medical Aid"
}, - {
- "name": "Travel Expense",
- "value": "Travel Expenses"
}, - {
- "name": "Charity/Aid Payment",
- "value": "Charity/Aid Payment"
}, - {
- "name": "Alimony",
- "value": "Alimony"
}, - {
- "name": "Other",
- "value": "Other"
}
], - "index": 5
}, - "beneficiaryLastName": {
- "name": "Last name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 2
}, - "senderReportingCategory": {
- "name": "Sender category",
- "groupId": "DETAILS",
- "type": "ENUM",
- "enum": [
- {
- "name": "401 Gifts",
- "value": "401"
}, - {
- "name": "416",
- "value": "416 Migrant worker remittances"
}, - {
- "name": "417",
- "value": "417 Foreign national contract worker remittances"
}
], - "readonly": true,
- "index": 10
}, - "beneficiaryCountry": {
- "name": "Country",
- "groupId": "BENEFICIARY",
- "type": "string",
- "format": "COUNTRY",
- "readonly": true,
- "index": 4
}, - "beneficiaryFirstName": {
- "name": "First name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 1
}, - "sourceOfFunds": {
- "name": "Source of funds",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Salary",
- "value": "Salary"
}, - {
- "name": "Savings",
- "value": "Savings"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Pension",
- "value": "Pension"
}
], - "index": 6
}, - "beneficiaryPhoneNumber": {
- "name": "Phone number",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 3
}, - "senderName": {
- "name": "Sender",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "readonly": true,
- "index": 9
}
}, - "branding": {
- "icon": "bf001c8c-9d82-4539-a215-61626d38a110",
- "color": "#009fd1"
}, - "status": "ACTIVE",
- "amount": {
- "XAF": {
- "min": 10,
- "max": 1000,
- "denomination": -1,
- "hint": "Amount shall be between 10 and 100 XAF"
}
}, - "deal": {
- "beneficiary": true
}
}
]
}
Retrieves the service record by id
id required | string Example: DU_ABUDHABI Service Id |
{- "id": "ecobank_cm",
- "operationType": "PAYOUT",
- "category": "BANK_TRANSFER",
- "name": "Ecobank",
- "parameterGroups": {
- "DETAILS": {
- "name": "Details"
}, - "BENEFICIARY": {
- "name": "Beneficiary"
}
}, - "parameters": {
- "reference": {
- "name": "Your reference",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "mandatory": false,
- "index": 8
}, - "purposeOfTransaction": {
- "name": "Purpose of transaction",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Family Support",
- "value": "Family Support"
}, - {
- "name": "Living Expenses",
- "value": "Living Expenses"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Education/School Fee",
- "value": "Education/School Fee"
}, - {
- "name": "Rent/Mortgage",
- "value": "Rent/Mortgage"
}, - {
- "name": "Emergency/Medical Aid",
- "value": "Emergency/Medical Aid"
}, - {
- "name": "Travel Expense",
- "value": "Travel Expenses"
}, - {
- "name": "Charity/Aid Payment",
- "value": "Charity/Aid Payment"
}, - {
- "name": "Alimony",
- "value": "Alimony"
}, - {
- "name": "Other",
- "value": "Other"
}
], - "index": 6
}, - "beneficiaryLastName": {
- "name": "Last name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 2
}, - "senderReportingCategory": {
- "name": "Sender category",
- "groupId": "DETAILS",
- "type": "ENUM",
- "enum": [
- {
- "name": "401 Gifts",
- "value": "401"
}, - {
- "name": "416",
- "value": "416 Migrant worker remittances"
}, - {
- "name": "417",
- "value": "417 Foreign national contract worker remittances"
}
], - "readonly": true,
- "index": 10
}, - "beneficiaryCountry": {
- "name": "Country",
- "groupId": "BENEFICIARY",
- "type": "string",
- "format": "COUNTRY",
- "readonly": true,
- "index": 4
}, - "beneficiaryFirstName": {
- "name": "First name",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 1
}, - "account": {
- "name": "Account number",
- "groupId": "DETAILS",
- "type": "string",
- "mandatory": true,
- "validation": "regex:^[a-zA-Z0-9]{1,25}$",
- "hint": "Account number should contain less than 25 characters",
- "index": 5
}, - "sourceOfFunds": {
- "name": "Source of funds",
- "groupId": "DETAILS",
- "type": "ENUM",
- "mandatory": true,
- "enum": [
- {
- "name": "Salary",
- "value": "Salary"
}, - {
- "name": "Savings",
- "value": "Savings"
}, - {
- "name": "Gift",
- "value": "Gift"
}, - {
- "name": "Pension",
- "value": "Pension"
}
], - "index": 7
}, - "beneficiaryPhoneNumber": {
- "name": "Phone number",
- "groupId": "BENEFICIARY",
- "type": "string",
- "readonly": true,
- "index": 3
}, - "senderName": {
- "name": "Sender",
- "groupId": "DETAILS",
- "type": "string",
- "format": "",
- "readonly": true,
- "index": 9
}
}, - "branding": {
- "icon": "401ce1e6-6412-49c9-b173-5584adbdb21b",
- "color": "#009fd1"
}, - "status": "ACTIVE",
- "amount": {
- "XAF": {
- "min": 10,
- "max": 1000,
- "denomination": -1,
- "hint": "Amount shall be between 10 and 100 XAF"
}
}, - "deal": {
- "beneficiary": true
}
}
Retrieves icon by id
id required | string Example: afb24091-a769-4b7f-b6a3-4ed531be471f Image id |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Fills values for calculated field for a user and selected beneficiary.
serviceId required | string |
beneficiaryId required | string <uuid> |
object |
{- "serviceId": "string",
- "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
- "parameters": {
- "property1": "string",
- "property2": "string"
}
}
{- "parameters": {
- "beneficiaryPhoneNumber": "+237676641000",
- "beneficiaryLastName": "Dow",
- "beneficiaryCountry": "CM",
- "beneficiaryFirstName": "John",
- "mfsSenderDetails": {
- "idType": "ID",
- "idNumber": "6071245822964",
- "idExpiryDate": "2200-01-01",
- "addressLine": "Thanks",
- "city": "Thanks",
- "postalCode": "5555",
- "dateOfBirth": "1973-08-02"
}
}
}
Complex financial operation with several parties such as beneficiary and remitter. Deals operation initiates the financial transaction based on the operation type defined in service.
Calculates fees and performs other validations related to sending funds from one individual customer to another individual that is not within the Tenant's space. As a result, a new Consent object is created. One of money sourses (senderAccountId
,senderExternalSourceId
,senderExternalSourceType
) is required to be sent. To initiate a deal in a sender currency send senderAmount
currency and value, amount
object value must be 0. To initiate a deal in a beneficiary currency value only the amount
object must be sent.
senderAccountId | string <uuid> |
senderExternalSourceId | string <uuid> |
senderExternalSourceType | string |
beneficiaryId required | string <uuid> |
required | object (amount) Money object specified by value and currency |
object (amount) Money object specified by value and currency | |
required | object |
{- "senderAccountId": "4e468f86-26dc-4a94-b56b-b06297a94aed",
- "senderExternalSourceId": "3ff2099e-7e6b-4d1e-ac74-5afeecc9e358",
- "senderExternalSourceType": "string",
- "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
- "amount": {
- "value": 0,
- "currency": "XTS"
}, - "senderAmount": {
- "value": 0,
- "currency": "XTS"
}, - "service": {
- "id": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}
}
}
{- "recipient": {
- "accountNumber": "81560882472383886153",
- "profileId": "22952b05-0eb1-4ebe-b8aa-642b3a9bc27f",
- "profileType": "PARTNER"
}, - "baseAmount": {
- "value": -4001,
- "currency": "XAF"
}, - "beneficiaryAmount": {
- "value": 4001,
- "currency": "XAF"
}, - "instructedAmount": {
- "value": 4001,
- "currency": "XAF"
}, - "amount": {
- "value": -136.1,
- "currency": "AED"
}, - "totalAmount": {
- "value": -146.1,
- "currency": "AED"
}, - "id": "1fc5d03e-16e5-4eea-8259-17f223565b57",
- "entries": [
- {
- "category": "TRANSACTION",
- "amount": {
- "currency": "AED",
- "value": -136.1
}, - "description": ""
}, - {
- "category": "FEE",
- "amount": {
- "currency": "AED",
- "value": -10
}, - "description": "FX fee"
}
], - "status": "PENDING",
- "fees": [
- {
- "category": "FEE",
- "amount": {
- "currency": "AED",
- "value": -10
}, - "description": "FX fee"
}
], - "createdAt": "2022-09-13T11:07:03.788143Z",
- "details": {
- "location": { },
- "icon": "6109b529-11b4-471f-912f-3e64e2fb8ef3",
- "color": "#009fd1",
- "service": {
- "name": "Express Union",
- "integration": {
- "plugin": "DEMO",
- "params": {
- "cashPickupPartner": "Express",
- "requiredIndividualParameters": "idType,senderAddressLine,idNumber,idExpiry,senderCity,senderPostalCode"
}
}, - "partnerId": "MFS",
- "id": "test_expressunion_cm",
- "parameters": {
- "purposeOfTransaction": "Gift",
- "beneficiaryLastName": "Any",
- "senderReportingCategory": "416",
- "beneficiaryCountry": "CM",
- "beneficiaryFirstName": "Joy",
- "mfsSenderDetails": {
- "idType": "ID",
- "city": "Thanks",
- "addressLine": "Thanks",
- "dateOfBirth": "1973-08-02",
- "idExpiryDate": "2200-01-01",
- "postalCode": "5555",
- "idNumber": "91919191919191"
}, - "sourceOfFunds": "Pension",
- "beneficiaryPhoneNumber": "+237676641000",
- "senderName": "Anabel Bond"
}
}, - "senderExternalSource": {
- "name": "Visa *0002",
- "authorizationToken": "eyJ0RS5hbnRDb2RlIjoidGVzdC1jbGlja3NlbmRub3ciLCJzb3VyY2VUeXBlIjoiRFBPX1BBWUdBVEUifQ==",
- "country": "AE",
- "authorizationType": "REDIRECT",
- "type": "DPO_PAYGATE",
- "id": "393ae944-f619-45a6-9a66-614d6d080efa",
- "vaultId": "6dbcfa0d-7c63-4477-ae8c-17380cb86954"
}, - "referenceId": [
- {
- "id": "NEDBANK_QUOTE_ID",
- "value": "578754"
}
], - "remittance": {
- "beneficiaryAmount": {
- "currency": "XAF",
- "value": 4001
}, - "senderCountry": "AE",
- "recipientCurrency": "XAF",
- "remitter": {
- "profileId": "b9d6fd4a-4507-4531-9e2c-49552ef2a232",
- "phoneNumber": "+971799675219",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "profileType": "INDIVIDUAL",
- "lastName": "Bond",
- "firstName": "Anabel"
}, - "details": { },
- "beneficiary": {
- "phoneNumber": "+237676641000",
- "country": "CM",
- "lastName": "Any",
- "firstName": "Joy",
- "id": "d15f65e2-04ef-408d-ac61-e16ff55a79b2"
}, - "recipientCountry": "CM",
- "remitterAmount": {
- "currency": "AED",
- "value": 136.1
}
}, - "currencyConversion": {
- "sender": {
- "ratesId": "42613678-5792-498b-bdab-36a7dd383685",
- "rate": 0.034017
}
}, - "deal": {
- "beneficiaryAmount": {
- "currency": "XAF",
- "value": 4001
}, - "senderCountry": "AE",
- "recipientCurrency": "XAF",
- "remitter": {
- "profileId": "b9d6fd4a-4507-4531-9e2c-49552ef2a232",
- "phoneNumber": "+971799675219",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "profileType": "INDIVIDUAL",
- "lastName": "Bond",
- "firstName": "Anabel"
}, - "details": { },
- "beneficiary": {
- "phoneNumber": "+237676641000",
- "country": "CM",
- "lastName": "Any",
- "firstName": "Joy",
- "id": "d15f65e2-04ef-408d-ac61-e16ff55a79b2"
}, - "recipientCountry": "CM",
- "remitterAmount": {
- "currency": "AED",
- "value": 136.1
}
}
}, - "sender": {
- "profileId": "ce7fca4b-7e50-4fc0-826d-4deaf41ac58c",
- "externalSourceType": "DPO_PAYGATE",
- "profileType": "PARTNER",
- "externalSourceId": "393ae944-f619-45a6-9a66-614d6d080efa",
- "accountNumber": "96429582652804377947"
}, - "originator": {
- "profileType": "INDIVIDUAL",
- "profileId": "b9d6fd4a-4507-4531-9e2c-49552ef2a232",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "name": "Anabel Bond"
}, - "payer": {
- "profileType": "INDIVIDUAL",
- "profileId": "b9d6fd4a-4507-4531-9e2c-49552ef2a232",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "name": "Anabel Bond"
}, - "merchantCategoryCode": "0",
- "description": "Remittance (XAF4,001.00 → XAF4,001.00) to CM, Joy Any",
- "operationType": "REMITTANCE"
}
Re-validates all money remittance transfer checks, including fees, based on updated inputs. One of money sourses (senderAccountId
,senderExternalSourceId
,senderExternalSourceType
) is required to be sent. To continue with a deal in a sender currency send senderAmount
currency and value, amount
object value must be 0. To continue with a deal in a beneficiary currency value only the amount
object must be sent. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned.
id required | string Deal consent id |
senderAccountId | string <uuid> |
senderExternalSourceId | string <uuid> |
senderExternalSourceType | string |
beneficiaryId required | string <uuid> |
required | object (amount) Money object specified by value and currency |
object (amount) Money object specified by value and currency | |
required | object |
{- "senderAccountId": "4e468f86-26dc-4a94-b56b-b06297a94aed",
- "senderExternalSourceId": "3ff2099e-7e6b-4d1e-ac74-5afeecc9e358",
- "senderExternalSourceType": "string",
- "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
- "amount": {
- "value": 0,
- "currency": "XTS"
}, - "senderAmount": {
- "value": 0,
- "currency": "XTS"
}, - "service": {
- "id": "string",
- "parameters": {
- "property1": "string",
- "property2": "string"
}
}
}
{- "recipient": {
- "accountNumber": "81560882472383886153",
- "profileId": "22952b05-0eb1-4ebe-b8aa-642b3a9bc27f",
- "profileType": "PARTNER"
}, - "baseAmount": {
- "value": -4001,
- "currency": "XAF"
}, - "beneficiaryAmount": {
- "value": 4001,
- "currency": "XAF"
}, - "instructedAmount": {
- "value": 4001,
- "currency": "XAF"
}, - "amount": {
- "value": -136.1,
- "currency": "AED"
}, - "totalAmount": {
- "value": -146.1,
- "currency": "AED"
}, - "id": "1fc5d03e-16e5-4eea-8259-17f223565b57",
- "entries": [
- {
- "category": "TRANSACTION",
- "amount": {
- "currency": "AED",
- "value": -136.1
}, - "description": ""
}, - {
- "category": "FEE",
- "amount": {
- "currency": "AED",
- "value": -10
}, - "description": "FX fee"
}
], - "status": "PENDING",
- "fees": [
- {
- "category": "FEE",
- "amount": {
- "currency": "AED",
- "value": -10
}, - "description": "FX fee"
}
], - "createdAt": "2022-09-13T11:07:03.788143Z",
- "details": {
- "location": { },
- "icon": "6109b529-11b4-471f-912f-3e64e2fb8ef3",
- "color": "#009fd1",
- "service": {
- "name": "Express Union",
- "integration": {
- "plugin": "DEMO",
- "params": {
- "cashPickupPartner": "Express",
- "requiredIndividualParameters": "idType,senderAddressLine,idNumber,idExpiry,senderCity,senderPostalCode"
}
}, - "partnerId": "MFS",
- "id": "test_expressunion_cm",
- "parameters": {
- "purposeOfTransaction": "Gift",
- "beneficiaryLastName": "Any",
- "senderReportingCategory": "416",
- "beneficiaryCountry": "CM",
- "beneficiaryFirstName": "Joy",
- "mfsSenderDetails": {
- "idType": "ID",
- "city": "Thanks",
- "addressLine": "Thanks",
- "dateOfBirth": "1973-08-02",
- "idExpiryDate": "2200-01-01",
- "postalCode": "5555",
- "idNumber": "91919191919191"
}, - "sourceOfFunds": "Pension",
- "beneficiaryPhoneNumber": "+237676641000",
- "senderName": "Anabel Bond"
}
}, - "senderExternalSource": {
- "name": "Visa *0002",
- "authorizationToken": "eyJ0RS5hbnRDb2RlIjoidGVzdC1jbGlja3NlbmRub3ciLCJzb3VyY2VUeXBlIjoiRFBPX1BBWUdBVEUifQ==",
- "country": "AE",
- "authorizationType": "REDIRECT",
- "type": "DPO_PAYGATE",
- "id": "393ae944-f619-45a6-9a66-614d6d080efa",
- "vaultId": "6dbcfa0d-7c63-4477-ae8c-17380cb86954"
}, - "referenceId": [
- {
- "id": "NEDBANK_QUOTE_ID",
- "value": "578754"
}
], - "remittance": {
- "beneficiaryAmount": {
- "currency": "XAF",
- "value": 4001
}, - "senderCountry": "AE",
- "recipientCurrency": "XAF",
- "remitter": {
- "profileId": "b9d6fd4a-4507-4531-9e2c-49552ef2a232",
- "phoneNumber": "+971799675219",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "profileType": "INDIVIDUAL",
- "lastName": "Bond",
- "firstName": "Anabel"
}, - "details": { },
- "beneficiary": {
- "phoneNumber": "+237676641000",
- "country": "CM",
- "lastName": "Any",
- "firstName": "Joy",
- "id": "d15f65e2-04ef-408d-ac61-e16ff55a79b2"
}, - "recipientCountry": "CM",
- "remitterAmount": {
- "currency": "AED",
- "value": 136.1
}
}, - "currencyConversion": {
- "sender": {
- "ratesId": "42613678-5792-498b-bdab-36a7dd383685",
- "rate": 0.034017
}
}, - "deal": {
- "beneficiaryAmount": {
- "currency": "XAF",
- "value": 4001
}, - "senderCountry": "AE",
- "recipientCurrency": "XAF",
- "remitter": {
- "profileId": "b9d6fd4a-4507-4531-9e2c-49552ef2a232",
- "phoneNumber": "+971799675219",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "profileType": "INDIVIDUAL",
- "lastName": "Bond",
- "firstName": "Anabel"
}, - "details": { },
- "beneficiary": {
- "phoneNumber": "+237676641000",
- "country": "CM",
- "lastName": "Any",
- "firstName": "Joy",
- "id": "d15f65e2-04ef-408d-ac61-e16ff55a79b2"
}, - "recipientCountry": "CM",
- "remitterAmount": {
- "currency": "AED",
- "value": 136.1
}
}
}, - "sender": {
- "profileId": "ce7fca4b-7e50-4fc0-826d-4deaf41ac58c",
- "externalSourceType": "DPO_PAYGATE",
- "profileType": "PARTNER",
- "externalSourceId": "393ae944-f619-45a6-9a66-614d6d080efa",
- "accountNumber": "96429582652804377947"
}, - "originator": {
- "profileType": "INDIVIDUAL",
- "profileId": "b9d6fd4a-4507-4531-9e2c-49552ef2a232",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "name": "Anabel Bond"
}, - "payer": {
- "profileType": "INDIVIDUAL",
- "profileId": "b9d6fd4a-4507-4531-9e2c-49552ef2a232",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "name": "Anabel Bond"
}, - "merchantCategoryCode": "0",
- "description": "Remittance (XAF4,001.00 → XAF4,001.00) to CM, Joy Any",
- "operationType": "REMITTANCE"
}
consentId required | string |
{- "consentId": "72bed29e-e201-4a89-b17c-c2b66fd0a682"
}
{- "deal": {
- "id": "c07b0458-c9bf-459a-b44e-8fd4f4c937c8.1661191584",
- "createdAt": "2022-08-22T18:06:24.069618Z",
- "operationType": "REMITTANCE",
- "senderCountry": "AE",
- "recipientCountry": "RS",
- "remitterAmount": {
- "currency": "AED",
- "value": 805.08
}, - "remitter": {
- "lastName": "Bond",
- "firstName": "Vesta",
- "profileId": "cf9cd2e8-c967-46ea-932d-06e86c8d72cd",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "phoneNumber": "+971791613439",
- "profileType": "INDIVIDUAL"
}, - "beneficiaryAmount": {
- "currency": "USD",
- "value": 40
}, - "beneficiary": {
- "id": "65909b70-068b-4244-ac19-ba377248325f",
- "country": "RS",
- "lastName": "Dow",
- "firstName": "John",
- "phoneNumber": "+381788154854"
}, - "status": "SENDING",
- "details": {
- "service": {
- "id": "demo_rs",
- "name": "Local Cash Kiosk",
- "parameters": {
- "senderName": "Vesta Bond",
- "sourceOfFunds": "Pension",
- "beneficiaryCountry": "RS",
- "beneficiaryLastName": "Dow",
- "beneficiaryFirstName": "John",
- "purposeOfTransaction": "Gift",
- "beneficiaryPhoneNumber": "+381788154854",
- "senderReportingCategory": "416"
}, - "integration": {
- "plugin": "DEMO"
}
}
}
}, - "transaction": {
- "recipient": {
- "accountNumber": "202100000008",
- "profileId": "018dd66b-0ce4-4324-9989-94c942d66969",
- "profileType": "TENANT"
}, - "baseAmount": {
- "value": -40,
- "currency": "USD"
}, - "beneficiaryAmount": {
- "value": 40,
- "currency": "USD"
}, - "headOperationType": "REMITTANCE",
- "instructedAmount": {
- "value": 40,
- "currency": "USD"
}, - "amount": {
- "value": -805.08,
- "currency": "AED"
}, - "totalAmount": {
- "value": -805.08,
- "currency": "AED"
}, - "id": "c07b0458-c9bf-459a-b44e-8fd4f4c937c8.1661191584",
- "entries": [
- {
- "category": "TRANSACTION",
- "amount": {
- "currency": "AED",
- "value": -805.08
}, - "description": ""
}
], - "status": "PROCESSING",
- "fees": [ ],
- "createdAt": "2022-08-22T18:06:24.069618Z",
- "sender": {
- "accountNumber": "13916594920291710608",
- "externalSourceType": "PAYAT",
- "profileId": "a0f392f6-637e-4580-9f27-0cd5e46aae30",
- "profileType": "PARTNER"
}, - "originator": {
- "name": "Vesta Bond",
- "profileId": "cf9cd2e8-c967-46ea-932d-06e86c8d72cd",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "profileType": "INDIVIDUAL"
}, - "consentId": "c07b0458-c9bf-459a-b44e-8fd4f4c937c8",
- "payer": {
- "name": "Vesta Bond",
- "profileId": "cf9cd2e8-c967-46ea-932d-06e86c8d72cd",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "profileType": "INDIVIDUAL"
}, - "merchantCategoryCode": "0",
- "description": "Remittance (USD40.00 → USD40.00) to RS, John Dow",
- "operationType": "REMITTANCE",
- "details": {
- "location": { },
- "icon": "a6124e72-f571-4c49-94ab-10276032873c",
- "color": "#009fd1",
- "service": {
- "id": "demo_rs",
- "name": "Local Cash Kiosk",
- "parameters": {
- "purposeOfTransaction": "Gift",
- "beneficiaryLastName": "Dow",
- "senderReportingCategory": "416",
- "beneficiaryCountry": "RS",
- "beneficiaryFirstName": "John",
- "sourceOfFunds": "Pension",
- "beneficiaryPhoneNumber": "+381788154854",
- "senderName": "Vesta Bond"
}, - "integration": {
- "plugin": "DEMO"
}
}, - "senderExternalSource": {
- "type": "PAYAT",
- "customerData": {
- "idNumber": "411237264831",
- "lastName": "Bond",
- "firstName": "Vesta",
- "contactNumber": "0791613439"
}
}, - "remittance": {
- "beneficiaryAmount": {
- "currency": "USD",
- "value": 40
}, - "senderCountry": "AE",
- "recipientCurrency": "USD",
- "id": "c07b0458-c9bf-459a-b44e-8fd4f4c937c8.1661191584",
- "remitter": {
- "profileId": "cf9cd2e8-c967-46ea-932d-06e86c8d72cd",
- "phoneNumber": "+971791613439",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "profileType": "INDIVIDUAL",
- "lastName": "Bond",
- "firstName": "Vesta"
}, - "details": { },
- "beneficiary": {
- "phoneNumber": "+381788154854",
- "country": "RS",
- "lastName": "Dow",
- "firstName": "John",
- "id": "65909b70-068b-4244-ac19-ba377248325f"
}, - "recipientCountry": "RS",
- "remitterAmount": {
- "currency": "AED",
- "value": 805.08
}
}, - "currencyConversion": {
- "sender": {
- "ratesId": "42613678-5792-498b-bdab-36a7dd383685",
- "rate": 20.127
}
}, - "deal": {
- "beneficiaryAmount": {
- "value": 40,
- "currency": "USD"
}, - "senderCountry": "AE",
- "recipientCurrency": "USD",
- "id": "c07b0458-c9bf-459a-b44e-8fd4f4c937c8.1661191584",
- "remitter": {
- "profileId": "cf9cd2e8-c967-46ea-932d-06e86c8d72cd",
- "phoneNumber": "+971791613439",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "profileType": "INDIVIDUAL",
- "lastName": "Bond",
- "firstName": "Vesta"
}, - "details": { },
- "beneficiary": {
- "phoneNumber": "+381788154854",
- "country": "RS",
- "lastName": "Dow",
- "firstName": "John",
- "id": "65909b70-068b-4244-ac19-ba377248325f"
}, - "recipientCountry": "RS",
- "remitterAmount": {
- "currency": "AED",
- "value": 805.08
}
}
}, - "headTransactionId": "c07b0458-c9bf-459a-b44e-8fd4f4c937c8.1661191584"
}, - "code": "25757588"
}
Retrieves the deal record for a specified deal id
id required | string Deal id |
{- "id": "c07b0458-c9bf-459a-b44e-8fd4f4c937c8.1661191584",
- "createdAt": "2022-08-22T18:06:24.069618Z",
- "operationType": "REMITTANCE",
- "senderCountry": "AE",
- "recipientCountry": "RS",
- "remitterAmount": {
- "currency": "AED",
- "value": 805.08
}, - "remitter": {
- "lastName": "Bond",
- "firstName": "Vesta",
- "profileId": "cf9cd2e8-c967-46ea-932d-06e86c8d72cd",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "phoneNumber": "+971791613439",
- "profileType": "INDIVIDUAL"
}, - "beneficiaryAmount": {
- "currency": "USD",
- "value": 40
}, - "beneficiary": {
- "id": "65909b70-068b-4244-ac19-ba377248325f",
- "country": "RS",
- "lastName": "Dow",
- "firstName": "John",
- "phoneNumber": "+381788154854"
}, - "status": "SENDING",
- "details": {
- "service": {
- "id": "demo_rs",
- "name": "Local Cash Kiosk",
- "parameters": {
- "senderName": "Vesta Bond",
- "sourceOfFunds": "Pension",
- "beneficiaryCountry": "RS",
- "beneficiaryLastName": "Dow",
- "beneficiaryFirstName": "John",
- "purposeOfTransaction": "Gift",
- "beneficiaryPhoneNumber": "+381788154854",
- "senderReportingCategory": "416"
}, - "integration": {
- "plugin": "DEMO"
}
}
}
}
Calculates fees and performs other validations related to top-up individual customer's account. As a result, two consent objects with one id are created because the same consent is applied to both: recipient account and external source.
senderExternalSourceType required | string |
recipientAccountId required | string |
required | object |
{- "senderExternalSourceType": "DEMO",
- "recipientAccountId": "0e0911f4-337a-4373-adc7-e5cd65ac2645",
- "amount": {
- "value": 0,
- "currency": "AED"
}
}
[- {
- "id": "85979481-dc16-410a-9db9-8762d1881a50",
- "status": "PENDING",
- "createdAt": "2021-10-26T12:17:11.230889Z",
- "operationType": "TOP_UP",
- "originator": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "payer": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "payee": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "sender": {
- "accountNumber": "60520381560801041446",
- "accountId": "0b45fb9a-74cf-4584-beb0-aa53dcd1e19c",
- "externalSourceType": "DEMO",
- "profileId": "36ceb770-386d-4ac4-a2fe-7c72bf3c01c2",
- "profileType": "PARTNER,"
}, - "recipient": {
- "accountNumber": "AE120001180364020049185",
- "accountId": "0e0911f4-337a-4373-adc7-e5cd65ac2645",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -100,
- "currency": "USD"
}, - "instructedAmount": {
- "value": 100,
- "currency": "USD"
}, - "amount": {
- "value": -1818.18,
- "currency": "AED"
}, - "totalAmount": {
- "value": -1818.18,
- "currency": "AED"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "amount": {
- "currency": "AED",
- "value": -1818.18
}, - "description": null
}
], - "description": "Top-up amount 100 USD, recipient is Frodo T.",
- "merchantCategoryCode": 0,
- "details": {
- "recipientName": "Frodo T.",
- "payee": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "payer": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "senderExternalSource": {
- "authorizationToken": "eyJ0RS5hbnRDb2RlIjoicWEiLCJzb3VyY2VUeXBlIjoiREVNTyJ9",
- "authorizationType": "REDIRECT",
- "type": "DEMO"
}, - "currencyConversion": {
- "sender": {
- "ratesId": "1d677824-2e46-4ec7-89a5-a69d3d6c1f27",
- "rate": 18.181818
}
}
}
}, - {
- "id": "a6bf0ac5-0e63-4e5b-8ef4-572215cf782f",
- "status": "PENDING",
- "createdAt": "2021-10-26T12:17:11.230889Z",
- "operationType": "TOP_UP",
- "originator": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "payer": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "payee": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "sender": {
- "accountNumber": "60520381560801041446",
- "accountId": "0b45fb9a-74cf-4584-beb0-aa53dcd1e19c",
- "externalSourceType": "DEMO",
- "profileId": "36ceb770-386d-4ac4-a2fe-7c72bf3c01c2",
- "profileType": "PARTNER"
}, - "recipient": {
- "accountNumber": "AE120001180364020049185",
- "accountId": "0e0911f4-337a-4373-adc7-e5cd65ac2645",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": 100,
- "currency": "USD"
}, - "instructedAmount": {
- "value": 100,
- "currency": "USD"
}, - "amount": {
- "value": 100,
- "currency": "USD"
}, - "totalAmount": {
- "value": 99.5,
- "currency": "USD"
}, - "fees": [
- {
- "category": "FEE",
- "amount": {
- "currency": "USD",
- "value": -0.5
}, - "description": "Wallet Top-up Fee"
}
], - "entries": [
- {
- "category": "TRANSACTION",
- "amount": {
- "currency": "USD",
- "value": 100
}, - "description": null
}, - {
- "category": "FEE",
- "amount": {
- "currency": "USD",
- "value": -0.5
}, - "description": "Wallet Top-up Fee"
}
], - "description": "Top-up amount 100 USD, sender is Frodo Torbins",
- "merchantCategoryCode": 0,
- "details": {
- "recipientPhoneNumber": "+447933497205",
- "recipientName": "Frodo T.",
- "senderName": "Frodo Torbins",
- "payer": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "currencyConversion": {
- "sender": {
- "ratesId": "1d677824-2e46-4ec7-89a5-a69d3d6c1f27",
- "rate": 18.181818
}
}
}
}
]
Re-validates all top-up individual customer's account transfer-related checks, including fees, based on updated inputs.
id required | string The ID of the concent |
senderExternalSourceType required | string |
recipientAccountId required | string |
required | object |
{- "senderExternalSourceType": "DEMO",
- "recipientAccountId": "0e0911f4-337a-4373-adc7-e5cd65ac2645",
- "amount": {
- "value": 0,
- "currency": "AED"
}
}
[- {
- "id": "85979481-dc16-410a-9db9-8762d1881a50",
- "status": "PENDING",
- "createdAt": "2021-10-26T12:17:11.230889Z",
- "operationType": "TOP_UP",
- "originator": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "payer": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "payee": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "sender": {
- "accountNumber": "60520381560801041446",
- "accountId": "0b45fb9a-74cf-4584-beb0-aa53dcd1e19c",
- "externalSourceType": "DEMO",
- "profileId": "36ceb770-386d-4ac4-a2fe-7c72bf3c01c2",
- "profileType": "PARTNER,"
}, - "recipient": {
- "accountNumber": "AE120001180364020049185",
- "accountId": "0e0911f4-337a-4373-adc7-e5cd65ac2645",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -100,
- "currency": "USD"
}, - "instructedAmount": {
- "value": 100,
- "currency": "USD"
}, - "amount": {
- "value": -1818.18,
- "currency": "AED"
}, - "totalAmount": {
- "value": -1818.18,
- "currency": "AED"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "amount": {
- "currency": "AED",
- "value": -1818.18
}, - "description": null
}
], - "description": "Top-up amount 100 USD, recipient is Frodo T.",
- "merchantCategoryCode": 0,
- "details": {
- "recipientName": "Frodo T.",
- "payee": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "payer": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "senderExternalSource": {
- "authorizationToken": "eyJ0RS5hbnRDb2RlIjoicWEiLCJzb3VyY2VUeXBlIjoiREVNTyJ9",
- "authorizationType": "REDIRECT",
- "type": "DEMO"
}, - "currencyConversion": {
- "sender": {
- "ratesId": "1d677824-2e46-4ec7-89a5-a69d3d6c1f27",
- "rate": 18.181818
}
}
}
}, - {
- "id": "a6bf0ac5-0e63-4e5b-8ef4-572215cf782f",
- "status": "PENDING",
- "createdAt": "2021-10-26T12:17:11.230889Z",
- "operationType": "TOP_UP",
- "originator": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "payer": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "payee": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "sender": {
- "accountNumber": "60520381560801041446",
- "accountId": "0b45fb9a-74cf-4584-beb0-aa53dcd1e19c",
- "externalSourceType": "DEMO",
- "profileId": "36ceb770-386d-4ac4-a2fe-7c72bf3c01c2",
- "profileType": "PARTNER"
}, - "recipient": {
- "accountNumber": "AE120001180364020049185",
- "accountId": "0e0911f4-337a-4373-adc7-e5cd65ac2645",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": 100,
- "currency": "USD"
}, - "instructedAmount": {
- "value": 100,
- "currency": "USD"
}, - "amount": {
- "value": 100,
- "currency": "USD"
}, - "totalAmount": {
- "value": 99.5,
- "currency": "USD"
}, - "fees": [
- {
- "category": "FEE",
- "amount": {
- "currency": "USD",
- "value": -0.5
}, - "description": "Wallet Top-up Fee"
}
], - "entries": [
- {
- "category": "TRANSACTION",
- "amount": {
- "currency": "USD",
- "value": 100
}, - "description": null
}, - {
- "category": "FEE",
- "amount": {
- "currency": "USD",
- "value": -0.5
}, - "description": "Wallet Top-up Fee"
}
], - "description": "Top-up amount 100 USD, sender is Frodo Torbins",
- "merchantCategoryCode": 0,
- "details": {
- "recipientPhoneNumber": "+447933497205",
- "recipientName": "Frodo T.",
- "senderName": "Frodo Torbins",
- "payer": {
- "profileType": "INDIVIDUAL",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "name": "Frodo Torbins"
}, - "currencyConversion": {
- "sender": {
- "ratesId": "1d677824-2e46-4ec7-89a5-a69d3d6c1f27",
- "rate": 18.181818
}
}
}
}
]
consentId required | string |
{- "consentId": "85979481-dc16-410a-9db9-8762d1881a50"
}
[- {
- "id": "85979481-dc16-410a-9db9-8762d1881a50.1635255810",
- "consentId": "85979481-dc16-410a-9db9-8762d1881a50",
- "status": "PROCESSING",
- "createdAt": "2021-10-26T13:43:30.289400Z",
- "operationType": "TOP_UP",
- "headTransactionId": "85979481-dc16-410a-9db9-8762d1881a50.1635255810",
- "headOperationType": "TOP_UP",
- "originator": {
- "name": "Frodo Torbins",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileType": "INDIVIDUAL"
}, - "payer": {
- "name": "Frodo Torbins",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileType": "INDIVIDUAL"
}, - "payee": {
- "name": "Frodo Torbins",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileType": "INDIVIDUAL"
}, - "sender": {
- "accountNumber": "60520381560801041446",
- "accountId": "0b45fb9a-74cf-4584-beb0-aa53dcd1e19c",
- "externalSourceType": "DEMO",
- "profileId": "36ceb770-386d-4ac4-a2fe-7c72bf3c01c2",
- "profileType": "PARTNER"
}, - "recipient": {
- "accountNumber": "AE120001180364020049185",
- "accountId": "0e0911f4-337a-4373-adc7-e5cd65ac2645",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -20,
- "currency": "USD"
}, - "instructedAmount": {
- "value": 20,
- "currency": "USD"
}, - "amount": {
- "value": -363.64,
- "currency": "AED"
}, - "totalAmount": {
- "value": -363.64,
- "currency": "AED"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "amount": {
- "currency": "AED",
- "value": -363.64
}, - "description": null
}
], - "description": "Top-up amount 100 USD, recipient is Frodo T.",
- "merchantCategoryCode": 0,
- "details": {
- "recipientName": "Frodo T.",
- "payee": {
- "name": "Frodo Torbins",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileType": "INDIVIDUAL"
}, - "payer": {
- "name": "Frodo Torbins",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileType": "INDIVIDUAL"
}, - "senderExternalSource": {
- "type": "DEMO",
- "authorizationType": "REDIRECT",
- "authorizationToken": "eyJ0RS5hbnRDb2RlIjoicWEiLCJzb3VyY2VUeXBlIjoiREVNTyJ9"
}, - "currencyConversion": {
- "sender": {
- "ratesId": "1d677824-2e46-4ec7-89a5-a69d3d6c1f27",
- "rate": 18.181818
}
}
}
}, - {
- "id": "a6bf0ac5-0e63-4e5b-8ef4-572215cf782f.1635255810",
- "consentId": "85979481-dc16-410a-9db9-8762d1881a50",
- "status": "PROCESSING",
- "createdAt": "2021-10-26T13:43:30.289400Z",
- "operationType": "TOP_UP",
- "headTransactionId": "85979481-dc16-410a-9db9-8762d1881a50.1635255810",
- "headOperationType": "TOP_UP",
- "originator": {
- "name": "Frodo Torbins",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileType": "INDIVIDUAL"
}, - "payer": {
- "name": "Frodo Torbins",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileType": "INDIVIDUAL"
}, - "payee": {
- "name": "Frodo Torbins",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileType": "INDIVIDUAL"
}, - "sender": {
- "accountNumber": "60520381560801041446",
- "accountId": "0b45fb9a-74cf-4584-beb0-aa53dcd1e19c",
- "externalSourceType": "DEMO",
- "profileId": "36ceb770-386d-4ac4-a2fe-7c72bf3c01c2",
- "profileType": "PARTNER"
}, - "recipient": {
- "accountNumber": "AE120001180364020049185",
- "accountId": "0e0911f4-337a-4373-adc7-e5cd65ac2645",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": 20,
- "currency": "USD"
}, - "instructedAmount": {
- "value": 20,
- "currency": "USD"
}, - "amount": {
- "value": 20,
- "currency": "USD"
}, - "totalAmount": {
- "value": 19.75,
- "currency": "USD"
}, - "fees": [
- {
- "category": "FEE",
- "amount": {
- "currency": "USD",
- "value": -0.25
}, - "description": "Wallet Top-up Fee"
}
], - "entries": [
- {
- "category": "TRANSACTION",
- "amount": {
- "currency": "USD",
- "value": 20
}, - "description": null
}, - {
- "category": "FEE",
- "amount": {
- "currency": "USD",
- "value": -0.25
}, - "description": "Wallet Top-up Fee"
}
], - "description": "Top-up amount 100 USD, sender is Frodo Torbins",
- "merchantCategoryCode": 0,
- "details": {
- "recipientPhoneNumber": "+447933497205",
- "recipientName": "Frodo T.",
- "senderName": "Frodo Torbins",
- "payer": {
- "name": "Frodo Torbins",
- "profileId": "60387edf-22f6-4969-8199-f4454fb38e9b",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileType": "INDIVIDUAL"
}, - "currencyConversion": {
- "sender": {
- "ratesId": "1d677824-2e46-4ec7-89a5-a69d3d6c1f27",
- "rate": 18.181818
}
}
}
}
]
Generate payment details on cashier device or individual application for cash deposit
operationType required | string Enum: "PURCHASE" "CASH_WITHDRAWAL" "CASH_DEPOSIT" Operation type is required if you request payment details for business profile. |
object (schema) Money object specified by value and currency | |
comment | string |
{- "operationType": "PURCHASE",
- "amount": {
- "value": 0,
- "currency": "ZAR"
}, - "comment": "Flat white"
}
{- "paymentToken": "4f40e0e3-4383-42d2-b52a-37690429bda6",
- "expiresAt": "2024-06-04T13:17:53+03:00"
}
Verifies if beneficiary specified by Payment Token for Terminal and Business profile or Individual has been registered within the Tenant's space.
paymentToken required | string Payment token string from QR Code |
{- "paymentToken": "4f40e0e3-4383-42d2-b52a-37690429bda6"
}
{- "paymentToken": {
- "id": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "type": "STATIC_QR"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "operationType": "PURCHASE",
- "beneficiary": {
- "type": "BUSINESS",
- "accountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "validity": "VALID",
- "details": {
- "tradeName": "Tel2",
- "location": {
- "name": "Bright Flowers",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727"
}
}
}, - "comment": "SALE",
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ff80b3"
}
}
}
Polling request to get transaction result and transaction details
id required | string Example: 4f40e0e3-4383-42d2-b52a-37690429bda6 Payment Details id (Payment Token) |
{- "id": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "status": "COMPLETED",
- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "PURCHASE",
- "headTransactionId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "headOperationType": "PURCHASE",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "VAT",
- "description": "VAT included",
- "amount": {
- "value": -0.001,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 780,
- "description": "Purchase 4,5 XTS at Bright Flowers with comment SALE",
- "details": {
- "comment": "SALE",
- "location": {
- "name": "Bright Flowers",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727"
}
}
}, - "terminal": {
- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "label": "T0002"
}, - "employee": {
- "id": "90907d70-8770-4a0c-a53c-8bb7e3e5d4e1"
}, - "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ff80b3",
- "referenceNumber": "0012E1A93FO3230Q",
- "additionalFlags": [
- "ecommerce"
]
}
}
Retrieves all transactions performed for all accounts owned by individual or business customer. The transactions are returned in sorted order, with the most recent transactions appearing first.
fromСreatedAt | string Example: fromСreatedAt=2020-03-01T12:45:02+02:00 Datetime in the past or today to define beginning for requested period. |
toCreatedAt | string Example: toCreatedAt=2020-03-04T12:45:02+02:00 Datetime in the past or today to define end for requested period. Sysdate is used in case the value is not specified. |
operationType | string (operationType) Enum: "PAYOUT" "P2P_TRANSFER" "PURCHASE" "MEMBERSHIP" "BILL_PAYMENT" "TOP_UP" "CASH_DEPOSIT" "CASH_WITHDRAWAL" "OWN_ACCOUNTS_TRANSFER" Example: operationType=P2P_TRANSFER Define operation type enum value to find transactions only with specified operation type |
status | string Example: status=COMPLETED Transaction status from enum |
accountId required | string Example: accountId=1a76a6a8-c706-44b3-b008-3487538475983 Individual customer account id |
employeeId | string <uuid> Example: employeeId=90907d70-8770-4a0c-a53c-8bb7e3e5d4e1 Business terminal identifier from transaction details. |
terminalId | string <uuid> Example: terminalId=d5c641c5-6678-4a92-970c-66666667d Business terminal identifier from transaction details. |
locationId | string <uuid> Example: locationId=d5c641c5-6678-4a92-970c-66666667d Business location identifier from transaction details. |
referenceId | string Example: referenceId=Delivery Transaction reference token |
feedbackId | string Example: feedbackId=Delivery Feedback IF to search by |
externalSourceType | string Example: externalSourceType=SOME_TYPE External source type |
externalSourceId | string <uuid> Example: externalSourceId=d5c641c5-6678-4a92-970c-66666667d External source ID |
next | string Example: next=eyJsYXN0RHQiOiIyMDIwLTA0LTEwVDEzOjM1OjA5LjMyMVoiLCJvZmZzZXQiOjEsImZyb20iOiIyMDIwLTA0LTEwVDE4OjAzOjQ2LjQ2NVoiLCJhY2NvdW50T3duZXJJZCI6IjAyZjRmNmIxLWYxYzMtNDA3MS05Mzg1LTMzYzkyNTZhNGMwNiJ9 For pagination is supported cursor/limit-based pagination - |
prev | string For pagination is supported cursor/limit-based pagination - |
limit | string Example: limit=10 Number of rows on one page to be returned. Limit can range between 1 and 100, and the default is 10. |
{- "cursors": {
- "next": "eyJsYXN0RHQiOiIyMDIwLTA0LTEwVDEzOjM1OjA5LjMyMVoiLCJvZmZzZXQiOjEsImZyb20iOiIyMDIwLTA0LTEwVDE4OjAzOjQ2LjQ2NVoiLCJhY2NvdW50T3duZXJJZCI6IjAyZjRmNmIxLWYxYzMtNDA3MS05Mzg1LTMzYzkyNTZhNGMwNiJ9"
}, - "transactions": [
- {
- "id": "916cca88-e637-46a2-9312-1dddb5098903.1601903307",
- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "COMPLETED",
- "createdAt": "2020-03-03T10:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "P2P_TRANSFER",
- "headTransactionId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "headOperationType": "P2P_TRANSFER",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE120001309073148856116",
- "accountId": "039b6b28-b16a-4b70-b630-f5c6d0df293c",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.51,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -4.51,
- "currency": "XTS"
}, - "fees": [
- {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": -0.01,
- "currency": "XTS"
}
}
], - "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "description": "Transfer 4,5 XTS to Elon M with comment Thanks for lunch ",
- "merchantCategoryCode": "6538",
- "details": {
- "OTPSMSPassed": "no",
- "recipientPhoneNumber": "+441237543442",
- "recipientName": "Elon M",
- "comment": "Thanks for lunch"
}
}, - {
- "id": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "COMPLETED",
- "createdAt": "2020-0-04T14:00:20+02:34",
- "postingDate": "2020-03-04",
- "operationType": "P2P_TRANSFER",
- "headTransactionId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "headOperationType": "P2P_TRANSFER",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE120001309073148856116",
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -6.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -6.5,
- "currency": "XTS"
}, - "amount": {
- "value": -6.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -6.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -6.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -6.5,
- "currency": "XTS"
}
}
], - "description": "Transfer 6,5 XTS from Elon M with comment Taxi sharing ",
- "merchantCategoryCode": "6538",
- "details": {
- "senderName": "Elon M",
- "comment": "Taxi sharing"
}
}
]
}
Get historical transaction for a specified transaction id
id required | string Transaction record id |
{- "id": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "COMPLETED",
- "createdAt": "2020-03-03T10:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "P2P_TRANSFER",
- "headTransactionId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "headOperationType": "P2P_TRANSFER",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE120001309073148856116",
- "accountId": "039b6b28-b16a-4b70-b630-f5c6d0df293c",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.51,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -4.51,
- "currency": "XTS"
}, - "fees": [
- {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": -0.01,
- "currency": "XTS"
}
}
], - "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": -0.01,
- "currency": "XTS"
}
}
], - "description": "Transfer 4,5 XTS to Elon M with comment Thanks for lunch ",
- "merchantCategoryCode": "6538",
- "details": {
- "OTPSMSPassed": "no",
- "recipientPhoneNumber": "+441237543442",
- "recipientName": "Elon M",
- "comment": "Thanks for lunch"
}
}
Begin export of transactions of current customer to CSV, Excel or other formats
fromСreatedAt | string Datetime in the past or today to define beginning for requested period. |
toСreatedAt | string Datetime in the past or today to define end for requested period. Sysdate is used in case the value is not specified. |
operationType | string (operationType) Enum: "PAYOUT" "P2P_TRANSFER" "PURCHASE" "MEMBERSHIP" "BILL_PAYMENT" "TOP_UP" "CASH_DEPOSIT" "CASH_WITHDRAWAL" "OWN_ACCOUNTS_TRANSFER" Business operation transaction type |
status | string Transaction status from enum |
accountId | string Account ID to filter transactions by |
employeeId | string Employee ID to filter transactions by |
terminalId | string Terminal ID to filter transactions by |
locationId | string Location ID to filter transactions by |
referenceId | string Reference ID to filter transactions by |
feedbackId | string Feedback ID to filter transactions by |
externalSourceType | string External source / payment instrument type to filter transactions by |
externalSourceId | string External source / payment instrument ID to filter transactions by |
exportFormat | string Enum: "CSV" "XLSX" Export file format; CSV is default |
{- "fromСreatedAt": "2020-03-01T12:45:02+02:00",
- "toСreatedAt": "2020-03-01T12:45:02+02:00",
- "operationType": "PAYOUT",
- "status": "COMPLETED",
- "accountId": "4f40e0e3-4383-42d2-b52a-37690429bda6",
- "employeeId": "1c031ef4-6d01-4f84-9eaa-7d09a0e0f0a6",
- "terminalId": "78fdd8dc-cfb1-4b81-b900-530ed6b3dae1",
- "locationId": "f172e363-8db1-4f2c-8d9d-d4c70bb04630",
- "referenceId": "827fbaeb-ee98-4181-ac63-6ce2c626fa42",
- "feedbackId": "c659ae8a-96a4-454d-a0c4-188a32bc27ca",
- "externalSourceType": "DEMO",
- "externalSourceId": "78bfa507-2886-4e3a-984e-392b22963f17",
- "exportFormat": "CSV"
}
{- "id": "string",
- "taskType": "string",
- "arguments": { },
- "status": "INITIAL",
- "statusMessage": "string",
- "resultType": "json"
}
Check previously scheduled export status
id required | string Export task ID |
{- "id": "string",
- "taskType": "string",
- "arguments": { },
- "status": "INITIAL",
- "statusMessage": "string",
- "resultType": "json"
}
Verifies if beneficiary (individual customer) specified by phone number has been registered within the Tenant's space.
phoneNumber | string Individual customer phone number. In case of multiple accounts the request returns accountId according the following logic and priority:
|
accountNumber | string Individual customer account number. Account number is unique and sufficient account identifier. If |
currency | string Currency code in ISO 4217 alfa-3 format. Additional parameter to define the preferable beneficiary's account. Attribute is applied only if |
{- "phoneNumber": "+441237543442",
- "accountNumber": "AE820001229623811416310",
- "currency": "AED"
}
{- "type": "INDIVIDUAL",
- "accountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "validity": "VALID",
- "details": {
- "recipientName": "Elon M",
- "recipientAccountNumber": 192032381923
}
}
Calculates fees and performs other validations related to sending funds from one individual customer account to another individual customer account within the Tenant's space. As a result, a new Consent object is created. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned.
senderAccountId required | string |
recipientAccountId required | string |
localUTCOffset | string <UTC> User mobile device locale time zone in ISO 8601 as an offset from UTC |
required | object (amount) Money object specified by value and currency |
comment | string |
{- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "recipientAccountId": "95e656f0-68d7-475f-9429-f7a6e0263ad4",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": 4.5,
- "currency": "XTS"
}, - "comment": "Thanks for lunch"
}
{- "id": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "operationType": "P2P_TRANSFER",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE120001309073148856116",
- "accountId": "039b6b28-b16a-4b70-b630-f5c6d0df293c",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.51,
- "currency": "XTS"
}, - "fees": [
- {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": -0.01,
- "currency": "XTS"
}
}
], - "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": -0.01,
- "currency": "XTS"
}
}
], - "description": "Transfer 4,5 XTS to Elon M with the comment Thanks for lunch",
- "merchantCategoryCode": "6538",
- "details": {
- "recipientPhoneNumber": "+441237543442",
- "recipientName": "Elon M",
- "comment": "Thanks for lunch"
}
}
Re-validates all person-to-person transfer-related checks, including fees, based on updated inputs. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned
id required | string Consent id |
senderAccountId required | string |
recipientAccountId required | string |
localUTCOffset | string <UTC> |
required | object (amount) Money object specified by value and currency |
comment | string |
{- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "recipientAccountId": "95e656f0-68d7-475f-9429-f7a6e0263ad4",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": 4.5,
- "currency": "XTS"
}, - "comment": "Thanks for lunch"
}
{- "id": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "operationType": "P2P_TRANSFER",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE120001309073148856116",
- "accountId": "039b6b28-b16a-4b70-b630-f5c6d0df293c",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.51,
- "currency": "XTS"
}, - "fees": [
- {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": -0.01,
- "currency": "XTS"
}
}
], - "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": -0.01,
- "currency": "XTS"
}
}
], - "description": "Transfer 4,5 XTS to Elon M with the comment Thanks for lunch",
- "merchantCategoryCode": "6538",
- "details": {
- "recipientPhoneNumber": "+441237543442",
- "recipientName": "Elon M",
- "comment": "Thanks for lunch"
}
}
consentId required | string |
{- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce"
}
{- "id": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "COMPLETED",
- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "P2P_TRANSFER",
- "headTransactionId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "headOperationType": "P2P_TRANSFER",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE120001309073148856116",
- "accountId": "039b6b28-b16a-4b70-b630-f5c6d0df293c",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.51,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -4.51,
- "currency": "XTS"
}, - "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": -0.01,
- "currency": "XTS"
}
}
], - "fees": [
- {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": -0.01,
- "currency": "XTS"
}
}
], - "description": "Transfer 4,5 XTS to Elon M with the comment Thanks for lunch",
- "merchantCategoryCode": "6538",
- "details": {
- "recipientPhoneNumber": "+441237543442",
- "recipientName": "Elon M",
- "comment": "Thanks for lunch"
}
}
Calculates fees and performs other validations related to sending funds from a individual customer account to business customer account within the Tenant's space. As a result, a new Consent object is created. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned.
paymentToken required | string Payment token string from QR Code |
senderAccountId required | string |
localUTCOffset | string <UTC> |
required | object (amount) Money object specified by value and currency |
comment | string |
{- "paymentToken": "4f40e0e3-4383-42d2-b52a-37690429bda6",
- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
{- "id": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:14+02:34",
- "operationType": "PURCHASE",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "VAT",
- "description": "VAT included",
- "amount": {
- "value": -0.001,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 780,
- "description": "Purchase 4.5 XTS at Bright Flowers with comment SALE",
- "details": {
- "comment": "SALE",
- "tradeName": "Big Numbers",
- "location": {
- "name": "Bright Flowers",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727"
}
}
}, - "terminal": {
- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "label": "T0002"
}, - "employee": {
- "id": "90907d70-8770-4a0c-a53c-8bb7e3e5d4e1"
}, - "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ff80b3",
- "additionalFlags": [
- "ecommerce"
]
}
}
Re-validates all push purchase-related checks, including fees, based on updated inputs. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned
id required | string Consent id |
paymentToken required | string Payment token string from QR Code |
senderAccountId required | string |
localUTCOffset | string <UTC> |
required | object (amount) Money object specified by value and currency |
comment | string |
{- "paymentToken": "4f40e0e3-4383-42d2-b52a-37690429bda6",
- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
{- "id": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:14+02:34",
- "operationType": "PURCHASE",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "VAT",
- "description": "VAT included",
- "amount": {
- "value": -0.001,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 780,
- "description": "Purchase 4.5 XTS at Bright Flowers with comment SALE",
- "details": {
- "comment": "SALE",
- "tradeName": "Big Numbers",
- "location": {
- "name": "Bright Flowers",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727"
}
}
}, - "terminal": {
- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "label": "T0002"
}, - "employee": {
- "id": "90907d70-8770-4a0c-a53c-8bb7e3e5d4e1"
}, - "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ff80b3",
- "additionalFlags": [
- "ecommerce"
]
}
}
consentId required | string |
{- "consentId": "72bed29e-e201-4a89-b17c-c2b66fd0a682"
}
{- "id": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "status": "COMPLETED",
- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "PURCHASE",
- "headTransactionId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "headOperationType": "PURCHASE",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "VAT",
- "description": "VAT included",
- "amount": {
- "value": -0.001,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 780,
- "description": "Purchase 4,5 XTS at Bright Flowers with comment SALE",
- "details": {
- "comment": "SALE",
- "location": {
- "name": "Bright Flowers",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727"
}
}
}, - "terminal": {
- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "label": "T0002"
}, - "employee": {
- "id": "90907d70-8770-4a0c-a53c-8bb7e3e5d4e1"
}, - "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ff80b3",
- "referenceNumber": "0012E1A93FO3230Q",
- "additionalFlags": [
- "ecommerce"
]
}
}
Bill Payment / Mobile Topup from individual account to Utility Supplier/MNO/Aggregator account
Check Bill Payment / Mobile Topup beneficiary account
serviceId | string Service id |
{- "serviceId": "DU_ABUDHABI"
}
{- "type": "PARTNER",
- "accountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "validity": "VALID"
}
Calculates fees and performs other validations related to sending funds from one individual customer account to Partner account within the Tenant's space. As a result, a new Consent object is created. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned.
senderAccountId required | string |
localUTCOffset | string <UTC> User mobile device locale time zone in ISO 8601 as an offset from UTC |
required | object (amount) Money object specified by value and currency |
required | object |
{- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": 4.5,
- "currency": "XTS"
}, - "service": {
- "id": "DU_ABUDHABI",
- "parameters": {
- "consumerIdentifier": "+44987654321"
}
}
}
{- "id": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:14+02:34",
- "operationType": "BILL_PAYMENT",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "PARTNER"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 4814,
- "description": "Du Mobile payment 4.5 XTS",
- "details": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#009fd1",
- "service": {
- "id": "DU_ABUDHABI",
- "supplierId": "DU",
- "partnerId": "LOCAL_PAYMENT_HUB",
- "paymentType": "PREPAID",
- "groupId": "mobileTopup",
- "region": "Abu Dhabi",
- "status": "ACTIVE",
- "name": "Du Mobile",
- "parameters": {
- "consumerIdentifier": "+44987654321"
}
}
}
}
Re-validates all bill payment-related checks, including fees, based on updated inputs. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned
id required | string Consent id |
senderAccountId required | string |
localUTCOffset | string <UTC> User mobile device locale time zone in ISO 8601 as an offset from UTC |
required | object (amount) Money object specified by value and currency |
required | object |
{- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": 4.5,
- "currency": "XTS"
}, - "service": {
- "id": "DU_ABUDHABI",
- "parameters": {
- "consumerIdentifier": "+44987654321"
}
}
}
{- "id": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:14+02:34",
- "operationType": "BILL_PAYMENT",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "PARTNER"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 4814,
- "description": "Du Mobile payment 4.5 XTS",
- "details": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#009fd1",
- "service": {
- "id": "DU_ABUDHABI",
- "supplierId": "DU",
- "partnerId": "LOCAL_PAYMENT_HUB",
- "paymentType": "PREPAID",
- "groupId": "mobileTopup",
- "region": "Abu Dhabi",
- "status": "ACTIVE",
- "name": "Du Mobile",
- "parameters": {
- "consumerIdentifier": "+44987654321"
}
}
}
}
consentId required | string |
{- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce"
}
{- "id": "b064ad54-c263-4cc4-b80f-123032f5c0f7.1601902273",
- "status": "COMPLETED",
- "headTransactionId": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "consentId": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "BILL_PAYMENT",
- "headOperationType": "BILL_PAYMENT",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "PARTNER"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 4814,
- "description": "Du Mobile payment 4.5 XTS",
- "details": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#009fd1",
- "service": {
- "id": "DU_ABUDHABI",
- "supplierId": "DU",
- "partnerId": "LOCAL_PAYMENT_HUB",
- "paymentType": "PREPAID",
- "groupId": "mobileTopup",
- "region": "Abu Dhabi",
- "status": "ACTIVE",
- "name": "Du Mobile",
- "parameters": {
- "consumerIdentifier": "+44987654321"
}
}
}
}
Look for cash deposit beneficiary account by phone number / account number and optional currency. Either phoneNumber
or accountNumber
must be provided.
phoneNumber | string Phone number to look for beneficiary by; either |
accountNumber | string Account number to look for beneficiary by; either |
currency | string Optional currency code to look for best-matching account by currency |
{- "phoneNumber": "+27653111146"
}
[- {
- "beneficiary": {
- "profileType": "INDIVIDUAL",
- "name": "Alex Kirano"
}, - "recipient": [
- {
- "type": "ACCOUNT",
- "accountId": "c0bcdba5-d72a-4322-9f3d-10410fa8617e",
- "accountNumber": "12345678910",
- "name": "Primary account",
- "currency": "USD"
}, - {
- "type": "EXTERNAL_ACCOUNT",
- "externalSourceId": "95e656f0-68d7-475f-9429-f7a6e0263ad4"
}
]
}
]
Calculates fees and performs other validations related to sending funds from a business customer account to individual customer account within the Tenant's space. As a result, a new Consent object is created. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned. Either paymentToken
or recipientAccountId
must be provided in request.
operationSubtype | string Optional operation subtype |
paymentToken | string Payment token string value; either |
recipientAccountId | string Recipient account ID; either |
senderAccountId required | string Sender account ID |
localUTCOffset | string <UTC> |
required | object (schema) Money object specified by value and currency |
comment | string |
{- "paymentToken": "e9b4a401-625c-4946-9e73-81a47c9c75fd",
- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
{- "id": "4fdaabb45-2988-41a4-aafr3848943",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:14+02:34",
- "operationType": "CASH_DEPOSIT",
- "sender": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "recipient": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -450,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -450,
- "currency": "XTS"
}, - "amount": {
- "value": -449,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -445.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -445.5,
- "currency": "XTS"
}, - "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -450,
- "currency": "XTS"
}
}, - {
- "category": "FEE",
- "description": "Service fees",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "ACQUIRING_FEE",
- "description": "Acquiring service fee",
- "amount": {
- "value": -1,
- "currency": "XTS"
}
}
], - "fees": [
- {
- "category": "FEE",
- "description": "Service fees",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": "6051",
- "details": {
- "senderName": "Elon M",
- "accountNumber": 192032381923,
- "icon": "fc892f7c-1b78-458d-9da8-8116781ad799",
- "color": "#7694E4",
- "location": {
- "name": "Outdoor Cafe",
- "address": {
- "city": "Dubai",
- "country": "AE",
- "postalCode": 0,
- "addressLine": "6660 Denesik Spring",
- "cityLocalized": "دبي"
}
}, - "terminal": {
- "id": "c6ad4fd1-a65c-44d5-aaee-0bd49f4400d8",
- "label": "T0001"
}, - "tradeName": "Leschberg Cafe Leschberg Cafe",
- "paymentToken": {
- "id": "22c752bd-9f87-48f0-baec-c77db76f3e91",
- "type": "DYNAMIC",
- "value": "22c752bd-9f87-48f0-baec-c77db76f3e91"
}
}
}
Re-validates all push cash deposit-related checks, including fees, based on updated inputs. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned
id required | string Consent id |
operationSubtype | string Optional operation subtype |
paymentToken required | string Payment token string from QR Code |
senderAccountId required | string |
localUTCOffset | string <UTC> |
required | object (schema) Money object specified by value and currency |
comment | string |
{- "paymentToken": "e9b4a401-625c-4946-9e73-81a47c9c75fd",
- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
{- "id": "4fdaabb45-2988-41a4-aafr3848943",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:14+02:34",
- "operationType": "CASH_DEPOSIT",
- "sender": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "recipient": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -450,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -450,
- "currency": "XTS"
}, - "amount": {
- "value": -449,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -445.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -445.5,
- "currency": "XTS"
}, - "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -450,
- "currency": "XTS"
}
}, - {
- "category": "FEE",
- "description": "Service fees",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "ACQUIRING_FEE",
- "description": "Acquiring service fee",
- "amount": {
- "value": -1,
- "currency": "XTS"
}
}
], - "fees": [
- {
- "category": "FEE",
- "description": "Service fees",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": "6051",
- "details": {
- "senderName": "Elon M",
- "accountNumber": 192032381923,
- "icon": "fc892f7c-1b78-458d-9da8-8116781ad799",
- "color": "#7694E4",
- "location": {
- "name": "Outdoor Cafe",
- "address": {
- "city": "Dubai",
- "country": "AE",
- "postalCode": 0,
- "addressLine": "6660 Denesik Spring",
- "cityLocalized": "دبي"
}
}, - "terminal": {
- "id": "c6ad4fd1-a65c-44d5-aaee-0bd49f4400d8",
- "label": "T0001"
}, - "tradeName": "Leschberg Cafe Leschberg Cafe",
- "paymentToken": {
- "id": "22c752bd-9f87-48f0-baec-c77db76f3e91",
- "type": "DYNAMIC",
- "value": "22c752bd-9f87-48f0-baec-c77db76f3e91"
}
}
}
consentId required | string |
{- "consentId": "72bed29e-e201-4a89-b17c-c2b66fd0a682"
}
{- "id": "916cca88-e637-46a2-9312-1dddb5098903.1601903307",
- "status": "COMPLETED",
- "consentId": "4fdaabb45-2988-41a4-aafr3848943",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "CASH_DEPOSIT",
- "headTransactionId": "4fdaabb45-2988-41a4-aafr3848943",
- "headOperationType": "CASH_DEPOSIT",
- "sender": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "recipient": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "baseAmount": {
- "value": -450,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -450,
- "currency": "XTS"
}, - "amount": {
- "value": -449,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -445.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -445.5,
- "currency": "XTS"
}, - "fees": [
- {
- "category": "FEE",
- "description": "Service fees",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -450,
- "currency": "XTS"
}
}, - {
- "category": "FEE",
- "description": "Service fees",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}, - {
- "category": "ACQUIRING_FEE",
- "description": "Acquiring service fee",
- "amount": {
- "value": -1,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": "6051",
- "details": {
- "senderName": "Elon M",
- "accountNumber": 192032381923,
- "icon": "fc892f7c-1b78-458d-9da8-8116781ad799",
- "color": "#7694E4",
- "location": {
- "name": "Outdoor Cafe",
- "address": {
- "city": "Dubai",
- "country": "AE",
- "postalCode": 0,
- "addressLine": "6660 Denesik Spring",
- "cityLocalized": "دبي"
}
}, - "terminal": {
- "id": "c6ad4fd1-a65c-44d5-aaee-0bd49f4400d8",
- "label": "T0001"
}, - "tradeName": "Leschberg Cafe Leschberg Cafe",
- "paymentToken": {
- "id": "22c752bd-9f87-48f0-baec-c77db76f3e91",
- "type": "DYNAMIC",
- "value": "22c752bd-9f87-48f0-baec-c77db76f3e91"
}
}
}
Calculates fees and performs other validations related to sending funds from a individual customer account to business customer account within the Tenant's space. As a result, a new Consent object is created. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned.
paymentToken required | string Payment token string from QR Code |
senderAccountId required | string |
localUTCOffset | string <UTC> |
required | object (amount) Money object specified by value and currency |
comment | string |
{- "paymentToken": "e9b4a401-625c-4946-9e73-81a47c9c75fd",
- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
{- "id": "4fdaabb45-2988-41a4-aafr3848943",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "operationType": "CASH_WITHDRAWAL",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "amount": {
- "value": -450,
- "currency": "XTS"
}, - "baseAmount": {
- "value": -450,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -454.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -454.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -450,
- "currency": "XTS"
}
}, - {
- "category": "ACQUIRING_FEE",
- "description": "Acquiring service fee",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": "6051",
- "description": "Cash withdrawal 25 your account with 450 XTS at Branch 98765",
- "details": {
- "terminal": {
- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "label": "A0004"
}, - "paymentToken": {
- "id": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "type": "DYNAMIC",
- "value": "d5c641c5-6678-4a92-970c-295f7777dac6"
}, - "tradeName": "Big Numbers",
- "location": {
- "name": "Branch 98765",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd"
}
}, - "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#7694E4"
}
}
Re-validates all push cash withdrawal-related checks, including fees, based on updated inputs. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned
id required | string Consent id |
paymentToken required | string Payment token string from QR Code |
senderAccountId required | string |
localUTCOffset | string <UTC> |
required | object (amount) Money object specified by value and currency |
comment | string |
{- "paymentToken": "e9b4a401-625c-4946-9e73-81a47c9c75fd",
- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
{- "id": "4fdaabb45-2988-41a4-aafr3848943",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "operationType": "CASH_WITHDRAWAL",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "amount": {
- "value": -450,
- "currency": "XTS"
}, - "baseAmount": {
- "value": -450,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -454.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -454.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -450,
- "currency": "XTS"
}
}, - {
- "category": "ACQUIRING_FEE",
- "description": "Acquiring service fee",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": "6051",
- "description": "Cash withdrawal 25 your account with 450 XTS at Branch 98765",
- "details": {
- "terminal": {
- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "label": "A0004"
}, - "paymentToken": {
- "id": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "type": "DYNAMIC",
- "value": "d5c641c5-6678-4a92-970c-295f7777dac6"
}, - "tradeName": "Big Numbers",
- "location": {
- "name": "Branch 98765",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd"
}
}, - "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#7694E4"
}
}
consentId required | string |
{- "consentId": "72bed29e-e201-4a89-b17c-c2b66fd0a682"
}
{- "id": "916cca88-e637-46a2-9312-1dddb5098903.1601903307",
- "status": "COMPLETED",
- "consentId": "4fdaabb45-2988-41a4-aafr3848943",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "CASH_WITHDRAWAL",
- "headTransactionId": "4fdaabb45-2988-41a4-aafr3848943",
- "headOperationType": "CASH_WITHDRAWAL",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "BUSINESS"
}, - "amount": {
- "value": -450,
- "currency": "XTS"
}, - "baseAmount": {
- "value": -450,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -454.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -454.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -454.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -450,
- "currency": "XTS"
}
}, - {
- "category": "ACQUIRING_FEE",
- "description": "Acquiring service fee",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": "6051",
- "description": "Cash withdrawal 25 your account with 450 XTS at Branch 98765",
- "details": {
- "terminal": {
- "id": "d5c641c5-6678-4a92-970c-66666667d",
- "label": "A0004"
}, - "paymentToken": {
- "id": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "type": "DYNAMIC",
- "value": "d5c641c5-6678-4a92-970c-295f7777dac6"
}, - "tradeName": "Big Numbers",
- "location": {
- "name": "Branch 98765",
- "address": {
- "country": "AE",
- "city": "Dubai",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd"
}
}, - "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#7694E4"
}
}
Calculates fees and currency exchange rates, performs other validations related to sending funds from one account to another within one profile (individual or business). As a result, two consent objects with one id are created because the same consent is applied to both accounts. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned.
senderAccountId required | string Source account id for authenticated profile |
recipientAccountId required | string Target account id for authenticated profile |
localUTCOffset | string <UTC> |
required | object (amount) Money object specified by value and currency |
comment | string |
{- "senderAccountId": "c0bcdba5-d72a-4322-9f3d-10410fa8617e",
- "recipientAccountId": "c0bcdba5-d72a-4322-9f3d-10410fa8617e",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": -45,
- "currency": "XTS"
}
}
[- {
- "id": "4fdaabb45-2988-41a4-aafr3848943",
- "status": "PENDING",
- "createdAt": "2020-11-03T16:29:34.569Z",
- "operationType": "OWN_ACCOUNTS_TRANSFER",
- "sender": {
- "accountNumber": "AE590005687632032280608",
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE490006780322364880427",
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "amount": {
- "value": -45,
- "currency": "XTS"
}, - "baseAmount": {
- "value": -45,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -45,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -45,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -45,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": "4829",
- "description": "Transfer 45 XTS from AE590005687632032280608 to AE490006780322364880427",
- "details": {
- "currencyConversion": {
- "recipient": {
- "ratesId": "4f77ebde-ad01-4314-8cc6-72cb1e6d72c3",
- "rate": 10
}
}
}
}, - {
- "id": "4fdaabb45-2988-41a4-aafr3848943",
- "status": "PENDING",
- "createdAt": "2020-11-03T16:29:34.569Z",
- "operationType": "OWN_ACCOUNTS_TRANSFER",
- "sender": {
- "accountNumber": "AE590005687632032280608",
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE490006780322364880427",
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "amount": {
- "value": 45,
- "currency": "XTS"
}, - "totalAmount": {
- "value": 450,
- "currency": "USD"
}, - "baseAmount": {
- "value": 45,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": 45,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": 450,
- "currency": "USD"
}
}
], - "merchantCategoryCode": "4829",
- "details": {
- "currencyConversion": {
- "recipient": {
- "ratesId": "4f77ebde-ad01-4314-8cc6-72cb1e6d72c3",
- "rate": 10
}
}
}, - "description": "Transfer 450 USD from AE590005687632032280608 to AE490006780322364880427"
}
]
Re-validates all own accounts transfer checks, including fees, based on updated inputs. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned
id required | string Consent id |
senderAccountId required | string Source account id for authenticated profile |
recipientAccountId required | string Target account id for authenticated profile |
localUTCOffset | string <UTC> |
required | object (amount) Money object specified by value and currency |
comment | string |
{- "senderAccountId": "c0bcdba5-d72a-4322-9f3d-10410fa8617e",
- "recipientAccountId": "c0bcdba5-d72a-4322-9f3d-10410fa8617e",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": -45,
- "currency": "XTS"
}
}
[- {
- "id": "4fdaabb45-2988-41a4-aafr3848943",
- "status": "PENDING",
- "createdAt": "2020-11-03T16:29:34.569Z",
- "operationType": "OWN_ACCOUNTS_TRANSFER",
- "sender": {
- "accountNumber": "AE590005687632032280608",
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE490006780322364880427",
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "amount": {
- "value": -45,
- "currency": "XTS"
}, - "baseAmount": {
- "value": -45,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -45,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -45,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -45,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": "4829",
- "description": "Transfer 45 XTS from AE590005687632032280608 to AE490006780322364880427",
- "details": {
- "currencyConversion": {
- "recipient": {
- "ratesId": "4f77ebde-ad01-4314-8cc6-72cb1e6d72c3",
- "rate": 10
}
}
}
}, - {
- "id": "4fdaabb45-2988-41a4-aafr3848943",
- "status": "PENDING",
- "createdAt": "2020-11-03T16:29:34.569Z",
- "operationType": "OWN_ACCOUNTS_TRANSFER",
- "sender": {
- "accountNumber": "AE590005687632032280608",
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE490006780322364880427",
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "amount": {
- "value": 45,
- "currency": "XTS"
}, - "totalAmount": {
- "value": 450,
- "currency": "USD"
}, - "baseAmount": {
- "value": 45,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": 45,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": 450,
- "currency": "USD"
}
}
], - "merchantCategoryCode": "4829",
- "details": {
- "currencyConversion": {
- "recipient": {
- "ratesId": "4f77ebde-ad01-4314-8cc6-72cb1e6d72c3",
- "rate": 10
}
}
}, - "description": "Transfer 450 USD from AE590005687632032280608 to AE490006780322364880427"
}
]
consentId required | string |
{- "consentId": "72bed29e-e201-4a89-b17c-c2b66fd0a682"
}
[- {
- "id": "6112f198-0bd6-4b91-997f-436edb7aea63.1604420981",
- "consentId": "4fdaabb45-2988-41a4-aafr3848943",
- "status": "COMPLETED",
- "createdAt": "2020-11-03T16:29:34.569Z",
- "postingDate": "2020-11-03",
- "operationType": "OWN_ACCOUNTS_TRANSFER",
- "headTransactionId": "4fdaabb45-2988-41a4-aafr3848943",
- "headOperationType": "OWN_ACCOUNTS_TRANSFER",
- "sender": {
- "accountNumber": "AE590005687632032280608",
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE490006780322364880427",
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "amount": {
- "value": -45,
- "currency": "XTS"
}, - "baseAmount": {
- "value": -45,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -45,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -45,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -45,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -45,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": "4829",
- "description": "Transfer 45 XTS from AE590005687632032280608 to AE490006780322364880427",
- "details": {
- "currencyConversion": {
- "recipient": {
- "ratesId": "4f77ebde-ad01-4314-8cc6-72cb1e6d72c3"
}
}
}
}, - {
- "id": "d75b0e50-28da-42e5-bf38-429d3e693828.1604420981",
- "consentId": "4fdaabb45-2988-41a4-aafr3848943",
- "status": "COMPLETED",
- "createdAt": "2020-11-03T16:29:34.569Z",
- "postingDate": "2020-11-03",
- "operationType": "OWN_ACCOUNTS_TRANSFER",
- "headTransactionId": "4fdaabb45-2988-41a4-aafr3848943",
- "headOperationType": "OWN_ACCOUNTS_TRANSFER",
- "sender": {
- "accountNumber": "AE590005687632032280608",
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": "AE490006780322364880427",
- "accountId": "1a76a6a8-c706-44b3-b008-3487538475983",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "amount": {
- "value": 45,
- "currency": "XTS"
}, - "baseAmount": {
- "value": 45,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": 45,
- "currency": "XTS"
}, - "totalAmount": {
- "value": 450,
- "currency": "USD"
}, - "postedAmount": {
- "value": 450,
- "currency": "USD"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": 450,
- "currency": "USD"
}
}
], - "merchantCategoryCode": "4829",
- "details": {
- "currencyConversion": {
- "recipient": {
- "ratesId": "4f77ebde-ad01-4314-8cc6-72cb1e6d72c3",
- "rate": 10
}
}
}, - "description": "Transfer 450 USD from AE590005687632032280608 to AE490006780322364880427"
}
]
Outgoing transaction to bank requisites (payout) initiated by individual or business end-user to payout to beneficiary - individual or company to bank requisites via partner account.
Verifies if payout payment service and partner account are valid.
serviceId | string Service id |
{- "serviceId": "SEPA"
}
{- "type": "PARTNER",
- "accountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "validity": "VALID"
}
Calculates fees and performs other validations related to sending funds from one individual customer account to another individual customer account within the Tenant's space. As a result, a new Consent object is created. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned.
senderAccountId required | string |
localUTCOffset | string <UTC> User mobile device locale time zone in ISO 8601 as an offset from UTC |
required | object (amount) Money object specified by value and currency |
required | object |
{- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": 4.5,
- "currency": "XTS"
}, - "service": {
- "id": "DU_ABUDHABI",
- "parameters": {
- "consumerIdentifier": "+44987654321"
}
}
}
{- "id": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:14+02:34",
- "operationType": "BILL_PAYMENT",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "PARTNER"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 4814,
- "description": "Du Mobile payment 4.5 XTS",
- "details": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#009fd1",
- "service": {
- "id": "DU_ABUDHABI",
- "supplierId": "DU",
- "partnerId": "LOCAL_PAYMENT_HUB",
- "paymentType": "PREPAID",
- "groupId": "mobileTopup",
- "region": "Abu Dhabi",
- "status": "ACTIVE",
- "name": "Du Mobile",
- "parameters": {
- "consumerIdentifier": "+44987654321"
}
}
}
}
Re-validates all person-to-person transfer-related checks, including fees, based on updated inputs. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned
id required | string Consent id |
senderAccountId required | string |
localUTCOffset | string <UTC> User mobile device locale time zone in ISO 8601 as an offset from UTC |
required | object (amount) Money object specified by value and currency |
required | object |
{- "senderAccountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "localUTCOffset": "+02:00",
- "amount": {
- "value": 4.5,
- "currency": "XTS"
}, - "service": {
- "id": "DU_ABUDHABI",
- "parameters": {
- "consumerIdentifier": "+44987654321"
}
}
}
{- "id": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "status": "PENDING",
- "createdAt": "2020-03-03T00:00:14+02:34",
- "operationType": "BILL_PAYMENT",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "PARTNER"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 4814,
- "description": "Du Mobile payment 4.5 XTS",
- "details": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#009fd1",
- "service": {
- "id": "DU_ABUDHABI",
- "supplierId": "DU",
- "partnerId": "LOCAL_PAYMENT_HUB",
- "paymentType": "PREPAID",
- "groupId": "mobileTopup",
- "region": "Abu Dhabi",
- "status": "ACTIVE",
- "name": "Du Mobile",
- "parameters": {
- "consumerIdentifier": "+44987654321"
}
}
}
}
consentId required | string |
{- "consentId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce"
}
{- "id": "b064ad54-c263-4cc4-b80f-123032f5c0f7.1601902273",
- "status": "COMPLETED",
- "headTransactionId": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "consentId": "72bed29e-e201-4a89-b17c-c2b66fd0a682",
- "createdAt": "2020-03-03T00:00:20+02:34",
- "postingDate": "2020-03-03",
- "operationType": "BILL_PAYMENT",
- "headOperationType": "BILL_PAYMENT",
- "sender": {
- "accountNumber": 192032381923,
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1",
- "profileType": "INDIVIDUAL"
}, - "recipient": {
- "accountNumber": 1920323819235,
- "accountId": "0db95881-2968-40e8-b194-d50e2b9c20a3",
- "profileId": "afa9b351-77e5-4c53-a3f2-7a696957ee2e",
- "profileType": "PARTNER"
}, - "baseAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "amount": {
- "value": -4.5,
- "currency": "XTS"
}, - "totalAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "postedAmount": {
- "value": -4.5,
- "currency": "XTS"
}, - "fees": [ ],
- "entries": [
- {
- "category": "TRANSACTION",
- "description": "TRANSACTION",
- "amount": {
- "value": -4.5,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": 4814,
- "description": "Du Mobile payment 4.5 XTS",
- "details": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#009fd1",
- "service": {
- "id": "DU_ABUDHABI",
- "supplierId": "DU",
- "partnerId": "LOCAL_PAYMENT_HUB",
- "paymentType": "PREPAID",
- "groupId": "mobileTopup",
- "region": "Abu Dhabi",
- "status": "ACTIVE",
- "name": "Du Mobile",
- "parameters": {
- "consumerIdentifier": "+44987654321"
}
}
}
}
Creates a new beneficary profile with specified phone number. Beneficiary profile is linked to Individual profile.
firstName | string Beneficiary First name |
lastName | string Beneficiary Last name |
phoneNumber required | string Beneficiary phone number |
country required | string Enum: "GB" "FR" "SA" "AE" "CH" Beneficiary residence Country in ISO 3166-1 alpha-2 . Value from country handbook. |
name | string Beneficiary full name |
type | string Default: "INDIVIDUAL" Enum: "INDIVIDUAL" "BUSINESS" Type of beneficiary |
{- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "country": "GB",
- "name": "string",
- "type": "INDIVIDUAL"
}
{- "id": "25394fa2-b60b-47d6-aa5d-af44ec8aa540",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileId": "9a0cf434-71c8-4422-a40c-d2e082e7cd0f",
- "name": "Benjamin Comondo",
- "country": "US",
- "phoneNumber": "+16507599755",
- "status": "ACTIVE",
- "createdAt": "2021-10-22T10:38:52.847905Z",
- "deleted": false,
- "lastName": "Comondo",
- "firstName": "Benjamin",
- "type": "INDIVIDUAL"
}
Get all remittance beneficiaries for an individual profile
page required | string Example: page=1 For pagination is supported offset-based pagination - |
perPage required | string Example: perPage=10 Number of rows on one page to be returned. Number of rows can range between 1 and 100, and the default is 10. |
[- {
- "id": "25394fa2-b60b-47d6-aa5d-af44ec8aa540",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileId": "9a0cf434-71c8-4422-a40c-d2e082e7cd0f",
- "name": "Benjamin Comondo",
- "country": "US",
- "phoneNumber": "+16507599755",
- "status": "ACTIVE",
- "createdAt": "2021-10-22T10:38:52.847905Z",
- "deleted": false,
- "lastName": "Comondo",
- "firstName": "Benjamin",
- "type": "INDIVIDUAL"
}, - {
- "id": "6b5a8a4f-d583-4db0-923f-ed53512012cb",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileId": "9a0cf434-71c8-4422-a40c-d2e082e7cd0f",
- "name": "Benjamin Comondo",
- "country": "US",
- "phoneNumber": "+16507596346",
- "status": "ACTIVE",
- "createdAt": "2021-10-22T11:10:00.709632Z",
- "deleted": false,
- "lastName": "Comondo",
- "firstName": "Benjamin",
- "type": "INDIVIDUAL"
}
]
Get remittance beneficiary for individual profile
id required | string beneficiary record id |
{- "id": "25394fa2-b60b-47d6-aa5d-af44ec8aa540",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileId": "9a0cf434-71c8-4422-a40c-d2e082e7cd0f",
- "name": "Benjamin Comondo",
- "country": "US",
- "phoneNumber": "+16507599755",
- "status": "ACTIVE",
- "createdAt": "2021-10-22T10:38:52.847905Z",
- "deleted": false,
- "lastName": "Comondo",
- "firstName": "Benjamin",
- "type": "INDIVIDUAL"
}
Edit beneficiary for remittance
id required | string beneficiary record id |
firstName | string Beneficiary First name |
lastName | string Beneficiary Last name |
phoneNumber required | string Beneficiary phone number |
country required | string Enum: "GB" "FR" "SA" "AE" "CH" Beneficiary residence Country in ISO 3166-1 alpha-2 . Value from country handbook. |
name | string Beneficiary full name |
type | string Default: "INDIVIDUAL" Enum: "INDIVIDUAL" "BUSINESS" Type of beneficiary |
{- "firstName": "string",
- "lastName": "string",
- "phoneNumber": "string",
- "country": "GB",
- "name": "string",
- "type": "INDIVIDUAL"
}
{- "id": "25394fa2-b60b-47d6-aa5d-af44ec8aa540",
- "solutionId": "9cf50459-5d19-4a07-867b-1ed033d4174e",
- "profileId": "9a0cf434-71c8-4422-a40c-d2e082e7cd0f",
- "name": "Benjamin Comondo",
- "country": "US",
- "phoneNumber": "+16507599755",
- "status": "ACTIVE",
- "createdAt": "2021-10-22T10:38:52.847905Z",
- "deleted": false,
- "lastName": "Comondo",
- "firstName": "Benjamin",
- "type": "INDIVIDUAL"
}
Marks beneficiary for payout as deleted true
id required | string beneficiary record id |
{- "type": "ACCESS_ERROR",
- "code": "ADDITIONAL_AUTHENTICATION_REQUIRED",
- "message": "Additional authentication required",
- "details": {
- "mfa": [
- "SECRET_WORD",
- "KEY",
- "PASSWORD"
]
}
}
Calculates fees and performs other validations related to sending funds from one individual customer to another individual that is not within the Tenant's space. As a result, a new Consent object is created.
recipientCountry required | string Enum: "GB" "FR" "SA" "AE" "CH" Money remittance beneficiary country in ISO 3166-1 alpha-2 |
senderExternalSourceType | string |
senderAccountId | string |
recipientCurrency | string Currency code in ISO 4217 alfa-3 format |
beneficiaryId required | string <uuid> |
object | |
required | object |
comment | string |
{- "recipientCountry": "AE",
- "senderExternalSourceType": "string",
- "senderAccountId": "string",
- "recipientCurrency": "AED",
- "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
- "details": {
- "purposeOfTransaction": "Saving/Investment",
- "sourceOfFunds": "Borrowed Funs/Loan"
}, - "beneficiaryAmount": {
- "value": 10,
- "currency": "AED"
}, - "comment": "New comment"
}
{- "id": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "PENDING",
- "createdAt": "2019-08-24T14:15:22Z",
- "operationType": "P2P_TRANSFER",
- "operationSubtype": "SUPERCASH",
- "sender": {
- "accountNumber": 192032381923,
- "externalSourceType": "string",
- "externalSourceId": "a436bf2a-dabf-4e13-b7f8-1eabbeceabf5",
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileType": "INDIVIDUAL",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1"
}, - "recipient": {
- "accountNumber": 192032381933,
- "accountId": "d5cdac6-295f7777-4a92-970c-6678641c5",
- "profileType": "INDIVIDUAL",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1"
}, - "baseAmount": {
- "value": 0,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": 0,
- "currency": "XTS"
}, - "amount": {
- "value": 0,
- "currency": "XTS"
}, - "totalAmount": {
- "value": 0,
- "currency": "XTS"
}, - "fees": [
- {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": 0,
- "currency": "XTS"
}
}
], - "entries": [
- {
- "category": "TRANSACTION",
- "description": "string",
- "amount": {
- "value": 0,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": "6538",
- "description": "Transfer 4,5 XTS to Elon M with comment \"Thanks for lunch\"",
- "originator": {
- "solutionId": "9ff66092-33fb-498c-8123-e85aa68facfe",
- "name": "Leonhard Euler",
- "profileType": "INDIVIDUAL",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1"
}, - "payer": {
- "solutionId": "9ff66092-33fb-498c-8123-e85aa68facfe",
- "name": "Leonhard Euler",
- "profileType": "INDIVIDUAL",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1"
}, - "details": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ff80b3",
- "currencyConversion": {
- "sender": {
- "ratesId": "57c400dd-e7df-4ff2-a0dc-b54739a3888c",
- "rate": 3.8
}
}, - "service": {
- "id": "string",
- "name": "string",
- "partnerId": "LOCAL_PAYMENT_HUB",
- "parameters": {
- "property1": "string",
- "property2": "string"
}
}, - "senderExternalSource": { },
- "deal": {
- "beneficiaryAmount": {
- "value": 0,
- "currency": "XTS"
}, - "remitterAmount": {
- "value": 0,
- "currency": "XTS"
}, - "senderCountry": "ZA",
- "recipientCountry": "MW",
- "beneficiary": {
- "id": "string",
- "solutionId": "string",
- "profileId": "string",
- "name": "string",
- "country": "AE",
- "phoneNumber": "string",
- "status": "ACTIVE",
- "deleted": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "lastName": "string",
- "firstName": "string",
- "type": "INDIVIDUAL",
- "accountId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "validity": "VALID",
- "details": {
- "tradeName": "string",
- "terminalLabel": "string",
- "icon": "string",
- "color": "string",
- "location": {
- "name": "string",
- "address": {
- "country": "AE",
- "region": "string",
- "city": "Dubai",
- "cityLocalized": "دبي",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "building": "Burj Khalifa",
- "note": "the tallest structure and building in the world",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727",
- "plusCode": "7HQQ57WF+VP"
}
}
}, - "recipientName": "Elon M",
- "recipientAccountNumber": "string",
- "recipientPhoneNumber": "+441******442",
- "comment": "Thanks for lunch"
}
}, - "remitter": {
- "profileId": "fd9eebe7-2188-449e-8317-ad3ec15a51c7",
- "profileType": "INDIVIDUAL",
- "solutionId": "9ff66092-33fb-498c-8123-e85aa68facfe",
- "phoneNumber": "string",
- "lastName": "string",
- "firstName": "string"
}
}
}
}
Re-validates all money remittance transfer checks, including fees, based on updated inputs. If the source account does not have enough funds for transfer, including fees, then error “Insufficient Funds” is returned.
id required | string The ID of the concent |
recipientCountry required | string Enum: "GB" "FR" "SA" "AE" "CH" Money remittance beneficiary country in ISO 3166-1 alpha-2 |
senderExternalSourceType | string |
senderAccountId | string |
recipientCurrency | string Currency code in ISO 4217 alfa-3 format |
beneficiaryId required | string <uuid> |
object | |
required | object |
comment | string |
{- "recipientCountry": "AE",
- "senderExternalSourceType": "string",
- "senderAccountId": "string",
- "recipientCurrency": "AED",
- "beneficiaryId": "410e5c37-9603-4e5b-81b1-7cb895f362e8",
- "details": {
- "purposeOfTransaction": "Saving/Investment",
- "sourceOfFunds": "Borrowed Funs/Loan"
}, - "beneficiaryAmount": {
- "value": 10,
- "currency": "AED"
}, - "comment": "New string"
}
{- "id": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "status": "PENDING",
- "createdAt": "2019-08-24T14:15:22Z",
- "operationType": "P2P_TRANSFER",
- "operationSubtype": "SUPERCASH",
- "sender": {
- "accountNumber": 192032381923,
- "externalSourceType": "string",
- "externalSourceId": "a436bf2a-dabf-4e13-b7f8-1eabbeceabf5",
- "accountId": "d5c641c5-6678-4a92-970c-295f7777dac6",
- "profileType": "INDIVIDUAL",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1"
}, - "recipient": {
- "accountNumber": 192032381933,
- "accountId": "d5cdac6-295f7777-4a92-970c-6678641c5",
- "profileType": "INDIVIDUAL",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1"
}, - "baseAmount": {
- "value": 0,
- "currency": "XTS"
}, - "instructedAmount": {
- "value": 0,
- "currency": "XTS"
}, - "amount": {
- "value": 0,
- "currency": "XTS"
}, - "totalAmount": {
- "value": 0,
- "currency": "XTS"
}, - "fees": [
- {
- "category": "FEE",
- "description": "Bank Service",
- "amount": {
- "value": 0,
- "currency": "XTS"
}
}
], - "entries": [
- {
- "category": "TRANSACTION",
- "description": "string",
- "amount": {
- "value": 0,
- "currency": "XTS"
}
}
], - "merchantCategoryCode": "6538",
- "description": "Transfer 4,5 XTS to Elon M with comment \"Thanks for lunch\"",
- "originator": {
- "solutionId": "9ff66092-33fb-498c-8123-e85aa68facfe",
- "name": "Leonhard Euler",
- "profileType": "INDIVIDUAL",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1"
}, - "payer": {
- "solutionId": "9ff66092-33fb-498c-8123-e85aa68facfe",
- "name": "Leonhard Euler",
- "profileType": "INDIVIDUAL",
- "profileId": "521c474a-ebb3-4c7a-aaa1-ac078c035ec1"
}, - "details": {
- "icon": "afb24091-a769-4b7f-b6a3-4ed531be471f",
- "color": "#ff80b3",
- "currencyConversion": {
- "sender": {
- "ratesId": "57c400dd-e7df-4ff2-a0dc-b54739a3888c",
- "rate": 3.8
}
}, - "service": {
- "id": "string",
- "name": "string",
- "partnerId": "LOCAL_PAYMENT_HUB",
- "parameters": {
- "property1": "string",
- "property2": "string"
}
}, - "senderExternalSource": { },
- "deal": {
- "beneficiaryAmount": {
- "value": 0,
- "currency": "XTS"
}, - "remitterAmount": {
- "value": 0,
- "currency": "XTS"
}, - "senderCountry": "ZA",
- "recipientCountry": "MW",
- "beneficiary": {
- "id": "string",
- "solutionId": "string",
- "profileId": "string",
- "name": "string",
- "country": "AE",
- "phoneNumber": "string",
- "status": "ACTIVE",
- "deleted": false,
- "createdAt": "2019-08-24T14:15:22Z",
- "lastName": "string",
- "firstName": "string",
- "type": "INDIVIDUAL",
- "accountId": "4fd8c5c2-2988-41a4-add2-5c330de1ffce",
- "validity": "VALID",
- "details": {
- "tradeName": "string",
- "terminalLabel": "string",
- "icon": "string",
- "color": "string",
- "location": {
- "name": "string",
- "address": {
- "country": "AE",
- "region": "string",
- "city": "Dubai",
- "cityLocalized": "دبي",
- "postalCode": "0000",
- "addressLine": "1 Sheikh Mohammed bin Rashid Blvd",
- "building": "Burj Khalifa",
- "note": "the tallest structure and building in the world",
- "geolocation": {
- "latitude": "25.19751",
- "longitude": "55.2727",
- "plusCode": "7HQQ57WF+VP"
}
}
}, - "recipientName": "Elon M",
- "recipientAccountNumber": "string",
- "recipientPhoneNumber": "+441******442",
- "comment": "Thanks for lunch"
}
}, - "remitter": {
- "profileId": "fd9eebe7-2188-449e-8317-ad3ec15a51c7",
- "profileType": "INDIVIDUAL",
- "solutionId": "9ff66092-33fb-498c-8123-e85aa68facfe",
- "phoneNumber": "string",
- "lastName": "string",
- "firstName": "string"
}
}
}
}
consentId required | string |
{- "consentId": "72bed29e-e201-4a89-b17c-c2b66fd0a682"
}
{- "id": "8f013d73-5609-478a-b8b3-11f8572c81b9.1659984688",
- "beneficiaryAmount": {
- "currency": "XAF",
- "value": 100
}, - "remitterAmount": {
- "currency": "AED",
- "value": 2.99
}, - "details": { },
- "remitter": {
- "lastName": "Bond",
- "firstName": "Glennie",
- "profileId": "c62b19ea-f29e-4dca-987c-64f497114971",
- "solutionId": "c65568fb-0aa4-42a6-843d-eef214a13545",
- "phoneNumber": "+971793545216",
- "profileType": "INDIVIDUAL"
}, - "beneficiary": {
- "id": "41df110d-64d9-4341-90a1-a300001d916d",
- "country": "CM",
- "lastName": "Dow",
- "firstName": "John",
- "phoneNumber": "+237676641000"
}, - "senderCountry": "AE",
- "recipientCountry": "CM",
- "recipientCurrency": "XAF"
}
Get payment services available for remittance payout
[- {
- "id": "example_rp",
- "operationType": "REMITTANCE_PAYOUT",
- "name": "Cash Remittance Payout",
- "branding": {
- "icon": "401ce1e6-6412-49c9-b173-5584adbdb21b",
- "color": "#009fd1"
}, - "status": "ACTIVE",
- "amount": {
- "XAF": {
- "min": 10,
- "max": 1000,
- "denomination": -1,
- "hint": "Amount shall be between 10 and 100 XAF"
}
}
}
]