API docs by Redocly

nFront APIs (1.0.0)

In this catalog you can find all nFront APIs.

OAuth 2.0

This section includes authorization APIs.

Sign in using custom token

This endpoint will validate an incoming OAuth2 token from returned fresh oauth access token.

Authorizations:
x-consumer-usernameoauth
Request Body schema: application/x-www-form-urlencoded
required
custom_token
required
string

The custom token.

custom_token_provider
string

The custom token provider.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "access_token": "4E4F54205245414C2044415441202D207468697320",
  • "token_type": "bearer",
  • "expires_in": 3600,
  • "refresh_token": "4E4F54205245414C2044415441202D207468697320",
  • "refresh_expires_in": 3600,
  • "scope": "Token scope"
}

Refresh access token

This endpoint will request a new access token or refresh an existing one from OAuth2 service.

Authorizations:
x-consumer-usernameoauth
Request Body schema: application/x-www-form-urlencoded
refresh_token
string

The refresh token.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "access_token": "4E4F54205245414C2044415441202D207468697320",
  • "token_type": "bearer",
  • "expires_in": 3600,
  • "refresh_token": "4E4F54205245414C2044415441202D207468697320",
  • "refresh_expires_in": 3600,
  • "scope": "Token scope"
}

Sign-up

This section includes sign-up APIs.

Verify sign-up user creation

This API is used to verify sign-up user creation.

Authorizations:
x-consumer-usernameoauth
header Parameters
x-nfront-device-id
required
string

Device ID.

channel
required
string

The channel.

otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

Request Body schema: application/json
required
notification_email
string <= 80 characters

Notification email.

required
object (SignupIdentification)

Sign-up identification.

Responses

Request samples

Content type
application/json
{
  • "notification_email": "example@gmail.com",
  • "identification": {
    }
}

Create sign-up user

This API is used to create sign-up user.

Authorizations:
x-consumer-usernameoauth
header Parameters
x-nfront-device-id
required
string

Device ID.

channel
required
string

The channel.

Request Body schema: application/json
required
username
required
string

The user name.

password
string

The password.

passcode
string

The passcode.

register_trusted_device
boolean

This field indicates whether trusted device is registered.

device_name
string

The device name.

otp_id
required
string

OTP ID.

notification_email
string <= 80 characters

Notification email.

required
object (SignupIdentification)

Sign-up identification.

Responses

Request samples

Content type
application/json
{
  • "username": "John",
  • "password": "12345",
  • "passcode": "3453",
  • "register_trusted_device": true,
  • "device_name": "SAMSUNG",
  • "otp_id": "39573047680-486",
  • "notification_email": "example@gmail.com",
  • "identification": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d0cd4a54-39af-49c6-9d55-c8112a613a8a",
  • "user": {
    },
  • "flow": "initialization",
  • "access_token": {
    },
  • "trusted_device": true,
  • "available_auth_methods": [
    ]
}

Verify password reset

This API is used to verify password reset.

Authorizations:
x-consumer-usernameoauth
header Parameters
x-nfront-device-id
required
string

Device ID.

channel
required
string

The channel.

otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

Request Body schema: application/json
required
username
required
string

The user name.

required
object (SignupIdentification)

Sign-up identification.

Responses

Request samples

Content type
application/json
{
  • "username": "John",
  • "identification": {
    }
}

Reset password

This API is used to reset password.

Authorizations:
x-consumer-usernameoauth
header Parameters
x-nfront-device-id
required
string

Device ID.

channel
required
string

The channel.

Request Body schema: application/json
required
username
required
string

The user name.

password
string

The password.

passcode
string

The passcode.

otp_id
required
string

OTP ID.

required
object (SignupIdentification)

Sign-up identification.

Responses

Request samples

Content type
application/json
{
  • "username": "John",
  • "password": "12345",
  • "passcode": "3453",
  • "otp_id": "39573047680-486",
  • "identification": {
    }
}

Check username availability

This API is used to check username availability.

Authorizations:
x-consumer-usernameoauth
path Parameters
username
required
string

The username.

Responses

Load active password policy

This API is used to load active password policy.

Authorizations:
x-consumer-usernameoauth

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Initiate authentication flow

This API is used to initiate authentication flow.

Authorizations:
x-consumer-usernameoauth
header Parameters
x-nfront-device-id
required
string

Device ID.

channel
required
string

The channel.

otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

Request Body schema: application/json
required
object (SignupIdentification)

Sign-up identification.

username
string

The user name.

password
string

The password.

passcode
string

The passcode.

register_trusted_device
boolean

This field indicates whether trusted device is registered.

device_name
string

The device name.

biometrics_token
string

The biometrics token.

biometrics_id
string

The biometrics ID.

Responses

Request samples

Content type
application/json
{
  • "identification": {
    },
  • "username": "John",
  • "password": "12345",
  • "passcode": "3453",
  • "register_trusted_device": true,
  • "device_name": "SAMSUNG",
  • "biometrics_token": "3068304986034860938908907",
  • "biometrics_id": "67cd4a54-39af-49c6-9d55-c8112a613a8a"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d0cd4a54-39af-49c6-9d55-c8112a613a8a",
  • "user": {
    },
  • "flow": "initialization",
  • "access_token": {
    },
  • "trusted_device": true,
  • "available_auth_methods": [
    ]
}

Verify login

This API is used to verify login.

Authorizations:
x-consumer-usernameoauth
header Parameters
x-nfront-device-id
required
string

Device ID.

channel
required
string

The channel.

otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

Request Body schema: application/json
required
username
string

The user name.

object (SignupIdentification)

Sign-up identification.

Responses

Request samples

Content type
application/json
{
  • "username": "John",
  • "identification": {
    }
}

Continue flow with password change

This API is used to continue flow with password change.

Authorizations:
x-consumer-usernameoauth
path Parameters
session_id
required
string

Session ID.

header Parameters
x-nfront-device-id
required
string

Device ID.

Request Body schema: application/json
required
old_password
string

The old password.

old_passcode
string

The old passcode.

new_password
string

The new password.

new_passcode
string

The new passcode.

Responses

Request samples

Content type
application/json
{
  • "old_password": "12345",
  • "old_passcode": "1234",
  • "new_password": "505087",
  • "new_passcode": "9797"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d0cd4a54-39af-49c6-9d55-c8112a613a8a",
  • "user": {
    },
  • "flow": "initialization",
  • "access_token": {
    },
  • "trusted_device": true,
  • "available_auth_methods": [
    ]
}

Extend auth with refresh token

This API is used to extend auth with refresh token.

Authorizations:
x-consumer-usernameoauth
path Parameters
session_id
required
string

Session ID.

header Parameters
x-nfront-device-id
required
string

Device ID.

Request Body schema: application/x-www-form-urlencoded
refresh_token
string

Refresh token.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "token": "309630946034960",
  • "refresh_token": "308645409860587",
  • "expires_in": 120,
  • "refresh_expires_in": 900,
  • "scopes": [
    ]
}

Invalidate session

This API is used to invalidate session.

Authorizations:
x-consumer-usernameoauth
path Parameters
session_id
required
string

Session ID.

Responses

Decode onboarding token

This API is used to decode onboarding token.

Authorizations:
x-consumer-usernameoauth
path Parameters
token
required
string

The token.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "username": "John",
  • "parent_user_id": "6688bf36-9356-4437-a11f-b2e425556096",
  • "is_minor": false,
  • "issue_date": "2024-05-04T19:42:23.987Z",
  • "expiry_date": "2025-05-04T19:42:23.987Z"
}

Generate biometrics nonce

This API is used to generate biometrics nonce.

Authorizations:
x-consumer-usernameoauth
header Parameters
x-nfront-device-id
required
string

Device ID.

Request Body schema: application/json
required
object (SignupIdentification)

Sign-up identification.

username
string

The user name.

Responses

Request samples

Content type
application/json
{
  • "identification": {
    },
  • "username": "John"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "5e18bf36-9356-4437-a11f-b2e425556096",
  • "nonce": "X2N1cnJ...Q"
}

Transactions

This section includes transaction releated APIs.

Search for Nymcard transactions

This API is used to search for transactions.

Authorizations:
oauth
Request Body schema: application/json
required
query
string

A search query.

sort_by
string

The way results should be sorted.

order_by
string (SortDirection)
Enum: "asc" "desc"

The way results should be ordered (ascending or descending).

matcher
string (SearchMatcher)
Enum: "and" "or"

Search matcher.

Array of objects (SearchFilter)

An array of search filters.

object (Cursors)

Cursors

limit
integer <int32>

Search limit.

Responses

Request samples

Content type
application/json
{
  • "query": "Transfer",
  • "sort_by": "By name",
  • "order_by": "asc",
  • "matcher": "and",
  • "filters": [
    ],
  • "cursors": {
    },
  • "limit": 0
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "5efbb708-0558-47ac-b722-4e30b176fb4f",
  • "transaction_timestamp": "2021-06-17T13:56:48.000Z",
  • "parent_transaction_id": "5efss708-0458-47ac-b722-4e30b1744b4f",
  • "network": "VISA",
  • "message_type": "AUTHORIZATION",
  • "transaction_type": "PURCHASE",
  • "transaction_description": "Purchase",
  • "transmission_date_time": "2018-01-02T19:42:32.987Z",
  • "date_time_acquirer": "2018-01-02T19:42:32.987Z",
  • "card_id": "45678912314567891231456789123121",
  • "card_first_6_digits": "494964",
  • "card_last_4_digits": "6404",
  • "card_expiry_date": "052022",
  • "user_id": "5c0afa53-6ec0-4b08-a180-199352385c9b",
  • "account_id1": "5c0sds53-6ec0-4b08-a180-199352385c9b",
  • "card_product_1": "dfgafa53-6ec0-4b08-a180-199352385c9b",
  • "account_id2": "thfafa53-6ec0-4b08-a180-199352385c9b",
  • "card_product_2": "8uhafa53-6ec0-4b08-a180-199352385c9b",
  • "acquirer_id": "12345678901",
  • "merchant_id": "CARD ACCEPTOR",
  • "mcc": "5947",
  • "merchant_name": "ACQUIRER NAME",
  • "merchant_city": "CITY NAME",
  • "merchant_country": "USA",
  • "terminal_id": "TERMID01",
  • "stan": "000042",
  • "rrn": "116813000042",
  • "auth_id_response": "476628",
  • "network_transaction_id": "234551234561008",
  • "transaction_amount": 4,
  • "transaction_currency": "USD",
  • "billing_amount": 4,
  • "billing_currency": "USD",
  • "billing_amount_account": 4,
  • "billing_currency_account": "USD",
  • "conversion_rate_billing_account": 4,
  • "acquirer_fee_amount": 2,
  • "conversion_rate_billing": "61000000",
  • "fee_amount": 2,
  • "fee_details": [
    ],
  • "original_amount": 2,
  • "original_amount_billing": "4",
  • "status_code": "0000",
  • "status_description": "Transaction approved",
  • "transfer_id": "234551234561008",
  • "load_id": "234556734561008",
  • "unload_id": "234551234561008",
  • "eci": "05",
  • "ecommerce_security_level": "3DS1",
  • "card_entry": "Physical entry",
  • "pos_environment": "E-Commerce",
  • "fallback": false,
  • "pin_present": false,
  • "moto": false,
  • "recurring": false,
  • "installment_transaction": false,
  • "auth_expired_at": "2018-01-02T19:42:32.987Z",
  • "auth_expired_by": "AUTO",
  • "is_reversed": "YES",
  • "is_settled": "NO",
  • "source_channel": "DAPI",
  • "notes": "Performing operation for 12.50 USD",
  • "sender_user_id": "hkuser282",
  • "external_reference_number": "2b2c3e7c-a07c-11ed-a8fc-0242ac120002",
  • "external_reference_date": "2018-01-02T19:42:32.987Z",
  • "reference_number": "04a466da-cbab-11ed-afa1-0242ac120002",
  • "sweep_details": [
    ],
  • "type": "HOLD",
  • "quote_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "receiver_user_id": "g157a80f-e641-7745-8a80-99841e4a1234"
}

Accounts

This section includes account releated APIs.

Get list of accounts

This API is used to retrieve all existitng accounts.

Authorizations:
oauth
query Parameters
user_id
required
string
Example: user_id=3392abea-4ef6-4645-b254-d8ace60281af

The unique identifier of the user

currency
string^[A-Z]{3}$

The currency.

type
string
Example: type=MASTER

The type of the account.

limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "MjAxOC0wMS0wMlQxOTo0MjozMi45ODda",
  • "has_more": true,
  • "data": [
    ]
}

Create account

This API is used to create a new account.

Authorizations:
oauth
Request Body schema: application/json
required
id
string <= 36 characters

The unique identifier of the account. If this information is not present in the request,the system generates one automatically.

user_id
required
string

The unique identifier of the user.

card_product_id
required
string

The unique identifier of the card product. This token ID is referred to as an existing card product.

type
required
string (AccountType)
Enum: "PREPAID" "DEBIT" "CREDIT" "SAVINGS" "COLLATERAL" "SECURITY" "MASTER"

Supported account types.

currencies
Array of strings

An array of currencies. It is used to create account with several currencies. If currency is not passed in this API, account is created with only 1 currency (base currency).

Responses

Request samples

Content type
application/json
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "gg5a80f-e641-4045-8a80-54841e4a55555",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "type": "PREPAID",
  • "currencies": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "gg5a80f-e641-4045-8a80-54841e4a55555",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "type": "PREPAID",
  • "subType": "REVOLVING",
  • "balances": {
    },
  • "ledger_balances": {
    },
  • "status": "ACTIVE",
  • "currencies": [
    ],
  • "wallet_details": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "modified_by": "API"
}

Get account details

This API is used to retrieve a specific account details.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the account.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "gg5a80f-e641-4045-8a80-54841e4a55555",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "type": "PREPAID",
  • "subType": "REVOLVING",
  • "balances": {
    },
  • "ledger_balances": {
    },
  • "status": "ACTIVE",
  • "currencies": [
    ],
  • "wallet_details": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "modified_by": "API"
}

Update account

This API is used to update a specific account.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the account.

Request Body schema: application/json
required

Wallet details.

Array of objects (WalletDetails)

An array of wallet details.

Responses

Request samples

Content type
application/json
{
  • "wallet_details": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "gg5a80f-e641-4045-8a80-54841e4a55555",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "type": "PREPAID",
  • "subType": "REVOLVING",
  • "balances": {
    },
  • "ledger_balances": {
    },
  • "status": "ACTIVE",
  • "currencies": [
    ],
  • "wallet_details": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "modified_by": "API"
}

Transfer funds between accounts

This API is used to transfer funds from one account to another account.

Authorizations:
oauth
header Parameters
X-Nymos-Idempotency-Key
required
string <= 36 characters

Idempotency key.

otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user authentication info.

x-nfront-device-id
string

Device ID.

Request Body schema: application/json
required
sender_account_id
required
string

Sender account Identifier.

recipient_account_id
required
string

Recipient account Identifier.

amount
required
number <decimal> >= 0

Amount which should be transfered.

currency
required
string^[A-Z]{3}

3-letter ISO_4217 code representing the currency.

notes
string

Notes about performed transfer request.

dry_run
boolean
Default: false

This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false and the default value is false.

Responses

Request samples

Content type
application/json
{
  • "sender_account_id": "bc121529-e6e9-45f1-b820-8c46ce7f005a",
  • "recipient_account_id": "39dbff34-5505-4181-9e81-727b71e72186",
  • "amount": 12.5,
  • "currency": "USD",
  • "notes": "Performing operation for 12.50 USD",
  • "dry_run": false
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "transaction_id": "123456789012",
  • "sender_account_id": "bc121529-e6e9-45f1-b820-8c46ce7f005a",
  • "recipient_account_id": "39dbff34-5505-4181-9e81-727b71e72186",
  • "amount": 12.5,
  • "sender_user_id": "hkuser282",
  • "currency": "USD",
  • "fee_amount": 2.5,
  • "fee_details": [
    ],
  • "notes": "Performing operation for 12.50 USD\"",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "source_channel": "DAPI",
  • "receiver_user_id": "g157a80f-e641-7745-8a80-99841e4a1234"
}

Get list of transfers

This API is used to retrieve the list of transfers.

Authorizations:
oauth
query Parameters
sender_account_id
string

Sender account Identifier.

recipient_account_id
string

Recipient account Identifier.

transfer_date_time_start
string <date-time>

Date time created from.

transfer_date_time_end
string <date-time>

Date time created to.

limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Get account balances

This API is used to retrieve the account balances.

Authorizations:
oauth
query Parameters
user_id
string

The user ID.

account_id
string

The account ID.

period
required
string
Value: "CURRENT_MONTH"

The time period.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "user_id": "f482b638-62d2-4df6-b302-14507971ab7c",
  • "account_id": "75c272e5-0427-47f4-b03d-dec32880bca6",
  • "period": "CURRENT_MONTH",
  • "balances": [
    ]
}

Get cards related to account

This API is used to retrieve cards which are linked to the account.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the account.

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "f9dc8fb0-ba5b-4d61-83df-7ab821fd02d5"
]

Link cards to account

This API is used to link cards to the specific account.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the account.

Request Body schema: application/json
required
ids
required
Array of strings

The unique identifier or the proxy number of the card(s).

dry_run
required
boolean
Default: false

This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false, and the default value is false.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "dry_run": false
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "f9dc8fb0-ba5b-4d61-83df-7ab821fd02d5"
]

Create custom balance limit for account

This API can be used to create custom balance limit for account.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the account.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user authentication info.

x-nfront-device-id
string

Device ID.

Request Body schema: application/json
required
active
boolean
Default: true

This parameter defines whether the balance limits are going to be activated or not at the time of its creation. By default the balance limit is activated on its creation.

min_amount
required
number <decimal> [ 0 .. 999999999999 ]

The minimum amount of a transaction.

max_amount
required
number <decimal> [ 0 .. 999999999999 ]

The maximum amount of a transaction.

description
required
string <= 40 characters

Some additional info.

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "min_amount": 999999999999,
  • "max_amount": 999999999999,
  • "description": "Some info"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the balance limit",
  • "active": true,
  • "type": "PER_ACCOUNT",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Update custom balance limit for account

This API can be used to update custom balance limit for account.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the account.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user authentication info.

x-nfront-device-id
string

Device ID.

Request Body schema: application/json
required
id
string

Custom balance limit ID.

active
boolean

This parameter defines whether the balance limits are going to be activated or not at the time of its creation. By default the balance limit is activated on its creation.

min_amount
number <decimal> [ 0 .. 999999999999 ]

The minimum balance an account can hold.

max_amount
number <decimal> [ 0 .. 999999999999 ]

The maximum balance an account can hold.

description
string <= 40 characters

The name of the balance limit. We recommend using a unique string.

Responses

Request samples

Content type
application/json
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "active": true,
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "description": "Some description of the balance limit"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the balance limit",
  • "active": true,
  • "type": "PER_ACCOUNT",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Card products

This section includes card product releated APIs.

Get specific card product

This API is used to get specific card product.

Authorizations:
oauth
path Parameters
id
required
string

The card product ID.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the card product",
  • "product_category": "string",
  • "status": "INACTIVE",
  • "currency_settings": [
    ],
  • "card_settings": {
    },
  • "credit_settings": {
    },
  • "account_settings": {
    },
  • "pin_settings": {
    },
  • "auth_settings": {
    },
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "pan_format_token": "default_pan_format",
  • "track_format_token": "default_track_format",
  • "proxy_format_token": "default_proxy_format",
  • "type": "PREPAID",
  • "sub_type": "SECURE",
  • "is_multi_currency_product": true,
  • "wallet_settings": {
    },
  • "fxrates_settings": [
    ]
}

Get velocity limits of card product

This API is used to get list of velocity limits of a specific card product.

Authorizations:
oauth
path Parameters
id
required
string

The card product ID.

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Get balance limits of card product

This API is used to get list of balance limits of a specific card product.

Authorizations:
oauth
path Parameters
id
required
string

The card product ID.

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Get card product charges

This API is used to get card product charges.

Authorizations:
oauth
path Parameters
id
required
string

The card product ID.

query Parameters
charge_type
string
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "has_more": true,
  • "after": "string",
  • "data": [
    ]
}

Cards

This section includes card releated APIs.

Get list of cards

This API can be used to retrieve a list of cards.

Authorizations:
oauth
query Parameters
user_id
required
string

If included then cards will be filtered by user ID.

limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "MjAxOC0wMS0wMlQxOTo0MjozMi45ODda",
  • "has_more": true,
  • "data": [
    ]
}

Create card

This API is used to create a card.

Authorizations:
oauth
header Parameters
x-nymos-idempotency-key
required
string <= 36 characters

Idempotency key.

Request Body schema: application/json
required
id
string <= 36 characters

The unique identifier of the card. If you do not include a token, the system generates one automatically. This token is necessary for use in other API calls and this value cannot be updated.

user_id
required
string <= 36 characters

Token identifier of the user who owns this card.

card_type
required
string (CardType)
Enum: "PHYSICAL" "VIRTUAL"

Supported card types

card_product_id
required
string

The unique identifier of the card product. This token id is referred to as an existing card product. The card creating with this card product token will inherit all of its characteristics.

reference_card_id
string <= 36 characters

Token identifier of the card to refer to when creating a card linked to an existing account.

bulk_issuance_id
string <= 36 characters

Token identifier of the bulk issuance request to which this card belongs to.

name_on_card
string <= 20 characters

Name to print on the card and track data. If this field finds empty in the request, then the name of the user profile will be printed on the card.

object (CardShippingDetails)

Details of card shipping destination.

dry_run
boolean

This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false and the default value is false.

card_validity_term
integer <int32> [ 1 .. 99 ]

This is the term (in months) for which a newly created card will be valid for. Used to set the expiry date for the card. The expiry date shall be calculated from the date of card creation till the number of months given by this parameter. This field is optional; if it is empty, then card_validity_term from card_product shall be used. Card validity term of the card can not be greater than that of the card product.

extra_embossing_line
string <= 20 characters ^[a-zA-Z0-9\s]+$

Extra embossing line.

object (CreditSettingsRequest)

The exposed revolving credit settings.

object (CreditLimitsRequest)

the exposed revolving credit limits in the create-card/update-card API

delivery_charge_id
string <= 36 characters

Identifier of the delivery charge.

Responses

Request samples

Content type
application/json
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "card_type": "PHYSICAL",
  • "card_product_id": "aabc9d-996azam799-9ac99879b9a9bC99",
  • "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name_on_card": "John Smith",
  • "shipping_details": {
    },
  • "dry_run": false,
  • "card_validity_term": 36,
  • "extra_embossing_line": "CLASSIC",
  • "credit_settings": {
    },
  • "credit_limits": {
    },
  • "delivery_charge_id": "d089a80f-e641-4045-7880-54841e4a7458"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "card_type": "PHYSICAL",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name_on_card": "John Smith",
  • "card_product_name": "string",
  • "shipping_details": {
    },
  • "status": "INACTIVE",
  • "status_reason": "I0",
  • "fulfillment_status": "CREATED",
  • "bin": "123456",
  • "last_four": "5789",
  • "expiry_date": "01/2025",
  • "pin_retries": 0,
  • "proxy_number": "0000367466",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "modified_by": "API",
  • "extra_embossing_line": "CLASSIC",
  • "card_soft_expiry": "01/2025",
  • "auth_settings": {
    },
  • "is_account_linked": true,
  • "delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
  • "change_to_physical": true,
  • "balances": {
    }
}

Get card details

This API can be used to retrieve a single card by providing a card id to check the card details.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

The unique identifier of the card.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "card_type": "PHYSICAL",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name_on_card": "John Smith",
  • "card_product_name": "string",
  • "shipping_details": {
    },
  • "status": "INACTIVE",
  • "status_reason": "I0",
  • "fulfillment_status": "CREATED",
  • "bin": "123456",
  • "last_four": "5789",
  • "expiry_date": "01/2025",
  • "pin_retries": 0,
  • "proxy_number": "0000367466",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "modified_by": "API",
  • "extra_embossing_line": "CLASSIC",
  • "card_soft_expiry": "01/2025",
  • "auth_settings": {
    },
  • "is_account_linked": true,
  • "delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
  • "change_to_physical": true,
  • "balances": {
    }
}

Get accounts related to card

This API is used to retrieve accounts which are linked to the card.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

The unique identifier of the card.

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "b6822247-052d-4bb1-ad49-5e46f7c8fdd0"
]

Change card status

This API is used to change a card status.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

The unique identifier of the card.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

x-nfront-device-id
string
Request Body schema: application/json
required
status
required
string (CardStatus)
Enum: "INACTIVE" "ACTIVE" "SUSPENDED" "TERMINATED"

The status of a card.

status_reason_code
required
string (StatusChangeReason)
Enum: "A0" "A1" "A3" "AT" "I1" "S0" "S1" "S3" "S4" "S5" "S6" "S7" "ST" "T0" "T1" "T2" "T3" "T4" "T5" "T6" "T7" "T8" "T9" "T10" "T11" "T12" "T13" "T14" "T15" "T16" "T17" "T18"

Status Change Reason Code:

  • A0: First time activation: when activated from Inactive to Active status
  • A1: Resumed from Suspended status: when card is moved back to Active status
  • A3: Activated by admin
  • I1: Updated soft expiry of SUSPENDED(S2) card
  • S0: Temporary suspension: initiated by the user or system user or the system
  • S1: PIN retries exhausted: when bad PIN retries are exhausted
  • S3: Admin rejected due to ID verification failed
  • S4: Admin suspended due to fraudulent activity
  • S5: Admin rejected due to ID verification failed
  • S6: Admin suspended due to certain reason
  • S7: Admin suspended due to being delinquent for a certain amount of time
  • T0: Card Lost
  • T1: Card Stolen
  • T2: Card Expired
  • T3: Card Damaged
  • T4: Closed by user
  • T5: Closed by issuer
  • T6: Closed by issuer after renewal
  • S7: Admin suspended due to being delinquent for a certain amount of time
  • T7: Admin terminated due to limited time exceeded and action taken for ID verification fail
  • T8: Admin terminated due to KYC OGS response
  • T9: Admin terminated due to ID verification failed
  • T10: Admin terminated due to limited time exceeded and action taken for KYB fail
  • T11: Admin terminated due to certain reason
  • T12: System terminated due to ID verification rejected
  • T13: System terminated due to ID verification suspected
  • T14: Failed KYC
  • T15: Fraudulent activity was identified
  • T16: Matched with an Office of Foreign Assets Control list
  • T17: Admin terminated due to ID verification failed
  • T18: Admin terminated due to KYC failed
object (CoreNote)

This field is to capture additional information by the user while changing the card status. E.g. how the card got stolen, what is the reason behind a damage, etc.

modified_by
string <= 50 characters
Default: "API"

This field indicates the user who executed the operation.

Responses

Request samples

Content type
application/json
{
  • "status": "INACTIVE",
  • "status_reason_code": "A0",
  • "note": {
    },
  • "modified_by": "API"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "card_type": "PHYSICAL",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name_on_card": "John Smith",
  • "card_product_name": "string",
  • "shipping_details": {
    },
  • "status": "INACTIVE",
  • "status_reason": "I0",
  • "fulfillment_status": "CREATED",
  • "bin": "123456",
  • "last_four": "5789",
  • "expiry_date": "01/2025",
  • "pin_retries": 0,
  • "proxy_number": "0000367466",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "modified_by": "API",
  • "extra_embossing_line": "CLASSIC",
  • "card_soft_expiry": "01/2025",
  • "auth_settings": {
    },
  • "is_account_linked": true,
  • "delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
  • "change_to_physical": true,
  • "balances": {
    }
}

Create LUT for requested operation

This API is used to create a LUT (Limited Usage Token) for operations like view clear card details, retrieve clear card PIN, change a card PIN or activate a card. LUT has a timeout of 5 minutes before getting used. If the user does not use the LUT within 5 minutes, it will get expired. Each LUT is for one time use.

Authorizations:
oauth
path Parameters
id
required
string

Card ID to create LUT for.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

x-nfront-device-id
string

Device ID.

Request Body schema: application/json
required
source_id
required
string

The source identifier is used to identify the PCI source to get the cipher key.

operation
required
string (LutOperation)
Enum: "SHOW_CLEAR_CARD_DETAILS" "GET_PIN" "ACTIVATE_CARD" "CHANGE_PIN"

The LUT creation is based on the supported operations such as, "show_clear_card_details", "get_pin", "activate_card", and "change_pin".

Responses

Request samples

Content type
application/json
{
  • "source_id": "ae31cd18-7ed6-4b03-8e6b-4857f11d380d",
  • "operation": "SHOW_CLEAR_CARD_DETAILS"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "token": "152e8a03-719e-40b6-a901-ed981d31d52f"
}

Get velocity limits linked to card

This API is used to retrieve the list of velocity limits linked to a specific card.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

The unique identifier of the card.

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "velocitylimit02"
]

Set velocity limits for card

This API is used to set velocity limits for a specific card.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

The unique identifier of the card.

Request Body schema: application/json
required
ids
Array of strings

An array of data.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "velocitylimit02"
]

Remove velocity limits for card

This API is used to remove velocity limits from a specific card.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

The unique identifier of the card.

Request Body schema: application/json
required
ids
Array of strings

An array of data.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "velocitylimit02"
]

Get card limits info

This API is used to fetch all limits associated with card.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the card.

query Parameters
type
string
Enum: "ADVANCED_VELOCITY_LIMIT" "VELOCITY_LIMITS" "BALANCE_LIMITS"
Example: type=VELOCITY_LIMITS

The type of limit.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "user_id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "velocity_limits": [
    ],
  • "balance_limits": [
    ],
  • "advanced_velocity_limits": [
    ]
}

Show card secret data

This API can be used to retrieve and see card's secret data, e.g. PAN (Primary Account Number), CVV2 (Card Verification Value 2), Card expiry date, and Pin retries. This API can be used by a PCI Compliant user, if a non-complaint user is calling this API, then request error 403 (Forbidden) will appear.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

The unique identifier of the card.

query Parameters
show_cvv2
boolean

This query parameter is used to decide whether to see a clear CVV2 (Card Verification Value) or not. Applicable values are true/false.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

x-nfront-device-id
string

Device ID.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "card_type": "PHYSICAL",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name_on_card": "John Smith",
  • "card_product_name": "string",
  • "shipping_details": {
    },
  • "status": "INACTIVE",
  • "status_reason": "I0",
  • "fulfillment_status": "CREATED",
  • "bin": "123456",
  • "last_four": "5789",
  • "expiry_date": "01/2025",
  • "pin_retries": 0,
  • "proxy_number": "0000367466",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "modified_by": "API",
  • "extra_embossing_line": "CLASSIC",
  • "card_soft_expiry": "01/2025",
  • "auth_settings": {
    },
  • "is_account_linked": true,
  • "delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
  • "change_to_physical": true,
  • "balances": {
    },
  • "number": "9999999999999999",
  • "cvv2": "999"
}

Create custom velocity limit for card

This API can be used to create custom velocity limit for card.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the card.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user authentication info.

x-nfront-device-id
string

Device ID.

Request Body schema: application/json
required
active
boolean
Default: true

This parameter defines whether the velocity limits are going to be activated or not at the time of its creation. By default the velocity limit is activated on its creation.

min_amount
required
number <decimal> [ 0 .. 999999999999 ]

The minimum amount of a transaction. The transaction amount can not be lesser than the amount defined here.

max_amount
required
number <decimal> [ 0 .. 999999999999 ]

The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.

frequency
required
integer [ 0 .. 999999999 ]

It restricts a number of transactions a user can perform within a specified period of time.

description
required
string <= 40 characters

Some additional info.

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "min_amount": 1500.1,
  • "max_amount": 1600.1,
  • "frequency": 5,
  • "description": "Some info"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "type": "PER_TRANSACTION",
  • "min_amount": 100,
  • "max_amount": 1000,
  • "currency": "EUR",
  • "frequency": 0,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Update custom velocity limit for card

This API can be used to update custom velocity limit for card.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the card.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user authentication info.

x-nfront-device-id
string

Device ID.

Request Body schema: application/json
required
id
string

Unique ID for the custom velocity Limit.

active
boolean

This parameter describes if velocity limit is activated or not.

min_amount
number <decimal> [ 0 .. 999999999999 ]

The minimum amount of a transaction. The transaction amount can not be lesser than the amount defined here.

max_amount
number <decimal> [ 0 .. 999999999999 ]

The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.

frequency
integer [ 0 .. 999999999 ]

It restricts a number of transactions a user can perform within a specified period of time.

Responses

Request samples

Content type
application/json
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "active": true,
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "frequency": 999999999
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "type": "PER_TRANSACTION",
  • "min_amount": 100,
  • "max_amount": 1000,
  • "currency": "EUR",
  • "frequency": 0,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Create custom advanced velocity limit for card

This API can be used to create custom advanced velocity limit for card.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the card.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user authentication info.

x-nfront-device-id
string

Device ID.

Request Body schema: application/json
required
active
boolean
Default: true

This parameter describes if advanced velocity limit is activated or not.

object (PerTransaction)

This parameter defines the per transaction limit. The fields defined under this parameter will be applied only on the single transaction.

amount
required
number <decimal> [ 0 .. 999999999999 ]

The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.

frequency
required
integer [ 0 .. 999999999 ]

It restricts a number of transactions a user can perform within a specified period of time.

name
string [ 1 .. 100 ] characters

The name of advanced velocity limit.

description
required
string <= 40 characters

The additional information.

num_of_days
integer [ 0 .. 999999999 ]

During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’ and apply the limit accordingly. This field will only be used when ‘period’ = ‘num_of_days’

effective_from
string <date-time>

The date and time from which the limit is effective.

effective_to
string <date-time>
Default: "2099-12-31T11:59:59.999Z"

The date and time to which the limit is effective.

group
string (Group)
Enum: "SINGLE" "AGGREGATE"

The advanced velocity limit group.

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "per_transaction": {
    },
  • "amount": 1500.1,
  • "frequency": 999999999,
  • "name": "limit1",
  • "description": "Some description",
  • "num_of_days": 15,
  • "effective_from": "2018-01-02T19:42:32.987Z",
  • "effective_to": "2018-01-02T19:42:32.987Z",
  • "group": "SINGLE"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "name": "limit1",
  • "type": "PER_CARD",
  • "description": "Some description",
  • "currency": "EUR",
  • "transaction_scope": [
    ],
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "amount": 1500.1,
  • "frequency": 999999999,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "effective_from": "2018-01-02T19:42:32.987Z",
  • "effective_to": "2018-01-02T19:42:32.987Z",
  • "program_level": false,
  • "conditions": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "group": "SINGLE"
}

Update custom advanced velocity limit for card

This API can be used to update custom advanced velocity limit for card.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the card.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user authentication info.

x-nfront-device-id
string

Device ID.

Request Body schema: application/json
required
id
string

Unique ID for the custom advanced velocity limit.

active
boolean
Default: true

This parameter describes if advanced velocity limit is activated or not.

amount
number <decimal> [ 0 .. 999999999999 ]

The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.

frequency
integer [ 0 .. 999999999 ]

It restricts a number of transactions a user can perform within a specified period of time.

description
string <= 40 characters

The additional information.

Responses

Request samples

Content type
application/json
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "active": true,
  • "amount": 1500.1,
  • "frequency": 999999999,
  • "description": "Some description"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "name": "limit1",
  • "type": "PER_CARD",
  • "description": "Some description",
  • "currency": "EUR",
  • "transaction_scope": [
    ],
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "amount": 1500.1,
  • "frequency": 999999999,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "effective_from": "2018-01-02T19:42:32.987Z",
  • "effective_to": "2018-01-02T19:42:32.987Z",
  • "program_level": false,
  • "conditions": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "group": "SINGLE"
}

Change card PIN

This API is used to change the card PIN.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

The unique identifier of the card.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

x-nfront-device-id
string

Device ID.

Request Body schema: application/json
required
enc_pin
required
string

Encrypted card PIN.

Responses

Request samples

Content type
application/json
{
  • "enc_pin": "ncrypt:1:4p1aPxnRvuoJOoymTSA4XH1rRaaj0HvAEISFCyQouPc:2TM-I0I-qGd4kgfXiVM-jA:aCcRsp3X8KSWT6MBVVCKpcY1UCbegyThE4VQtRMRO_VtQ6_SKHIO2GVNuerhkPo16_4RkJgc_K1hBYgcCuXfuq7V3cXGqhzSgd5edCqlxIDCnja2zgy-T96fVyvNWLLMeQyVAXpIZPZpG0KRXLJYW-B4L-nctY0gMLsIztGhjsSDzySsvUjUv5w5EPwWqh9pK68RIgQM6BxxPoDrlUlpSpEmCY5whbTnbjxRyaRYah16_0CM721vI_dcFf_dgA5HnqfBjZ7d0SpuXkenroVag7kPMIODrcPaB5Sps0ZGSXrngQuUH4qxULy4kuOqeOmRDz499F-JafTOqbBVlXrUEg:T206J-tMI9HXPNu4oxRcWw"
}

Get card PIN

This API is used to retrieve the card secure PIN.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

The unique identifier of the card.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

x-nfront-device-id
string

Device ID.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "enc_pin": "ncrypt:2:xKzHT-2NJ8yCZIv7Ra9oFQ:VETEcevv-ZyndOeLF7CqO-4aNJ6Z5Tha0wcMFoJEDAJAoLsst1ccMSeeMdbJUwq1GfKjCpm5mMwkEn51ZAFqLW43EcNkapSiPPVRJtU5V1z9u4ZGEXi4swPVzY2j0NfaM4a4aGM_WdpKSx6r7m86vhjI5901GXRd2vpyGAztfL9krOMA7KgLGaVlqj1i-xIaxvGbIDhFVepIWcxTxiSHqwZxLMN1HMojtf2pJacwoq5nOBP3DX3DgdapIdJN8AWCSIpZ8M6nwf4-2Wr8GGTJrUChU1eJiALKZ-lliP8RvIERG9zP3Z41kQDoWP9JlEFr547xREvXIf6IS4a_ixuwrg:1Ya9e6e0Los"
}

FX rates

This section includes FX rates releated APIs.

Get FX rates

This API is used to get list of FX rates.

Authorizations:
oauth
query Parameters
card_product_id
required
string

Card product ID for which to fetch FX rates.

from_currency
string^[A-Z]{3}

3-letter ISO_4217 code representing the currency.

to_currency
string^[A-Z]{3}

3-letter ISO_4217 code representing the currency.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "fxrates": [
    ]
}

Search FX rates

This API is used to search FX rates.

Authorizations:
oauth
query Parameters
card_product_id
required
string

Card product ID for which to fetch FX rates.

from_currency
required
string^[A-Z]{3}

3-letter ISO_4217 code representing the currency.

to_currency
required
string^[A-Z]{3}

3-letter ISO_4217 code representing the currency.

header Parameters
X-Nymos-Idempotency-Key
string <= 36 characters

Unique transaction ID.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "transaction_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "account_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "transaction_type": "TRANSFERS",
  • "fxrate_mode": "ONLINE",
  • "currency_pairs": [
    ],
  • "rates_expiry": "2018-01-02T19:42:32.987Z",
  • "rate_expiry_buffer_time": 2
}

Create FX rates quote

This API is used to create FX rates quote.

Authorizations:
oauth
Request Body schema: application/json
required
account_id
required
string

The unique identifier of the account.

recipient_account_id
string

The unique identifier of the recipient account. This parameter is used for fund transfer between accounts of different wallet currencies.

from_currency
required
string^[A-Z]{3}$

3-letter ISO_4217 code representing the selling currency.

to_currency
required
string^[A-Z]{3}$

3-letter ISO_4217 code representing the buying currency.

amount
required
number

The amount which should be converted.

amount_type
string (FxRateAmountType)
Enum: "FROM" "TO"

FX rate amount type.

Responses

Request samples

Content type
application/json
{
  • "account_id": "c1971753-2d53-4cc4-9e95-5bcb9a3fef95",
  • "recipient_account_id": "c1971753-2d53-4cc4-9e95-5bcb9a3fef95",
  • "from_currency": "AED",
  • "to_currency": "USD",
  • "amount": 50,
  • "amount_type": "FROM"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "ts": "2012-05-04T19:42:32.987Z",
  • "account_id": "c1971753-2d53-4cc4-9e95-5bcb9a3fef95",
  • "recipient_account_id": "c1971753-2d53-4cc4-9e95-5bcb9a3fef95",
  • "from_currency": "AED",
  • "from_amount": 57,
  • "to_currency": "USD",
  • "to_amount": 14.82,
  • "exchange_rate": 0.26,
  • "status": "OFFERED",
  • "expiry": "2012-05-04T19:42:32.987Z",
  • "fxrate_provider_id": "34",
  • "fxrate_provider_name": "Converter",
  • "markup_value": 5,
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Get FX rates quote by ID

This API is used to get FX rates quote by ID.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of FX rate quote.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "id_external": "2",
  • "status": "OFFERED",
  • "ts": "2012-05-04T19:42:32.987Z",
  • "expiry": "2012-05-04T19:42:32.987Z",
  • "booking_ts": "2012-05-04T19:42:32.987Z",
  • "account_id": "c1971753-2d53-4cc4-9e95-5bcb9a3fef95",
  • "recipient_account_id": "c1971753-2d53-4cc4-9e95-5bcb9a3fef95",
  • "fxprovider_id": "34",
  • "fxrate_mode": "ONLINE",
  • "rate_group_id": "R34",
  • "rate_group_id_external": "P1",
  • "from_currency": "AED",
  • "from_amount": 57,
  • "to_currency": "USD",
  • "to_amount": 14.82,
  • "to_amount_applied": 14.82,
  • "exchange_rate_id": "2",
  • "exchange_rate": 0.26,
  • "exchange_rate_applied": 0.26,
  • "markup_type": "DEFAULT",
  • "markup_value": 5,
  • "customer_id": "396794673",
  • "reference_id": "5668",
  • "card_scheme": "VISA",
  • "ts_external": "2012-05-04T19:42:32.987Z",
  • "booking_ts_external": "2012-05-04T19:42:32.987Z",
  • "expiry_external": "2012-05-04T19:42:32.987Z",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "transaction_id": "111c3059-33af-4ed0-969a-7c23801dd555",
  • "derived_rate": 2,
  • "final_rate": 5
}

Book FX rate for quote

This API is used to book FX rate for quote.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of FX rate quote.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "ts": "2012-05-04T19:42:32.987Z",
  • "quote_booking_ts": "2012-05-04T19:42:32.987Z",
  • "from_currency": "AED",
  • "from_amount": 57,
  • "to_currency": "USD",
  • "to_amount": 14.82,
  • "exchange_rate": 0.26,
  • "status": "OFFERED",
  • "expiry": "2012-05-04T19:42:32.987Z",
  • "transaction_id": "111c3059-33af-4ed0-969a-7c23801dd555",
  • "fxrate_provider_id": "34",
  • "fxrate_provider_name": "Converter",
  • "markup_value": 5,
  • "fee_amount": 2.5,
  • "fee_details": [
    ],
  • "account_id": "c1971753-2d53-4cc4-9e95-5bcb9a3fef95",
  • "recipient_account_id": "c1971753-2d53-4cc4-9e95-5bcb9a3fef95",
  • "booking_ts": "2012-05-04T19:42:32.987Z",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Identity verification

This section includes identity verification releated APIs.

Generate SDK token

This API is used to generate SDK token.

Authorizations:
oauth
Request Body schema: application/json
required
user_id
string

User ID.

Responses

Request samples

Content type
application/json
{
  • "user_id": "9198cc77-3aec-44eb-826a-99497c83f7a6"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "applicant_id": "be051d55-2369-4636-b639-c41e57e6d80a",
  • "token": "0983409643063468",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z"
}

Balance limits

This section includes balance limits releated APIs.

Get specific balance limit

This API is used to get specific balance limit.

Authorizations:
oauth
path Parameters
id
required
string

The balance limit ID.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the balance limit",
  • "active": true,
  • "type": "PER_ACCOUNT",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Velocity limits

This section includes velocity limits releated APIs.

Create velocity limit

This API is used to create velocity limit.

Authorizations:
oauth
Request Body schema: application/json
required
id
string <= 36 characters

The unique identifier of the velocity limit. If this information is not present in the request, the system generates one automatically.

description
required
string <= 40 characters

The name of the velocity limit. We recommend using a unique string.

active
boolean

This parameter defines whether the velocity limits are going to be activated or not at the time of its creation. By default the velocity limit is activated on its creation.

type
required
string (VelocityLimitType)
Enum: "PER_TRANSACTION" "PER_CARD" "PER_ACCOUNT" "PER_USER"

Type of velocity limit.

min_amount
number <decimal> [ 0 .. 999999999999 ]

The minimum amount of a transaction. The transaction amount can not be lesser than the amount defined here.

max_amount
number <decimal> [ 0 .. 999999999999 ]

The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.

currency
required
string <iso-4217> ^[A-Z]{3}$

3-letter ISO_4217 code representing the currency.

frequency
integer [ 0 .. 999999999 ]

It restricts a number of transactions a user can perform within a specified period of time.

period
string (Period)
Enum: "DAILY" "MONTHLY" "YEARLY" "ALL_TIME" "NUM_OF_DAYS"

It specifies the time period of the velocity limit for the transaction frequency.

num_of_days
integer [ 0 .. 999999999 ]

During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’ and apply the limit accordingly. This field will only be used when ‘period’ = ‘NUM_OF_DAYS’.

transaction_scope
required
Array of strings (TransactionScope) non-empty
Items Enum: "WITHDRAWALS" "PURCHASES" "OUTGOING_TRANSFERS" "UNLOADS" "SCHEME_ACCOUNT_FUNDING" "QUASI_CASH" "PURCHASES_CONTACTLESS_NO_PIN" "LOADS" "INCOMING_TRANSFERS" "SCHEME_CREDITS" "INITIAL_LOAD"

This parameter is to define a transaction scope for this velocity limit.

channel_scope
string (ChannelScopeValues)
Enum: "VISA" "MASTERCARD" "WESTERNUNION"

This parameter is used to create a velocity limit for the channels defined in the system.

Responses

Request samples

Content type
application/json
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "type": "PER_TRANSACTION",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR",
  • "frequency": 999999999,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "type": "PER_TRANSACTION",
  • "min_amount": 100,
  • "max_amount": 1000,
  • "currency": "EUR",
  • "frequency": 0,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Get specific velocity limit

This API is used to get specific velocity limit.

Authorizations:
oauth
path Parameters
id
required
string

The velocity limit ID.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "type": "PER_TRANSACTION",
  • "min_amount": 100,
  • "max_amount": 1000,
  • "currency": "EUR",
  • "frequency": 0,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Update velocity limit

This API is used to update velocity limit.

Authorizations:
oauth
path Parameters
id
required
string

The velocity limit ID.

Request Body schema: application/json
required
description
string <= 40 characters

Velocity limit description.

active
boolean

This parameter describes if velocity limit is activated or not.

type
string (VelocityLimitType)
Enum: "PER_TRANSACTION" "PER_CARD" "PER_ACCOUNT" "PER_USER"

Type of velocity limit.

min_amount
number <decimal> [ 0 .. 999999999999 ]

The minimum amount of a transaction. The transaction amount can not be lesser than the amount defined here.

max_amount
number <decimal> [ 0 .. 999999999999 ]

The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.

currency
string <iso-4217> ^[A-Z]{3}$

3-letter ISO_4217 code representing the currency.

frequency
integer [ 0 .. 999999999 ]

It restricts a number of transactions a user can perform within a specified period of time.

period
string (Period)
Enum: "DAILY" "MONTHLY" "YEARLY" "ALL_TIME" "NUM_OF_DAYS"

It specifies the time period of the velocity limit for the transaction frequency.

num_of_days
integer [ 0 .. 999999999 ]

During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’ and apply the limit accordingly. This field will only be used when ‘period’ = ‘NUM_OF_DAYS’’

transaction_scope
Array of strings (TransactionScope) non-empty
Items Enum: "WITHDRAWALS" "PURCHASES" "OUTGOING_TRANSFERS" "UNLOADS" "SCHEME_ACCOUNT_FUNDING" "QUASI_CASH" "PURCHASES_CONTACTLESS_NO_PIN" "LOADS" "INCOMING_TRANSFERS" "SCHEME_CREDITS" "INITIAL_LOAD"

This parameter array contains the transaction scope for this velocity limit.

channel_scope
string (ChannelScopeValues)
Enum: "VISA" "MASTERCARD" "WESTERNUNION"

This parameter is used to create a velocity limit for the channels defined in the system.

Responses

Request samples

Content type
application/json
{
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "type": "PER_TRANSACTION",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR",
  • "frequency": 999999999,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "type": "PER_TRANSACTION",
  • "min_amount": 100,
  • "max_amount": 1000,
  • "currency": "EUR",
  • "frequency": 0,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Locations

This section includes locations releated APIs.

Get list of locations

This API is used to get list of locations.

Authorizations:
oauth
query Parameters
region
string
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Get location by ID

This API is used to get specific location.

Authorizations:
oauth
path Parameters
locations_id
required
string

The unique identifier of location.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "5e18bf36-9356-4437-a11f-b2e425556096",
  • "new_branch_atm": "ATM123",
  • "region": "West",
  • "area": "Downtown",
  • "location": "Main Street",
  • "responsible_branch": "Branch001",
  • "street_avenue": "5th Avenue",
  • "building": "Building A",
  • "floor": "1st",
  • "near": "Near the park",
  • "x": 40.7128,
  • "y": 74.006,
  • "number_of_atms": 2,
  • "deposit": true,
  • "pin_indicator": "Active",
  • "google_maps_status": "Verified"
}

Push notifications

This section includes push notifications releated APIs.

Update the push notification token

On initial startup, the FCM SDK generates a registration token. Please note that tokens may change when:

  • The app deletes Instance ID
  • The app is restored on a new device
  • The user uninstalls/reinstall the app
  • The user clears app data.

This endpoint must be called whenever a new token is generated or updated.

Authorizations:
x-consumer-usernameoauth
Request Body schema: application/json
required
registration_token
required
string

The registration token.

device_id
required
string

The device ID.

project_id
required
string

The project ID.

app_id
required
string

The application ID.

account_id
string

The unique identifier of the account.

language
string

The language.

Responses

Request samples

Content type
application/json
{
  • "registration_token": "d0VtBayWQlyCYrktMqQhGK:APA91bFSTzYmSzyGGTyuHj51OL6qwCW2lchKOZxcS8fnRMr_Js3-MlwpE5BbJkmAXeNA06KDuxZZ0ECkSB6tkLFV3h28bfoR-PZFFh4sjihTNSa7YZCSXNqvu24vWqdr3O5W28NDg4e5",
  • "device_id": "zmi...zA",
  • "project_id": "nymcarddemoapp",
  • "app_id": "1:165082347030:android:8d1ed306e44931fd0ae737",
  • "account_id": "c1971753-2d53-4cc4-9e95-5bcb9a3fef95",
  • "language": "EN"
}

Load push notifications

This API is used to load push notifications.

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

account_id
required
string

The unique identifier of account.

language
required
string

The language.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Mark push notification as read

This API is used to mark push notification as read.

Authorizations:
oauth
path Parameters
push_id
required
string

The unique identifier of push notification.

Responses

Orders

This section includes orders releated APIs.

Create temporary user token

This API is used to create temporary user token for orders in the standard NymCard widget and MPGS.

Authorizations:
oauth
Request Body schema: application/json
required
account_id
required
string

ID of the account, to which funds will be loaded.

Responses

Request samples

Content type
application/json
{
  • "account_id": "e6b500c7-b37b-46cf-baae-e1b4f43e8749"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "token": "42504465-5410-46fc-94e8-aa5bc062ada9%7Ctenant",
  • "expire_at": "2012-05-04T19:42:32.987Z"
}

Perform checkout payment

This API is used to perform checkout payment.

Authorizations:
oauth
header Parameters
x-nymos-idempotency-key
required
string <= 36 characters

Idempotency key.

otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

x-nfront-device-id
string
Request Body schema: application/json
required
instrument_id
string

The unique identifier of instrument.

external_card_details
string

The external card details.

card_id
required
string

The unique identifier of card.

amount
required
number <decimal>

The money amount.

currency
required
string = 3 characters

The currency.

description
string <= 100 characters

The additional information.

fee_deduction_type
required
string (FeeDeductionType)
Enum: "DEDUCT_FEE_FROM_AMOUNT" "DEDUCT_FEE_OTHER_THAN_AMOUNT"

The type of fee deduction.

object (CheckoutAuthenticationUrl)

Authentication URL.

Responses

Request samples

Content type
application/json
{
  • "instrument_id": "src_3ufzpcd64m5ufa5auvg3ruxsau",
  • "external_card_details": "J2bkUwMRmU+2WL/aOaHbgVGRauy457qRRjXqzv2VY/",
  • "card_id": "7f56e4b7-57f2-421d-9b0b-a4ea9b05a3bc",
  • "amount": 10,
  • "currency": "USD",
  • "description": "Some info",
  • "fee_deduction_type": "DEDUCT_FEE_FROM_AMOUNT",
  • "authentication_url": {}
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "transaction_id": "MuhayCheckoutTestKey0408",
  • "processed_date": "2024-04-25T07:08:00.494Z",
  • "acquirer_transaction_id": "784210771761654858912",
  • "auth_code": "419150",
  • "last4": "9996",
  • "bin": "454347",
  • "amount": 10,
  • "currency": "AED",
  • "approved": true,
  • "status": "Authorized",
  • "response_code": "10000",
  • "response_summary": "Approved",
  • "is_card_linked": false,
  • "redirect_url": "https:/example.com"
}

Delete linked instrument

This API is used to delete a linked instrument.

Authorizations:
oauth
path Parameters
user_id
required
string

The unique identifier of user.

instrument_id
required
string

The unique identifier of instrument.

Responses

Get checkout user by id

This API is used to retrieve details of a specific checkout user.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of user.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "user_id": "cus_cdx7jda7tk4uhnkhqu4rgrzr54",
  • "name": "John Smith",
  • "link_card_count": "1",
  • "instruments": [
    ]
}

Get Lean SDK auth info

This API is used to get Lean SDK auth info.

Authorizations:
oauth
path Parameters
user_id
required
string

The unique identifier of user.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "customer_id": "4a41deb5-04d9-4a0a-bd19-95807a2077f8",
  • "app_token": "b7ae2c36-3af8-4b40-8e18-1e561f4e6296",
  • "access_token": "9476497695476",
  • "destination_id": "2e7a8e82-b3b8-48e8-b47d-2b266ed2191e",
  • "sandbox": true
}

Get Lean payment sources

This API is used to get Lean payment sources.

Authorizations:
oauth
path Parameters
user_id
required
string

The unique identifier of user.

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Delete Lean payment source

This API is used to delete Lean payment source.

Authorizations:
oauth
path Parameters
user_id
required
string

The unique identifier of user.

payment_source_id
required
string

The unique identifier of payment source.

Responses

Create Lean payment intent

This API is used to create Lean payment intent.

Authorizations:
oauth
header Parameters
x-nymos-idempotency-key
required
string <= 36 characters

Idempotency key.

Request Body schema: application/json
required
dry_run
boolean
Default: false

This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false and the default value is false.

account_id
required
string

The unique identifier of the account.

amount
required
number <decimal>

The amount.

currency
required
string^[A-Z]{3}$

The currency.

payment_destination_id
required
string

The payment destination ID.

description
string <= 12 characters

Some additional info.

Responses

Request samples

Content type
application/json
{
  • "dry_run": false,
  • "account_id": "c1971753-2d53-4cc4-9e95-5bcb9a3fef95",
  • "amount": 123.45,
  • "currency": "USD",
  • "payment_destination_id": "2e7a8e82-b3b8-48e8-b47d-2b266ed2191e",
  • "description": "Some info"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "payment_intent_id": "1b3e3362-9205-458f-879e-aa550ce7659e",
  • "transaction_id": "5efss708-0458-47ac-b722-4e30b1744b4f",
  • "reference_number": "04a466da-cbab-11ed-afa1-0242ac120002",
  • "customer_id": "4a41deb5-04d9-4a0a-bd19-95807a2077f8",
  • "account_id": "c1971753-2d53-4cc4-9e95-5bcb9a3fef95",
  • "amount": 100,
  • "currency": "USD",
  • "description": "Some info",
  • "payments": [
    ],
  • "payment_destination": {
    },
  • "fee_amount": 2.5,
  • "fee_details": [
    ],
  • "created_at": "2018-01-02T19:42:32.987Z",
  • "updated_at": "2018-01-02T19:42:32.987Z"
}

Users

This section includes users releated APIs.

Create user

This API is used to create a new user.

Authorizations:
oauth
Request Body schema: application/json
required

User info.

id
string

Unique identifier of the user. If this information is not present in the request, the system generates one automatically. Please note that this token ID is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated.

title
string (UserTitle)
Enum: "MR" "MRS" "MISS"

The user's title/prefix.

first_name
required
string <= 60 characters

User's first name. This parameter is optional for 'user_type'=BUSINESS. Note, that when you want to simulate an Identity Verification process, please provide both the user's 'first_name' and 'last_name' parameters. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

middle_name
string <= 60 characters

User's middle name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

last_name
string <= 60 characters

User's last name. This parameter is mandatory to provide when Identity verification is required. Note, that when you want to simulate an Identity Verification process, please provide both the user's 'first_name' and 'last_name' parameters. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

native_name
string <= 60 characters

Native name of the user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

native_last_name
string <= 60 characters

Native last name.

full_legal_name
string <= 200 characters

Individual user name use for document verification process. It should has the same name as on legal ID document.

full_name_local_language
string <= 50 characters

User's father’s name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

father_name
string <= 60 characters

User's father’s name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

mother_name
string <= 60 characters

User's mother's name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

grandfather_name
string <= 60 characters

User's grandfather’s name.

family_name
string <= 60 characters

User's family name.

marital_status
string

User's marital status.

employment_status
string

User's employment status.

business_type
string <= 50 characters

User / Agent's business type information.

legal_form
string <= 50 characters

User / Agent's legal form information.

date_of_birth
string <date>

The date of birth of the user in the following format - yyyy-mm-dd. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

email
string <= 255 characters

A valid email address for the user.

mobile
string

Mobile number of the user (including area code), appended with "+" symbol and the first three digits to identify the country calling code. Please do not include hyphens, spaces or parentheses.

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

gender
string (UserGender)
Enum: "MALE" "FEMALE"

The gender of the user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

education_level
string <= 50 characters

Education level.

preferred_language
string

A selected language for 3D Secure and digital wallet token notifications sent to this user. By default, notifications are sent in English. The supported value should be provided in ISO language format.

place_of_birth
string

The place of birth of the user. The format should be ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

place_of_birth_city
string <= 50 characters

The city of birth.

nationality
string

Nationality; must be one of ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

parent_user_id
string

Unique identifier of parent user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

created_by
string <= 50 characters

Identifier of user's creator.

country_residence
string <= 3 characters

The country where the individual user resides or is currently citizen of. The format is ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

country_tax_residence
string <= 3 characters

The country for which the tax rules apply to the individual/business user and the user pays tax according to it. The format is ISO alpha 3-character country code.

employment_type
string (EmploymentType)
Enum: "SALARIED" "SELF_EMPLOYED" "RETIRED" "NOT_EMPLOYED" "BUSINESS_OWNER" "STUDENT" "HOMEMAKER" "OTHER"

The employment type of the individual user.

employment_title
string <= 50 characters

The job title (designation) for user_type = INDIVIDUAL. For user_type = BUSINESS this field can give the designation of the primary contact person of the business.

monthly_salary
number >= 0

The monthly salary of the user_type = INDIVIDUAL.

company_name
string <= 200 characters

The company name for which the individual works for in case of SALARIED or company name that the individual runs in case of SELF-EMPLOYED or BUSINESS_OWNER. This parameter is required if "employment_type" = 'SALARIED", "EMPLOYED" or "BUSINESS_OWNER".

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

company_country
string <= 3 characters

Company country in format of ISO alpha 3-character country code. For user_type = INDIVIDUAL this field indicates the country in which the company is registered and conducts its business and activities. For user_type = BUSINESS this field indicates the country in which the business is registered and conducts its activities.

industry_type
string (IndustryType)
Enum: "I01" "I02" "I03" "I04" "I05" "I06" "I07" "I08" "I09" "I11" "I12" "I13" "I14" "I15" "I16" "I17" "I18" "I19" "I20" "I21" "I22" "I23" "I24" "I25" "I26" "I27" "I28" "I29" "I30" "I00"

Type of industry:

  • I01: Gambling/Casinos
  • I02: Defence/Military goods or Arms Dealers and Manufacturers
  • I03: Exchange Companies / Bureaus de Change, Money Changers, Hawala dealers / Other Finance Companies (For e.g. Derivatives Trading, Hedge Funds, Unregistered/Pvt Collective Investment Schemes)
  • I04: Real Estate Brokers / Real Estate Agencies / Real Estate Developers (Non * Govt)
  • I05: Charity Organizations, Religious/Social/Non * Profit Organizations, Cooperative/Social/Professional Societies & associations
  • I06: Auction Houses
  • I07: Dealers in Luxury Goods: (Definition of Luxury Goods include: Precious metals & Stones, Jewelry & Antiques, Art, Furs, Yachts , Executive/Private Jets)
  • I08: Trust Service Providers, Lawyers, Accountants, Tax Advisers, Auditors
  • I09: Private Banking Relationship
  • I11: Agriculture, Forestry, Fishing, and Hunting
  • I12: Mining, Quarrying, and Oil and Gas Extraction
  • I13: Utilities (water, gas, electricity)
  • I14: Telecommunications
  • I15: Construction
  • I16: Manufacturing
  • I17: Wholesale Trade
  • I18: Retail Trade and Commerce
  • I19: Transportation and Warehousing
  • I20: Technology
  • I21: Finance and Insurance
  • I22: Real Estate and Rental and Leasing
  • I23: Professional, Scientific, and Technical Services
  • I24: Management of Companies and Enterprises
  • I25: Educational Services
  • I26: Health Care and Social Assistance
  • I27: Arts, Entertainment, and Recreation
  • I28: Hotels and Food Services
  • I29: Public Administration
  • I30: Administrative and Support and Waste Management
  • I00: Other
expected_monthly_balance
number >= 0

For user_type = INDIVIDUAL this field indicates the expected monthly balance the individual user is planning to maintain in his accounts. For user_type = BUSINESS this field indicates the expected monthly balance the business is planning to maintain in its accounts.

relationship_with_parent
string (RelationshipWithParent)
Enum: "SON" "DAUGHTER" "NEPHEW" "NIECE" "HUSBAND" "WIFE" "FATHER" "MOTHER" "EMPLOYEE" "OTHER"

For a child user this field indicates the relationship of the child user with the parent user.

user_type
string (UserType)
Enum: "INDIVIDUAL" "BUSINESS" "DIRECTOR" "SIGNATURE" "SHAREHOLDER" "SHAREHOLDER_BUSINESS" "AGENT"

The type of the user. You can find all necessary fields per each user type in this GSG doc - https://docs.nymcard.com/get-started/program-management/necessary-parameters-per-user-type. Note, that 'AGENT' user can have a 'parent_user_id' corresponding to an 'AGENT' or 'BUSINESS' user (and not the other user types).

business_legal_name
string <= 200 characters

The business legal name. This field may be used for KYB verification. Applicable for 'user_type' = BUSINESS.

business_dba_name
string <= 50 characters

The business’s secondary name. This field may be used for KYB verification, if the business name is different from the legal business name. Applicable for 'user_type' = BUSINESS.

date_established
string <date-time>

The established date and time. Applicable for 'user_type' = BUSINESS.

phone_number
string^\+\d+

The telephone number.

website
string <= 50 characters

The website. Applicable for 'user_type' = BUSINESS.

designation
string <= 50 characters

It is mandatory to provide this parameter if 'user_type' is DIRECTOR or SIGNATURE. The valid designation should be provided, such as: CEO, CPO, CEO - (region name).

shares_percentage
number <float>

It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.

share_controller_name
string <= 100 characters

It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

incorporation_type
string (UserIncorporationType)
Enum: "LTD" "LLC" "FZE" "FZCO" "FZ-LLC" "INC" "FOUNDATION" "TRUST" "FUND" "PUBLIC_TRADED" "GOVT_OWNED" "LLP" "OTHER"

This parameter indicates whether this business entity is Limited, LLC, Free-zone or anything else.

entity_registered_no
string <= 50 characters

This parameter describes the business/entity registered number.

old_entity_name
string <= 50 characters

This parameter describes the business’s old name.

old_entity_ops_start_date
string <date-time>

It is the start date when the business was operated under old name.

old_entity_ops_end_date
string <date-time>

It is the end date when the business was operated under old name.

regulated_entity
boolean

This parameter indicates if the entity is a regulated entity or no. Possible values are true/false.

regulator_name
string <= 50 characters

This parameter indicates the regulator’s name. It is applicable if 'regulated_entity' parameter is set as 'true'.

business_activities
string <= 1000 characters

This parameter describes the business/entity activities such as Payment Service Provider, IT service provider etc. It can be a comma separated values.

other_operated_countries
string

This parameter indicates the valid country's name(s), where the business is operated.

tax_residence_country
string <= 50 characters

This parameter indicates the name of a country, where the business has a tax residence.

tin
string <= 50 characters

Tax identification number.

external_auditor_name
string <= 50 characters

Name of the external auditor.

director_list
Array of strings

The list of directors. Up to 10 directors can be linked to a business user; but directors should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

signature_list
Array of strings

The list of signatures. Up to 10 signatures can be linked to a business user; but the signatures should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

shareholder_list
Array of strings

The list of shareholders. Up to 50 shareholders can be linked to a business user; but the shareholders should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

company_onbehalf
boolean

This parameter indicates if the company is opened on behalf of another person. Possible values are true/false.

company_onbehalf_relation
string <= 50 characters

In this parameter you should confirm the relationship of the beneficial owner. It is applicable if 'company_onbehalf' parameter is set as 'true'.

object (UserGroupAdditionalInfo)

The additional information, which describes whether entity is a part of a group etc.

object (UserPepCheckInfo)

The information about checking politically exposed persons (“PEPs”) among main shareholders, directors of the entity.

no_of_employees
integer <int32> (UserNoOfEmployees)

This parameter describes the number of employees for the business entity.

accept_cash_check
boolean

This parameter indicates whether the corporate company accepts cash from end users or not. Possible values are true/false.

annual_turnover
number

This parameter describes the annual turnover of the business entity.

source_of_funds
string <= 50 characters

This parameter describes how is the company being funded.

source_fund_uae
boolean

This parameter indicates whether the business source of funds is derived from outside of the UAE or no. Possible values are true/false.

object (UserDueDiligenceDeclaration)

The information about due diligence declaration.

license_type
string <= 100 characters

The license type. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.

license_expiry
string <date>

The license expiry. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.

estimated_activity_through_nymcard
string

This parameter is optional and applicable for 'user_type' = BUSINESS.

expected_number_of_cards
integer <int32> >= 0

This parameter is optional and applicable for 'user_type' = BUSINESS.

expected_use_of_ncs_services
string

This parameter is optional and applicable for 'user_type' = BUSINESS.

object

This parameter holds additional fields configured in tenant settings. This parameter is optional.

Responses

Request samples

Content type
application/json
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "title": "MR",
  • "first_name": "John",
  • "middle_name": "Anthony",
  • "last_name": "Smith",
  • "native_name": "John Smith",
  • "native_last_name": "Júañ Hérreró",
  • "full_legal_name": "John Smith",
  • "full_name_local_language": "Volodymyr",
  • "father_name": "John Smith",
  • "mother_name": "Mary Ann",
  • "grandfather_name": "Andrew",
  • "family_name": "Smith",
  • "marital_status": "Divorced",
  • "employment_status": "Worker",
  • "business_type": "LCC",
  • "legal_form": "Company",
  • "date_of_birth": "2012-05-04",
  • "email": "bob@example.com",
  • "mobile": "+551185249635",
  • "address": {
    },
  • "gender": "MALE",
  • "education_level": "Graduate",
  • "preferred_language": "EN",
  • "place_of_birth": "USA",
  • "place_of_birth_city": "Toronto",
  • "nationality": "USA",
  • "parent_user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "created_by": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "country_residence": "USA",
  • "country_tax_residence": "USA",
  • "employment_type": "SALARIED",
  • "employment_title": "QAE",
  • "monthly_salary": "12000",
  • "company_name": "Example",
  • "company_address": {
    },
  • "company_country": "USA",
  • "industry_type": "I01",
  • "expected_monthly_balance": "100000",
  • "relationship_with_parent": "SON",
  • "user_type": "INDIVIDUAL",
  • "business_legal_name": "Insurance corporation",
  • "business_dba_name": "John Smith insurance corporation",
  • "date_established": "2012-05-04T19:42:32.987Z",
  • "phone_number": "+551185249635",
  • "website": "example.com",
  • "designation": "CEO",
  • "shares_percentage": 100,
  • "share_controller_name": "Nabil Benaissa",
  • "local_address": {
    },
  • "incorporation_type": "LTD",
  • "entity_registered_no": "2233445533",
  • "old_entity_name": "Old name",
  • "old_entity_ops_start_date": "2012-05-04",
  • "old_entity_ops_end_date": "2014-05-04",
  • "regulated_entity": true,
  • "regulator_name": "ABC",
  • "business_activities": "IT Services",
  • "other_operated_countries": "US",
  • "tax_residence_country": "UAE",
  • "tin": "1122334455",
  • "external_auditor_name": "ABC",
  • "director_list": [
    ],
  • "signature_list": [
    ],
  • "shareholder_list": [
    ],
  • "company_onbehalf": true,
  • "company_onbehalf_relation": "John Smith",
  • "group_additional_info": {
    },
  • "pep_check_info": {
    },
  • "no_of_employees": 25,
  • "accept_cash_check": true,
  • "annual_turnover": 0,
  • "source_of_funds": "Business",
  • "source_fund_uae": true,
  • "due_diligence_declaration": {
    },
  • "license_type": "Test License Updated",
  • "license_expiry": "2025-06-06",
  • "estimated_activity_through_nymcard": "ABCD",
  • "expected_number_of_cards": "1",
  • "expected_use_of_ncs_services": "ABCD",
  • "custom_info": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "title": "MR",
  • "first_name": "John",
  • "middle_name": "Anthony",
  • "last_name": "Smith",
  • "native_name": "John Smith",
  • "native_last_name": "Júañ Hérreró",
  • "full_legal_name": "John Smith",
  • "full_name_local_language": "Volodymyr",
  • "father_name": "John Smith",
  • "mother_name": "Mary Ann",
  • "grandfather_name": "Andrew",
  • "family_name": "Smith",
  • "marital_status": "Divorced",
  • "employment_status": "Worker",
  • "business_type": "LCC",
  • "legal_form": "Company",
  • "date_of_birth": "2012-05-04",
  • "email": "bob@example.com",
  • "mobile": "+551185249635",
  • "address": {
    },
  • "gender": "MALE",
  • "education_level": "Graduate",
  • "preferred_language": "EN",
  • "place_of_birth": "USA",
  • "place_of_birth_city": "Toronto",
  • "nationality": "USA",
  • "parent_user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "created": "2012-05-04T19:42:32.987Z",
  • "created_by": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "modified_by": "API",
  • "country_residence": "USA",
  • "country_tax_residence": "USA",
  • "employment_type": "SALARIED",
  • "employment_title": "QAE",
  • "monthly_salary": "12000",
  • "company_name": "Example",
  • "company_address": {
    },
  • "company_country": "USA",
  • "industry_type": "I01",
  • "expected_monthly_balance": "100000",
  • "relationship_with_parent": "SON",
  • "user_type": "INDIVIDUAL",
  • "business_legal_name": "Insurance corporation",
  • "business_dba_name": "John Smith insurance corporation",
  • "date_established": "2012-05-04T19:42:32.987Z",
  • "phone_number": "+551185249635",
  • "website": "example.com",
  • "status": "PENDINGKYC",
  • "status_reason_code": "I0",
  • "kyc_policy_passed": "UAE_INDIVIDUAL_PRIMARY",
  • "designation": "CEO",
  • "shares_percentage": 100,
  • "share_controller_name": "Nabil Benaissa",
  • "local_address": {
    },
  • "incorporation_type": "LTD",
  • "entity_registered_no": "2233445533",
  • "old_entity_name": "Old name",
  • "old_entity_ops_start_date": "2012-05-04",
  • "old_entity_ops_end_date": "2014-05-04",
  • "regulated_entity": true,
  • "regulator_name": "ABC",
  • "business_activities": "IT Services",
  • "other_operated_countries": "US",
  • "tax_residence_country": "UAE",
  • "tin": "1122334455",
  • "external_auditor_name": "ABC",
  • "director_list": [
    ],
  • "signature_list": [
    ],
  • "shareholder_list": [
    ],
  • "company_onbehalf": true,
  • "company_onbehalf_relation": "John Smith",
  • "group_additional_info": {
    },
  • "pep_check_info": {
    },
  • "no_of_employees": 25,
  • "accept_cash_check": true,
  • "annual_turnover": 0,
  • "source_of_funds": "Business",
  • "source_fund_uae": true,
  • "due_diligence_declaration": {
    },
  • "license_type": "Test License Updated",
  • "license_expiry": "2025-06-06",
  • "estimated_activity_through_nymcard": "ABCD",
  • "expected_number_of_cards": "1",
  • "expected_use_of_ncs_services": "ABCD",
  • "custom_info": {
    }
}

Get user details

This API is used to get the details of a specific user.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the user.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "title": "MR",
  • "first_name": "John",
  • "middle_name": "Anthony",
  • "last_name": "Smith",
  • "native_name": "John Smith",
  • "native_last_name": "Júañ Hérreró",
  • "full_legal_name": "John Smith",
  • "full_name_local_language": "Volodymyr",
  • "father_name": "John Smith",
  • "mother_name": "Mary Ann",
  • "grandfather_name": "Andrew",
  • "family_name": "Smith",
  • "marital_status": "Divorced",
  • "employment_status": "Worker",
  • "business_type": "LCC",
  • "legal_form": "Company",
  • "date_of_birth": "2012-05-04",
  • "email": "bob@example.com",
  • "mobile": "+551185249635",
  • "address": {
    },
  • "gender": "MALE",
  • "education_level": "Graduate",
  • "preferred_language": "EN",
  • "place_of_birth": "USA",
  • "place_of_birth_city": "Toronto",
  • "nationality": "USA",
  • "parent_user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "created": "2012-05-04T19:42:32.987Z",
  • "created_by": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "modified_by": "API",
  • "country_residence": "USA",
  • "country_tax_residence": "USA",
  • "employment_type": "SALARIED",
  • "employment_title": "QAE",
  • "monthly_salary": "12000",
  • "company_name": "Example",
  • "company_address": {
    },
  • "company_country": "USA",
  • "industry_type": "I01",
  • "expected_monthly_balance": "100000",
  • "relationship_with_parent": "SON",
  • "user_type": "INDIVIDUAL",
  • "business_legal_name": "Insurance corporation",
  • "business_dba_name": "John Smith insurance corporation",
  • "date_established": "2012-05-04T19:42:32.987Z",
  • "phone_number": "+551185249635",
  • "website": "example.com",
  • "status": "PENDINGKYC",
  • "status_reason_code": "I0",
  • "kyc_policy_passed": "UAE_INDIVIDUAL_PRIMARY",
  • "designation": "CEO",
  • "shares_percentage": 100,
  • "share_controller_name": "Nabil Benaissa",
  • "local_address": {
    },
  • "incorporation_type": "LTD",
  • "entity_registered_no": "2233445533",
  • "old_entity_name": "Old name",
  • "old_entity_ops_start_date": "2012-05-04",
  • "old_entity_ops_end_date": "2014-05-04",
  • "regulated_entity": true,
  • "regulator_name": "ABC",
  • "business_activities": "IT Services",
  • "other_operated_countries": "US",
  • "tax_residence_country": "UAE",
  • "tin": "1122334455",
  • "external_auditor_name": "ABC",
  • "director_list": [
    ],
  • "signature_list": [
    ],
  • "shareholder_list": [
    ],
  • "company_onbehalf": true,
  • "company_onbehalf_relation": "John Smith",
  • "group_additional_info": {
    },
  • "pep_check_info": {
    },
  • "no_of_employees": 25,
  • "accept_cash_check": true,
  • "annual_turnover": 0,
  • "source_of_funds": "Business",
  • "source_fund_uae": true,
  • "due_diligence_declaration": {
    },
  • "license_type": "Test License Updated",
  • "license_expiry": "2025-06-06",
  • "estimated_activity_through_nymcard": "ABCD",
  • "expected_number_of_cards": "1",
  • "expected_use_of_ncs_services": "ABCD",
  • "custom_info": {
    }
}

Update specific user

Using this API you can update details of a specific user.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the user.

Request Body schema: application/json
required
title
string (UserTitle)
Enum: "MR" "MRS" "MISS"

The user's title/prefix.

first_name
string

User's first name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

middle_name
string

User's middle name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

last_name
string

User's last name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

native_name
string

Native name of the user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

native_last_name
string <= 60 characters

Native last name.

full_legal_name
string

Individual user name use for document verification process. It should has the same name as on legal ID document.

full_name_local_language
string <= 50 characters

User's full name in local language. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

father_name
string <= 50 characters

User's father’s name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

mother_name
string <= 50 characters

User's mother's name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

grandfather_name
string <= 50 characters

User's grandfather’s name.

family_name
string <= 50 characters

User's family name.

marital_status
string

User's marital status.

employment_status
string

User's employment status.

business_type
string <= 50 characters

User / Agent's business type information.

legal_form
string <= 50 characters

User / Agent's legal form information.

date_of_birth
string <date>

The date of birth of the user in the following format - yyyy-mm-dd. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

email
string <= 255 characters

A valid email address for the user.

mobile
string

Mobile number of the user (including area code), appended with "+" symbol and the first three digits to identify the country calling code. Please do not include hyphens, spaces or parentheses.

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

gender
string (UserGender)
Enum: "MALE" "FEMALE"

The gender of the user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

education_level
string <= 50 characters

Education level.

preferred_language
string

A selected language for 3D Secure and digital wallet token notifications sent to this user. By default, notifications are sent in English. The supported value should be provided in ISO language format.

place_of_birth
string

The place of birth of the user. The format should be ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

place_of_birth_city
string <= 50 characters

The city of birth.

nationality
string

Nationality; must be one of ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

parent_user_id
string

Unique identifier of parent user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

country_residence
string <= 3 characters

The country where the individual user resides or is currently citizen of. The format is ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

country_tax_residence
string <= 3 characters

The country for which the tax rules apply to the individual/business user and the user pays tax according to it. The format is ISO alpha 3-character country code.

employment_type
string (EmploymentType)
Enum: "SALARIED" "SELF_EMPLOYED" "RETIRED" "NOT_EMPLOYED" "BUSINESS_OWNER" "STUDENT" "HOMEMAKER" "OTHER"

The employment type of the individual user.

employment_title
string <= 50 characters

The job title (designation) for user_type = INDIVIDUAL. For user_type = BUSINESS this field can give the designation of the primary contact person of the business.

monthly_salary
number >= 0

The monthly salary of the user_type = INDIVIDUAL.

company_name
string <= 200 characters

The company name for which the individual works for in case of SALARIED OR company name that the individual runs in case of SELF-EMPLOYED OR BUSINESS_OWNER. This parameter is required if "employment_type" = 'SALARIED", "EMPLOYED" or "BUSINESS_OWNER".

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

company_country
string <= 3 characters

Company country in format of ISO alpha 3-character country code. For user_type = INDIVIDUAL this field indicates the country in which the company is registered and conducts its business and activities. For user_type = BUSINESS this field indicates the country in which the Business is registered and conducts its activities.

industry_type
string (IndustryType)
Enum: "I01" "I02" "I03" "I04" "I05" "I06" "I07" "I08" "I09" "I11" "I12" "I13" "I14" "I15" "I16" "I17" "I18" "I19" "I20" "I21" "I22" "I23" "I24" "I25" "I26" "I27" "I28" "I29" "I30" "I00"

Type of industry:

  • I01: Gambling/Casinos
  • I02: Defence/Military goods or Arms Dealers and Manufacturers
  • I03: Exchange Companies / Bureaus de Change, Money Changers, Hawala dealers / Other Finance Companies (For e.g. Derivatives Trading, Hedge Funds, Unregistered/Pvt Collective Investment Schemes)
  • I04: Real Estate Brokers / Real Estate Agencies / Real Estate Developers (Non * Govt)
  • I05: Charity Organizations, Religious/Social/Non * Profit Organizations, Cooperative/Social/Professional Societies & associations
  • I06: Auction Houses
  • I07: Dealers in Luxury Goods: (Definition of Luxury Goods include: Precious metals & Stones, Jewelry & Antiques, Art, Furs, Yachts , Executive/Private Jets)
  • I08: Trust Service Providers, Lawyers, Accountants, Tax Advisers, Auditors
  • I09: Private Banking Relationship
  • I11: Agriculture, Forestry, Fishing, and Hunting
  • I12: Mining, Quarrying, and Oil and Gas Extraction
  • I13: Utilities (water, gas, electricity)
  • I14: Telecommunications
  • I15: Construction
  • I16: Manufacturing
  • I17: Wholesale Trade
  • I18: Retail Trade and Commerce
  • I19: Transportation and Warehousing
  • I20: Technology
  • I21: Finance and Insurance
  • I22: Real Estate and Rental and Leasing
  • I23: Professional, Scientific, and Technical Services
  • I24: Management of Companies and Enterprises
  • I25: Educational Services
  • I26: Health Care and Social Assistance
  • I27: Arts, Entertainment, and Recreation
  • I28: Hotels and Food Services
  • I29: Public Administration
  • I30: Administrative and Support and Waste Management
  • I00: Other
expected_monthly_balance
number >= 0

For user_type = INDIVIDUAL this field indicates the expected monthly balance the individual user is planning to maintain in his accounts. For user_type = BUSINESS this field indicates the expected monthly balance the business is planning to maintain in its accounts.

relationship_with_parent
string (RelationshipWithParent)
Enum: "SON" "DAUGHTER" "NEPHEW" "NIECE" "HUSBAND" "WIFE" "FATHER" "MOTHER" "EMPLOYEE" "OTHER"

For a child user this field indicates the relationship of the child user with the parent user.

business_legal_name
string <= 200 characters

The business legal name. This field may be used for KYB verification. Applicable for 'user_type' = BUSINESS.

business_dba_name
string <= 50 characters

The business’s secondary name. This field may be used for KYB verification, if the business name is different from the legal business name. Applicable for 'user_type' = BUSINESS.

date_established
string <date-time>

The established date and time. Applicable for 'user_type' = BUSINESS.

phone_number
string^\+\d+

The telephone number.

website
string <= 50 characters

The website. Applicable for 'user_type' = BUSINESS.

designation
string <= 50 characters

It is mandatory to provide this parameter if 'user_type' is DIRECTOR or SIGNATURE. The valid designation should be provided, such as: CEO, CPO, CEO - (region name).

shares_percentage
number <float>

It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.

share_controller_name
string <= 100 characters

It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

incorporation_type
string (UserIncorporationType)
Enum: "LTD" "LLC" "FZE" "FZCO" "FZ-LLC" "INC" "FOUNDATION" "TRUST" "FUND" "PUBLIC_TRADED" "GOVT_OWNED" "LLP" "OTHER"

This parameter indicates whether this business entity is Limited, LLC, Free-zone or anything else.

entity_registered_no
string <= 50 characters

This parameter describes the business/entity registered number.

old_entity_name
string <= 50 characters

This parameter describes the business’s old name.

old_entity_ops_start_date
string <date-time>

It is the start date when the business was operated under old name.

old_entity_ops_end_date
string <date-time>

It is the end date when the business was operated under old name.

regulated_entity
boolean

This parameter indicates if the entity is a regulated entity or no. Possible values are true/false.

regulator_name
string <= 50 characters

This parameter indicates the regulator’s name. It is applicable if 'regulated_entity' parameter is set as 'true'.

business_activities
string <= 1000 characters

This parameter describes the business/entity activities such as Payment Service Provider, IT service provider etc. It can be a comma separated values.

other_operated_countries
string

This parameter indicates the valid country's name(s), where the business is operated.

tax_residence_country
string <= 50 characters

This parameter indicates the name of a country, where the business has a tax residence.

tin
string <= 50 characters

Tax identification number.

external_auditor_name
string <= 50 characters

Name of the external auditor.

director_list
Array of strings

The list of directors. Up to 10 directors can be linked to a business user; but directors should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

signature_list
Array of strings

The list of signatures. Up to 10 signatures can be linked to a business user; but the signatures should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

shareholder_list
Array of strings

The list of shareholders. Up to 50 shareholders can be linked to a business user; but the shareholders should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

company_onbehalf
boolean

This parameter indicates if the company is opened on behalf of another person. Possible values are true/false.

company_onbehalf_relation
string <= 50 characters

In this parameter you should confirm the relationship of the beneficial owner. It is applicable if 'company_onbehalf' parameter is set as 'true'.

object (UserGroupAdditionalInfo)

The additional information, which describes whether entity is a part of a group etc.

object (UserPepCheckInfo)

The information about checking politically exposed persons (“PEPs”) among main shareholders, directors of the entity.

no_of_employees
integer <int32> (UserNoOfEmployees)

This parameter describes the number of employees for the business entity.

accept_cash_check
boolean

This parameter indicates whether the corporate company accepts cash from end users or not. Possible values are true/false.

annual_turnover
number

This parameter describes the annual turnover of the business entity.

source_of_funds
string <= 50 characters

This parameter describes how is the company being funded.

source_fund_uae
boolean

This parameter indicates whether the business source of funds is derived from outside of the UAE or no. Possible values are true/false.

object (UserDueDiligenceDeclaration)

The information about due diligence declaration.

license_type
string <= 100 characters

The license type. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.

license_expiry
string <date>

The license expiry. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.

estimated_activity_through_nymcard
string

This parameter is optional and applicable for 'user_type' = BUSINESS.

expected_number_of_cards
integer <int32> >= 0

This parameter is optional and applicable for 'user_type' = BUSINESS.

expected_use_of_ncs_services
string

This parameter is optional and applicable for 'user_type' = BUSINESS.

object

This parameter holds additional fields configured in tenant settings. This parameter is optional.

Responses

Request samples

Content type
application/json
{
  • "title": "MR",
  • "first_name": "John",
  • "middle_name": "Anthony",
  • "last_name": "Smith",
  • "native_name": "John Smith",
  • "native_last_name": "Júañ Hérreró",
  • "full_legal_name": "John Smith",
  • "full_name_local_language": "Volodymyr",
  • "father_name": "John Smith",
  • "mother_name": "Mary Ann",
  • "grandfather_name": "Andrew",
  • "family_name": "Smith",
  • "marital_status": "Divorced",
  • "employment_status": "Worker",
  • "business_type": "LCC",
  • "legal_form": "Company",
  • "date_of_birth": "2012-05-04",
  • "email": "bob@example.com",
  • "mobile": "+551185249635",
  • "address": {
    },
  • "gender": "MALE",
  • "education_level": "Graduate",
  • "preferred_language": "EN",
  • "place_of_birth": "USA",
  • "place_of_birth_city": "Toronto",
  • "nationality": "USA",
  • "parent_user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "country_residence": "USA",
  • "country_tax_residence": "USA",
  • "employment_type": "SALARIED",
  • "employment_title": "QAE",
  • "monthly_salary": "12000",
  • "company_name": "Example",
  • "company_address": {
    },
  • "company_country": "USA",
  • "industry_type": "I01",
  • "expected_monthly_balance": "100000",
  • "relationship_with_parent": "SON",
  • "business_legal_name": "Insurance corporation",
  • "business_dba_name": "John Smith insurance corporation",
  • "date_established": "2012-05-04T19:42:32.987Z",
  • "phone_number": "+551185249635",
  • "website": "example.com",
  • "designation": "CEO",
  • "shares_percentage": 100,
  • "share_controller_name": "Nabil Benaissa",
  • "local_address": {
    },
  • "incorporation_type": "LTD",
  • "entity_registered_no": "2233445533",
  • "old_entity_name": "Old name",
  • "old_entity_ops_start_date": "2012-05-04",
  • "old_entity_ops_end_date": "2014-05-04",
  • "regulated_entity": true,
  • "regulator_name": "ABC",
  • "business_activities": "IT Services",
  • "other_operated_countries": "US",
  • "tax_residence_country": "UAE",
  • "tin": "1122334455",
  • "external_auditor_name": "ABC",
  • "director_list": [
    ],
  • "signature_list": [
    ],
  • "shareholder_list": [
    ],
  • "company_onbehalf": true,
  • "company_onbehalf_relation": "John Smith",
  • "group_additional_info": {
    },
  • "pep_check_info": {
    },
  • "no_of_employees": 25,
  • "accept_cash_check": true,
  • "annual_turnover": 0,
  • "source_of_funds": "Business",
  • "source_fund_uae": true,
  • "due_diligence_declaration": {
    },
  • "license_type": "Test License Updated",
  • "license_expiry": "2025-06-06",
  • "estimated_activity_through_nymcard": "ABCD",
  • "expected_number_of_cards": "1",
  • "expected_use_of_ncs_services": "ABCD",
  • "custom_info": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "title": "MR",
  • "first_name": "John",
  • "middle_name": "Anthony",
  • "last_name": "Smith",
  • "native_name": "John Smith",
  • "native_last_name": "Júañ Hérreró",
  • "full_legal_name": "John Smith",
  • "full_name_local_language": "Volodymyr",
  • "father_name": "John Smith",
  • "mother_name": "Mary Ann",
  • "grandfather_name": "Andrew",
  • "family_name": "Smith",
  • "marital_status": "Divorced",
  • "employment_status": "Worker",
  • "business_type": "LCC",
  • "legal_form": "Company",
  • "date_of_birth": "2012-05-04",
  • "email": "bob@example.com",
  • "mobile": "+551185249635",
  • "address": {
    },
  • "gender": "MALE",
  • "education_level": "Graduate",
  • "preferred_language": "EN",
  • "place_of_birth": "USA",
  • "place_of_birth_city": "Toronto",
  • "nationality": "USA",
  • "parent_user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "created": "2012-05-04T19:42:32.987Z",
  • "created_by": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "modified_by": "API",
  • "country_residence": "USA",
  • "country_tax_residence": "USA",
  • "employment_type": "SALARIED",
  • "employment_title": "QAE",
  • "monthly_salary": "12000",
  • "company_name": "Example",
  • "company_address": {
    },
  • "company_country": "USA",
  • "industry_type": "I01",
  • "expected_monthly_balance": "100000",
  • "relationship_with_parent": "SON",
  • "user_type": "INDIVIDUAL",
  • "business_legal_name": "Insurance corporation",
  • "business_dba_name": "John Smith insurance corporation",
  • "date_established": "2012-05-04T19:42:32.987Z",
  • "phone_number": "+551185249635",
  • "website": "example.com",
  • "status": "PENDINGKYC",
  • "status_reason_code": "I0",
  • "kyc_policy_passed": "UAE_INDIVIDUAL_PRIMARY",
  • "designation": "CEO",
  • "shares_percentage": 100,
  • "share_controller_name": "Nabil Benaissa",
  • "local_address": {
    },
  • "incorporation_type": "LTD",
  • "entity_registered_no": "2233445533",
  • "old_entity_name": "Old name",
  • "old_entity_ops_start_date": "2012-05-04",
  • "old_entity_ops_end_date": "2014-05-04",
  • "regulated_entity": true,
  • "regulator_name": "ABC",
  • "business_activities": "IT Services",
  • "other_operated_countries": "US",
  • "tax_residence_country": "UAE",
  • "tin": "1122334455",
  • "external_auditor_name": "ABC",
  • "director_list": [
    ],
  • "signature_list": [
    ],
  • "shareholder_list": [
    ],
  • "company_onbehalf": true,
  • "company_onbehalf_relation": "John Smith",
  • "group_additional_info": {
    },
  • "pep_check_info": {
    },
  • "no_of_employees": 25,
  • "accept_cash_check": true,
  • "annual_turnover": 0,
  • "source_of_funds": "Business",
  • "source_fund_uae": true,
  • "due_diligence_declaration": {
    },
  • "license_type": "Test License Updated",
  • "license_expiry": "2025-06-06",
  • "estimated_activity_through_nymcard": "ABCD",
  • "expected_number_of_cards": "1",
  • "expected_use_of_ncs_services": "ABCD",
  • "custom_info": {
    }
}

Change user status

This API is used to change user status.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of the user.

Request Body schema: application/json
required
status
required
string (UserStatus)
Enum: "PENDINGKYC" "PENDINGKYB" "ACTIVE" "SUSPENDED" "TERMINATED" "PENDINGIDVERIFICATION"

The status of the user.

status_reason_code
required
string (UserStatusReasonCode)
Enum: "I0" "A0" "A1" "A2" "A3" "A4" "A5" "A6" "A7" "A8" "B0" "B0I" "B1" "B1I" "B2" "B3" "B4" "B5" "B6" "B7" "B8" "B9" "B10" "B11" "B1E" "B2E" "B0E" "B9E" "B10E" "B11E" "B12" "B19" "S0" "S1" "S2" "S3" "S4" "S5" "S6" "S7" "S8" "S9" "T0" "T1" "T2" "T3" "T4" "T5" "T6" "T7" "T8" "T9" "T10" "T11" "T12" "T13" "T12E" "T13E" "T14" "O1"

Status Change Reason Code:

  • I0: Initial status.
  • A0: First time activation: when activated from PENDINGKYC to ACTIVE status.
  • A1: Resumed from Suspended status: when user is moved back to ACTIVE status.
  • A2: Admin Activated the user from status suspended.
  • A3: Admin activated the user by manual intervention from the dashboard.
  • A4: Admin Activated the business user from status suspended.
  • A5: Admin Activated.
  • A6: Document expired or about to expire.
  • A7: ID renewed.
  • A8: ID re-verification failed after document expiration.
  • B0: Documents are uploaded successfully for identity verification.
  • B0I: Documents are uploaded successfully, but user profile is not complete.
  • B1: Identity is not verified, manual intervention required.
  • B1I: Documents are verified, manual intervention required.
  • B2: SDK token is no longer valid, please generate a new SDK token.
  • B3: Admin approved, proceed to KYC verification flow.
  • B4: Name mismatched.
  • B5: Identity verification consider with caution status and name mismatched.
  • B6: Identity verification consider.
  • B7: Date of birth consider.
  • B8: Documents are uploaded successfully for identity verification (where provider is not Onfido).
  • B9: Document issuing country mismatch.
  • B10: Identity verification consider with caution status and document issuing country mismatch.
  • B11: Documents are uploaded successfully for identity verification (multiple providers).
  • B1E: Identity is not verified, manual intervention required in Re-Uploading Case.
  • B2E: Generate SDK token, document expired (same as B2).
  • B0E: Documents re-uploaded after document expiration for identity verification (same as B0).
  • B9E: Document issuing country mismatch upon IDV re-verification after document expiration.
  • B10E: Identity verification consider with caution status and document issuing country mismatch upon IDV re-verification after document expiration.
  • B11E: Documents re-uploaded after document expiration for identity verification (Onfido) - same as B0E (multiple providers configured).
  • B12: Resubmission of document (configured provider is not Onfido).
  • B19: Allowed number of users per National ID/Passport limit is exceeded.
  • S0: Temporary suspension: initiated by the user or system user or the system.
  • S1: Inactivity over time.
  • S2: Suspended by Admin.
  • S3: Suspended by Admin.
  • S4: Suspended by Admin.
  • S5: Suspended by Admin.
  • S6: Suspended by Admin.
  • S7: IDV not renewed and document expiration grace period reached.
  • S8: Allowed number of users per National ID/Passport limit is exceeded.
  • S9: Suspended by Host.
  • T0: Closed by user.
  • T1: Closed by issuer.
  • T2: Failed KYC.
  • T3: Terminated by Admin.
  • T4: Terminated by Admin.
  • T5: Admin terminated due to ID verification failed.
  • T6: Admin terminated due to KYC failed.
  • T7: Admin terminated due to limited time exceeded and action taken for ID verification fail.
  • T8: Terminated by Admin.
  • T9: Admin terminated due to ID verification failed.
  • T10: Admin terminated due to limited time exceeded and action taken for KYB fail.
  • T11: Admin terminated due to certain reason.
  • T12: System terminated due to ID verification rejected.
  • T13: System terminated due to ID verification suspected.
  • T12E: System terminated due to ID verification rejected after document expiration for identity verification (same as T12).
  • T13E: System terminated due to ID verification suspected after document expiration for identity verification (same as T13).
  • T14: Allowed number of users per National ID/Passport limit is exceeded.
  • O1: Other reason.
note
string

This field is to capture additional information while changing the user status.

modified_by
string
Default: "API"

This field indicates the user who executed the operation.

Responses

Request samples

Content type
application/json
{
  • "status": "PENDINGKYC",
  • "status_reason_code": "I0",
  • "note": "Some note regarding the reason of user status change.",
  • "modified_by": "API"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "title": "MR",
  • "first_name": "John",
  • "middle_name": "Anthony",
  • "last_name": "Smith",
  • "native_name": "John Smith",
  • "native_last_name": "Júañ Hérreró",
  • "full_legal_name": "John Smith",
  • "full_name_local_language": "Volodymyr",
  • "father_name": "John Smith",
  • "mother_name": "Mary Ann",
  • "grandfather_name": "Andrew",
  • "family_name": "Smith",
  • "marital_status": "Divorced",
  • "employment_status": "Worker",
  • "business_type": "LCC",
  • "legal_form": "Company",
  • "date_of_birth": "2012-05-04",
  • "email": "bob@example.com",
  • "mobile": "+551185249635",
  • "address": {
    },
  • "gender": "MALE",
  • "education_level": "Graduate",
  • "preferred_language": "EN",
  • "place_of_birth": "USA",
  • "place_of_birth_city": "Toronto",
  • "nationality": "USA",
  • "parent_user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "created": "2012-05-04T19:42:32.987Z",
  • "created_by": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "modified_by": "API",
  • "country_residence": "USA",
  • "country_tax_residence": "USA",
  • "employment_type": "SALARIED",
  • "employment_title": "QAE",
  • "monthly_salary": "12000",
  • "company_name": "Example",
  • "company_address": {
    },
  • "company_country": "USA",
  • "industry_type": "I01",
  • "expected_monthly_balance": "100000",
  • "relationship_with_parent": "SON",
  • "user_type": "INDIVIDUAL",
  • "business_legal_name": "Insurance corporation",
  • "business_dba_name": "John Smith insurance corporation",
  • "date_established": "2012-05-04T19:42:32.987Z",
  • "phone_number": "+551185249635",
  • "website": "example.com",
  • "status": "PENDINGKYC",
  • "status_reason_code": "I0",
  • "kyc_policy_passed": "UAE_INDIVIDUAL_PRIMARY",
  • "designation": "CEO",
  • "shares_percentage": 100,
  • "share_controller_name": "Nabil Benaissa",
  • "local_address": {
    },
  • "incorporation_type": "LTD",
  • "entity_registered_no": "2233445533",
  • "old_entity_name": "Old name",
  • "old_entity_ops_start_date": "2012-05-04",
  • "old_entity_ops_end_date": "2014-05-04",
  • "regulated_entity": true,
  • "regulator_name": "ABC",
  • "business_activities": "IT Services",
  • "other_operated_countries": "US",
  • "tax_residence_country": "UAE",
  • "tin": "1122334455",
  • "external_auditor_name": "ABC",
  • "director_list": [
    ],
  • "signature_list": [
    ],
  • "shareholder_list": [
    ],
  • "company_onbehalf": true,
  • "company_onbehalf_relation": "John Smith",
  • "group_additional_info": {
    },
  • "pep_check_info": {
    },
  • "no_of_employees": 25,
  • "accept_cash_check": true,
  • "annual_turnover": 0,
  • "source_of_funds": "Business",
  • "source_fund_uae": true,
  • "due_diligence_declaration": {
    },
  • "license_type": "Test License Updated",
  • "license_expiry": "2025-06-06",
  • "estimated_activity_through_nymcard": "ABCD",
  • "expected_number_of_cards": "1",
  • "expected_use_of_ncs_services": "ABCD",
  • "custom_info": {
    }
}

Get user alias

This API is used to get user alias.

Authorizations:
oauth
path Parameters
user_id
required
string

The unique identifier of the user.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "3e9392df-4093-4389-a0ad-92456a181b8a",
  • "alias": "Smith",
  • "status": true,
  • "user_id": "4e9392df-4093-4389-a0ad-69376a181b8a",
  • "account_id": "5e9392df-4093-4389-a0ad-036746a181b8a",
  • "full_name": "John Smith",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Create user alias

This API is used to create user alias.

Authorizations:
oauth
path Parameters
user_id
required
string

The unique identifier of the user.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

x-nfront-device-id
string
Request Body schema: application/json
id
string <= 36 characters

The unique identifier of user alias.

alias
required
string <= 40 characters

The alias.

status
boolean

The alias status.

account_id
required
string <= 36 characters

The unique identifier of account.

Responses

Request samples

Content type
application/json
{
  • "id": "3e9392df-4093-4389-a0ad-92456a181b8a",
  • "alias": "Smith",
  • "status": true,
  • "account_id": "5e9392df-4093-4389-a0ad-036746a181b8a"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "3e9392df-4093-4389-a0ad-92456a181b8a",
  • "alias": "Smith",
  • "status": true,
  • "user_id": "4e9392df-4093-4389-a0ad-69376a181b8a",
  • "account_id": "5e9392df-4093-4389-a0ad-036746a181b8a",
  • "full_name": "John Smith",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Update user alias

This API is used to update user alias.

Authorizations:
oauth
path Parameters
user_id
required
string

The unique identifier of the user.

id
required
string

The unique identifier of alias.

header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

x-nfront-device-id
string
Request Body schema: application/json
alias
string <= 40 characters

The alias.

status
boolean

The alias status.

account_id
string <= 36 characters

The unique identifier of account.

Responses

Request samples

Content type
application/json
{
  • "alias": "Smith",
  • "status": true,
  • "account_id": "5e9392df-4093-4389-a0ad-036746a181b8a"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "3e9392df-4093-4389-a0ad-92456a181b8a",
  • "alias": "Smith",
  • "status": true,
  • "user_id": "4e9392df-4093-4389-a0ad-69376a181b8a",
  • "account_id": "5e9392df-4093-4389-a0ad-036746a181b8a",
  • "full_name": "John Smith",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Title fetch

This API is used to create title fetch.

Authorizations:
oauth
Request Body schema: application/json
type
required
string (TitleFetchType)
Value: "ALIAS"

The title fetch type.

value
required
string <= 40 characters

The title fetch value.

Responses

Request samples

Content type
application/json
{
  • "type": "ALIAS",
  • "value": "3908340680"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "account_id": "5e9392df-4093-4389-a0ad-036746a181b8a",
  • "full_name": "John Smith"
}

Search for users

Authorizations:
oauth
Request Body schema: application/json
required
name
string

Filter by first, middle and last names of the user. Search works for complete or partial string.

mobile
string

Filter by mobile number of the user. Search works for complete or partial string.

email
string

Filter by user's email. Search works for complete or partial string.

status
Array of strings
Items Enum: "ACTIVE" "PENDINGKYC" "PENDINGKYB" "PENDINGIDVERIFICATION" "SUSPENDED" "TERMINATED"

Filter by user's status.

user_type
string (UserType)
Enum: "INDIVIDUAL" "BUSINESS" "DIRECTOR" "SIGNATURE" "SHAREHOLDER" "SHAREHOLDER_BUSINESS" "AGENT"

The type of the user. You can find all necessary fields per each user type in this GSG doc - https://docs.nymcard.com/get-started/program-management/necessary-parameters-per-user-type. Note, that 'AGENT' user can have a 'parent_user_id' corresponding to an 'AGENT' or 'BUSINESS' user (and not the other user types).

business_legal_name
string

Filter by business legal name, search for complete or partial string.

business_dba_name
string

Filter by business DBA name, search for complete or partial string.

website
string

Filter by website, search for complete or partial string.

created_from
string <date-time>

Search users created on this date and onwards.

created_to
string <date-time>

Search users created prior to this date.

modified_from
string <date-time>

Search users modified on this date and onwards.

modified_to
string <date-time>

Search users modified prior to this date.

limit
integer

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

The way results should be sorted.

order_by
string (SortDirection)
Enum: "asc" "desc"

The way results should be ordered (ascending or descending).

Responses

Request samples

Content type
application/json
{
  • "name": "John",
  • "mobile": "+559999999995",
  • "email": "johndoe@example.com",
  • "status": [
    ],
  • "user_type": "INDIVIDUAL",
  • "business_legal_name": "Insurance corporation",
  • "business_dba_name": "John Smith insurance corporation",
  • "website": "example.com",
  • "created_from": "2012-05-04T19:42:32.987Z",
  • "created_to": "2012-05-04T19:42:32.987Z",
  • "modified_from": "2012-05-04T19:42:32.987Z",
  • "modified_to": "2012-05-04T19:42:32.987Z",
  • "limit": "10",
  • "after": "MTA=",
  • "sort_by": "created",
  • "order_by": "asc"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "Durable version of current results",
  • "has_more": true,
  • "data": [
    ]
}

Get user identifications

This API is used to get user identifications.

Authorizations:
oauth
path Parameters
user_id
required
string

The unique identifier of the user.

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Remittance-Mastercard

This section includes remittance Mastercard releated APIs.

Initiate transaction to Mastercard

This API is used to initiate transaction to Mastercard.

Authorizations:
oauth
header Parameters
x-nymos-idempotency-key
required
string <= 36 characters

Idempotency key.

otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

x-nfront-device-id
string

Device ID.

Request Body schema: application/json
required
required
object (InitiateTransactionSender)

Transaction sender info.

required
object (InitiateTransactionReceiver)

Transaction receiver info.

required
object (InitiateTransactionInfo)

Transaction info.

object (InitiateTransactionCompliance)

Transaction compliance info.

Responses

Request samples

Content type
application/json
{
  • "sender": {
    },
  • "receiver": {
    },
  • "transaction_info": {
    },
  • "compliance": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "StatusName": "R",
  • "StatusId": "38634869",
  • "TfPin": "0000045",
  • "TransactionDate": "2023-06-01T00:00:00.000-04:00",
  • "CanBeCancelled": false,
  • "RequiresPreAml": false,
  • "RequiresPostAml": false,
  • "Sender": {
    },
  • "Receiver": {
    },
  • "TransactionInfo": {
    }
}

Get transaction details

This API is used to retrieve transaction details by TfPin or reference number.

Authorizations:
oauth
query Parameters
key
required
string
Enum: "tfpin" "refnumber"

tfpin (Transaction number) or refnumber (Reference number).

value
required
string

Unique transaction number depends on the provided key.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "status_name": "PENDING RELEASE",
  • "status_id": "R",
  • "tf_pin": "33TF119564665",
  • "cancellation_reason": "01",
  • "transaction_date": "2023-07-07T14:41:29.723-04:00",
  • "sender": {
    },
  • "receiver": {
    },
  • "transaction_info": {
    },
  • "compliance": {
    }
}

Get list of receiver countries

This API is used to get the list of allowed countries where you can send remittance via Mastercard cross border.

Authorizations:
x-consumer-usernameoauth

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "countries": [
    ]
}

Get country details

This API is used to get details of a specific country using a country code.

Authorizations:
x-consumer-usernameoauth
query Parameters
country_code
required
string^[A-Za-z]{2}$

Country code in ISO 3166 format.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "country_code": "AL",
  • "states": [
    ],
  • "id_types": [
    ],
  • "remittance_purposes": [
    ],
  • "source_of_funds": [
    ]
}

Get list of cities

This API is used to retrieve the list of cities by country code.

Authorizations:
x-consumer-usernameoauth
query Parameters
country_code
required
string

Country code in ISO 3166 format.

state_id
string

State ID.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "total_count": "1",
  • "cities": [
    ]
}

Get payment details

This API is used to retrieve payment modes and designated currencies for selected country for Mastercard cross border.

Authorizations:
x-consumer-usernameoauth
query Parameters
country_code
required
string

Country code in ISO 3166 format.

city_id
string

City ID

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "country_code": "US",
  • "cash_pickup_anywhere": true,
  • "payment_modes": [
    ]
}

Get list of banks

This API is used to retrieve the list of banks using a country code.

Authorizations:
x-consumer-usernameoauth
query Parameters
country_code
required
string

ISO country code.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "totalCount": 3,
  • "banks": [
    ]
}

Get bank branches

This API is used to retrieve the list of bank branches.

Authorizations:
x-consumer-usernameoauth
query Parameters
bank_id
required
string

The unique identifier of the bank.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "totalCount": 2,
  • "getBankBranch": [
    ]
}

Get indicative rates

This API is used to check indicative exchange rates, fees and sent/received amount before sending remittance for Mastercard cross border.

Authorizations:
x-consumer-usernameoauth
query Parameters
receiver_currency_code
required
string

Receiver currency code.

receiver_country_code
required
string

Receiver country code.

source_currency_code
required
string

Source currency code.

receive_amount
number

Receive amount.

sent_amount
number

Sent amount.

bank_id
string

Bank ID.

payment_mode_id
required
string

Payment mode ID.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "tran_amount": 110,
  • "tran_fee_amount": 10,
  • "original_tran_amount": 100,
  • "receiver_amount": 217,
  • "receiver_currency_code": "INR",
  • "receiver_country_code": "IN",
  • "source_currency_code": "USD",
  • "transaction_rate": 2.17
}

Remittance-Billers

This section includes remittance billers releated APIs.

Get Biller details

This API is used to get biller details.

Authorizations:
oauth
query Parameters
country
string

ISO country code.

type
string

Type of biller detail.

limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Get biller country list

This API is used to get biller country list.

Authorizations:
x-consumer-usernameoauth

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Get payment details

This API is used to retrieve payment details.

Authorizations:
oauth
path Parameters
billerId
required
string

The unique identifier of the biller.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "biller_id": "586000000000023",
  • "sku": [
    ]
}

Perform payment inquiry

This API is used to get payment inquiry.

Authorizations:
oauth
Request Body schema: application/json
required

Payment inquiry.

merchant_name
string <= 50 characters

The merchant name.

transaction_id
required
integer <int64> <= 12 characters

The unique identifier of transaction.

customer_id
integer <int64> <= 12 characters

The unique identifier of a customer.

biller_id
required
integer <int64>

The unique identifier of a biller.

sku
required
integer <int64>

SKU.

inputs
required
string <= 50 characters

The inputs.

Responses

Request samples

Content type
application/json
{
  • "merchant_name": "fintech1",
  • "transaction_id": "398759048753",
  • "customer_id": "385738475",
  • "biller_id": "586000000000007",
  • "sku": "00000000000000000001",
  • "inputs": "0509320091734"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "transaction_response_id": "1009781",
  • "transaction_id": "987654123456",
  • "bill_due_date": "2023-01-31",
  • "customer_name": "John",
  • "output1": "0509320091734|78DTS96DGS",
  • "bills_due": 1,
  • "output2": null,
  • "indicative_fxrate": "280.3478",
  • "details_billing_currency": {
    },
  • "details_base_currency": {
    }
}

Mobile Carrier Lookup

This API is used for mobile carrier lookup.

Authorizations:
x-consumer-usernameoauth
Request Body schema: application/json
required

Mobile carrier lookup request.

MobileNumber
required
string

The mobile number.

Responses

Request samples

Content type
application/json
{
  • "MobileNumber": "4905734976"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "ResponseCode": "00",
  • "ResponseMessage": "Process complete",
  • "ResponseDateTime": "2023-12-04 10:39:45",
  • "Country": {
    },
  • "Biller": {
    },
  • "SKU": [
    ],
  • "Output1": "8801811473295"
}

Perform payment

This API is used to perform payment.

Authorizations:
oauth
header Parameters
otp_id
string

Return ID of OTP when challenged to provide sms or email code.

otp_type
string

Selected type of OTP if provided with choice.

otp_email
string

Return code received over email along with otp_id.

otp_sms
string

Return code received over sms along with otp_id.

otp_auth
string

Return user autentication info.

x-nfront-device-id
string

Device id.

Request Body schema: application/json
required

Perform payment request.

merchant_name
required
string <= 50 characters

The merchant name.

customer_id
string <= 12 characters

The unique identifier of a customer.

biller_id
required
string

The unique identifier of a biller.

sku
required
string

The stock keeping unit.

inputs
required
string <= 999 characters

Inputs.

wallet_id
string <= 50 characters

The unique identifier of a wallet.

card_id
string <= 50 characters

The unique identifier of a card.

payment_amount
required
string <= 10 characters

The payment amount.

payment_currency
required
string <= 3 characters

The payment currency.

billing_amount
required
string <= 10 characters

The billing amount.

billing_currency
required
string <= 3 characters

The billing currency.

note
string <= 100 characters

Some note.

otp
string <= 10 characters

The OTP code.

initiation_id
string

The unique identifier of initiation.

Responses

Request samples

Content type
application/json
{
  • "merchant_name": "fintech1",
  • "customer_id": "396794673",
  • "biller_id": "484000000000200",
  • "sku": "00000000000000000001",
  • "inputs": "35535",
  • "wallet_id": "7600e9b7-5cld3-4e96-9a9d-8fd8a7705eed",
  • "card_id": "7600e9b7-5cd3-4e96-9a9d-8fd8a7705eed",
  • "payment_amount": "10.00",
  • "payment_currency": "AED",
  • "billing_amount": "100.00",
  • "billing_currency": "MXN",
  • "note": "Some info",
  • "otp": "507063",
  • "initiation_id": "6901bf10-65d4-4662-822d-e836855fa213"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "response_code": "00",
  • "response_message": "Process complete",
  • "response_date_time": "2024-01-11 11:33:02",
  • "confirmation_number": "4976",
  • "transaction_response_id": "181188",
  • "transaction_id": "921614223456",
  • "payment_amount": "10.00",
  • "payment_currency": "AED",
  • "billing_amount": "100.00",
  • "billing_currency": "MXN"
}

Remittance-Beneficiary

This section includes remittance beneficiary releated APIs.

Search beneficiary

This API is used to search for beneficiary by specific parameters.

Authorizations:
oauth
query Parameters
user_id
string

The unique identifier of user.

nickname
string

The nickname.

phone
string

The user's phone number.

category
string

The category.

category_display_name
string

The category display name.

subcategory
string

The subcategory.

subcategory_display_name
string

The subcategory display name.

instrument_type
string

The instrument type.

instrument_currency
string

The instrument currency.

country
string

The country.

limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Create beneficiary

This API is used to create beneficiary.

Authorizations:
oauth
Request Body schema: application/json
required
id
string <= 36 characters

ID for the new Beneficiary. If ID is not provided then it will be auto generated.

name
required
string

Beneficiary name.

email
required
string

Beneficiary email.

phone
required
string

Beneficiary phone.

nickname
required
string

Beneficiary nickname.

relationship
string

Beneficiary relationship.

category
required
string (BeneficiaryCategory)
Enum: "DAPI" "LEAN" "WU" "MCSEND" "VISADIRECT" "CHECKOUT" "BILRS" "P2P"

Beneficiary category.

subcategory
string (BeneficiarySubcategory)
Enum: "BILR" "TELCO" "PAN" "ALIAS" "IBAN"

Beneficiary subcategory.

instrument_type
string (InstrumentType)
Enum: "CARD" "ACCOUNT"

Instrument type.

instrument_value
required
string

The instrument value.

instrument_currency
string^[A-Z]{3}$

The instrument currency.

beneficiary_user_id
string

Beneficiary user ID.

user_id
required
string

User ID.

country
string

Beneficiary country.

bank
string

Beneficiary bank.

status
required
string (BeneficiaryStatus)
Enum: "ACTIVE" "INACTIVE"

Beneficiary status.

Responses

Request samples

Content type
application/json
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7558",
  • "name": "John Smith",
  • "email": "example@gmail.com",
  • "phone": "+923323556323",
  • "nickname": "Commettie Group",
  • "relationship": "Partner",
  • "category": "DAPI",
  • "subcategory": "ALIAS",
  • "instrument_type": "CARD",
  • "instrument_value": "03323556323",
  • "instrument_currency": "AED",
  • "beneficiary_user_id": "4906486",
  • "user_id": "John1",
  • "country": "UAE",
  • "bank": "ING",
  • "status": "ACTIVE"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "77a02486-10e2-4d55-9788-d0d49ed03d23",
  • "name": "John Smith",
  • "email": "example@gmail.com",
  • "phone": "+923323556323",
  • "nickname": "Commettie Group",
  • "relationship": "Partner",
  • "category": "DAPI",
  • "subcategory": "ALIAS",
  • "instrument_type": "CARD",
  • "instrument_value": "03323556323",
  • "instrument_currency": "AED",
  • "beneficiary_user_id": "4906486",
  • "user_id": "John1",
  • "country": "UAE",
  • "bank": "ING",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "status": "ACTIVE",
  • "is_deleted": false
}

Get beneficiary by ID

This API is used to retrieve beneficiary by ID.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of beneficiary.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "77a02486-10e2-4d55-9788-d0d49ed03d23",
  • "name": "John Smith",
  • "email": "example@gmail.com",
  • "phone": "+923323556323",
  • "nickname": "Commettie Group",
  • "relationship": "Partner",
  • "category": "DAPI",
  • "subcategory": "ALIAS",
  • "instrument_type": "CARD",
  • "instrument_value": "03323556323",
  • "instrument_currency": "AED",
  • "beneficiary_user_id": "4906486",
  • "user_id": "John1",
  • "country": "UAE",
  • "bank": "ING",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "status": "ACTIVE",
  • "is_deleted": false
}

Update beneficiary

This API is used to edit specific beneficiary.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of beneficiary.

Request Body schema: application/json
required
name
string

Beneficiary name.

email
string

Beneficiary email.

phone
string

Beneficiary phone.

nickname
string

Beneficiary nickname.

relationship
string

Beneficiary relationship.

category
string (BeneficiaryCategory)
Enum: "DAPI" "LEAN" "WU" "MCSEND" "VISADIRECT" "CHECKOUT" "BILRS" "P2P"

Beneficiary category.

subcategory
string (BeneficiarySubcategory)
Enum: "BILR" "TELCO" "PAN" "ALIAS" "IBAN"

Beneficiary subcategory.

instrument_type
string (InstrumentType)
Enum: "CARD" "ACCOUNT"

Instrument type.

instrument_value
string

The instrument value.

instrument_currency
string^[A-Z]{3}$

The instrument currency.

beneficiary_user_id
string

Beneficiary user ID.

user_id
string

User ID.

country
string

Beneficiary country.

bank
string

Beneficiary bank.

status
string (BeneficiaryStatus)
Enum: "ACTIVE" "INACTIVE"

Beneficiary status.

Responses

Request samples

Content type
application/json
{
  • "name": "John Smith",
  • "email": "example@gmail.com",
  • "phone": "+923323556323",
  • "nickname": "Commettie Group",
  • "relationship": "Partner",
  • "category": "DAPI",
  • "subcategory": "ALIAS",
  • "instrument_type": "CARD",
  • "instrument_value": "03323556323",
  • "instrument_currency": "AED",
  • "beneficiary_user_id": "4906486",
  • "user_id": "John1",
  • "country": "UAE",
  • "bank": "ING",
  • "status": "ACTIVE"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "77a02486-10e2-4d55-9788-d0d49ed03d23",
  • "name": "John Smith",
  • "email": "example@gmail.com",
  • "phone": "+923323556323",
  • "nickname": "Commettie Group",
  • "relationship": "Partner",
  • "category": "DAPI",
  • "subcategory": "ALIAS",
  • "instrument_type": "CARD",
  • "instrument_value": "03323556323",
  • "instrument_currency": "AED",
  • "beneficiary_user_id": "4906486",
  • "user_id": "John1",
  • "country": "UAE",
  • "bank": "ING",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "status": "ACTIVE",
  • "is_deleted": false
}

Delete beneficiary

This API is used to delete specific beneficiary.

Authorizations:
oauth
path Parameters
id
required
string

The unique identifier of beneficiary.

Responses

Remittance-Lookup

This section includes remittance lookup releated APIs.

Get list of countries

This API is used to retrieve the list of countries.

Authorizations:
x-consumer-usernameoauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

iso_code_2
string

2 Digit country code in ISO format.

iso_code_3
string

3 digit country code in ISO format.

name
string >= 3 characters

Substring of country name that’s being searched.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Get list of cities

This API is used to retrieve the list of cities.

Authorizations:
x-consumer-usernameoauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

country_code
required
integer

Country where cities are under from country collection.

state_code
integer

State identifier from states collection.

city_name
string >= 3 characters

Substring of city that’s being searched.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

admins

API for managing Application User and their related information

Initiates the autentication flow

Authorizations:
x-consumer-usernameoauth
Request Body schema: application/json
required
username
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "username": "string",
  • "password": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "admin_id": "string",
  • "admin": {
    },
  • "flow": "mobile_verification",
  • "custom_token": {
    }
}

Continues flow with mobile verification

Authorizations:
x-consumer-usernameoauth
path Parameters
session_id
required
string
query Parameters
code
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "admin_id": "string",
  • "admin": {
    },
  • "flow": "mobile_verification",
  • "custom_token": {
    }
}

Continues flow with email verification

Authorizations:
x-consumer-usernameoauth
path Parameters
session_id
required
string
query Parameters
code
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "admin_id": "string",
  • "admin": {
    },
  • "flow": "mobile_verification",
  • "custom_token": {
    }
}

Continues flow with password change

Authorizations:
x-consumer-usernameoauth
path Parameters
session_id
required
string
Request Body schema: application/json
required
old_password
required
string
new_password
required
string

Responses

Request samples

Content type
application/json
{
  • "old_password": "string",
  • "new_password": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "admin_id": "string",
  • "admin": {
    },
  • "flow": "mobile_verification",
  • "custom_token": {
    }
}

Initiates the authentication flow

Authorizations:
x-consumer-usernameoauth
path Parameters
email
required
string
header Parameters
X-Consumer-Username
required
string

Responses

Initiates the authentication flow

Authorizations:
x-consumer-usernameoauth
query Parameters
id
required
string
token
required
string
Request Body schema: application/json
required
password
string

Responses

Request samples

Content type
application/json
{
  • "password": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "admin_id": "string",
  • "admin": {
    },
  • "flow": "mobile_verification",
  • "custom_token": {
    }
}

Initiates the authentication flow

Authorizations:
x-consumer-usernameoauth
query Parameters
id
required
string
token
required
string

Responses

Invalidates session

Authorizations:
x-consumer-usernameoauth
path Parameters
session_id
required
string

Responses

loadActiveAdminPasswordPolicy

Authorizations:
x-consumer-usernameoauth

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "rules": [
    ],
  • "settings": {
    }
}

admins-internal

Gets all admins.

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

first_name
string
last_name
string
mobile_number
string
email
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Creates a new admin

Authorizations:
oauth
Request Body schema: application/json
required
first_name
required
string <= 100 characters ^[a-zA-z]+$
last_name
required
string <= 100 characters ^[a-zA-z,'-]+$
email
required
string <= 50 characters ^[_A-Za-z0-9-\+]+(\.[_A-Za-z0-9-]+)*@[A-Za-z0...
mobile
required
string <= 50 characters ^\+\d+
roles
required
Array of strings non-empty
two_fa_required
required
boolean
Default: false

enable or disable 2-Factor Authentication

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Snow",
  • "email": "bob@example.com",
  • "mobile": 551185249635,
  • "roles": [
    ],
  • "two_fa_required": false
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "first_name": "John",
  • "last_name": "Snow",
  • "email": "bob@example.com",
  • "mobile": 551185249635,
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "roles": [
    ],
  • "status": "ACTIVE",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "two_fa_required": true,
  • "is_onboarding_required": false,
  • "is_onboarded": true
}

Creates a new agent

Authorizations:
oauth
Request Body schema: application/json
required
first_name
required
string <= 100 characters ^[a-zA-z]+$
last_name
required
string <= 100 characters ^[a-zA-z,'-]+$
email
required
string <= 50 characters ^[_A-Za-z0-9-\+]+(\.[_A-Za-z0-9-]+)*@[A-Za-z0...
mobile
required
string <= 50 characters ^\+\d+
two_fa_required
boolean
Default: false

enable or disable 2-Factor Authentication

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Snow",
  • "email": "bob@example.com",
  • "mobile": 551185249635,
  • "two_fa_required": false
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "first_name": "John",
  • "last_name": "Snow",
  • "email": "bob@example.com",
  • "mobile": 551185249635,
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "roles": [
    ],
  • "status": "ACTIVE",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "two_fa_required": true,
  • "is_onboarding_required": false,
  • "is_onboarded": true
}

Load single admin

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "first_name": "John",
  • "last_name": "Snow",
  • "email": "bob@example.com",
  • "mobile": 551185249635,
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "roles": [
    ],
  • "status": "ACTIVE",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "two_fa_required": true,
  • "is_onboarding_required": false,
  • "is_onboarded": true
}

Updates an existing admin.

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
first_name
string <= 100 characters ^[a-zA-z]+$
last_name
string <= 100 characters ^[a-zA-z,'-]+$
email
string <= 50 characters ^[_A-Za-z0-9-\+]+(\.[_A-Za-z0-9-]+)*@[A-Za-z0...
mobile
string <= 50 characters ^\+\d+
roles
Array of strings
status
string (AdminStatus)
Enum: "ACTIVE" "TERMINATED" "SUSPENDED" "LOCKED"
two_fa_required
boolean

enable or disable 2-Factor Authentication

is_onboarding_required
boolean
Default: false

flag to indicate if the admin is required to be onboarded

is_onboarded
boolean

Responses

Request samples

Content type
application/json
{
  • "first_name": "John",
  • "last_name": "Snow",
  • "email": "bob@example.com",
  • "mobile": 551185249635,
  • "roles": [
    ],
  • "status": "ACTIVE",
  • "two_fa_required": true,
  • "is_onboarding_required": false,
  • "is_onboarded": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "first_name": "John",
  • "last_name": "Snow",
  • "email": "bob@example.com",
  • "mobile": 551185249635,
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "roles": [
    ],
  • "status": "ACTIVE",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "two_fa_required": true,
  • "is_onboarding_required": false,
  • "is_onboarded": true
}

Will reset credentials and send by email

Authorizations:
oauth
path Parameters
id
required
string

Responses

loadAdminPasswordPolicies

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

createAdminPasswordPolicy

Authorizations:
oauth
Request Body schema: application/json
required
description
required
string <= 50 characters
is_active
required
boolean
required
Array of objects (PasswordPolicyRuleRequest) non-empty
required
object (PasswordPolicySettingsRequest)
name
required
string <= 36 characters

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "is_active": true,
  • "rules": [
    ],
  • "settings": {
    },
  • "name": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "rules": [
    ],
  • "settings": {
    }
}

loadAdminPasswordPolicy

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "rules": [
    ],
  • "settings": {
    }
}

updateAdminPasswordPolicy

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
description
required
string <= 50 characters
is_active
required
boolean
required
Array of objects (PasswordPolicyRuleRequest) non-empty
required
object (PasswordPolicySettingsRequest)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "is_active": true,
  • "rules": [
    ],
  • "settings": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "is_active": true,
  • "rules": [
    ],
  • "settings": {
    }
}

loadAdminSessionSummary

Authorizations:
oauth
path Parameters
session_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "is_active": true
}

oauth2-internal

Generates an access token

Authorizations:
oauth
Request Body schema: application/json
required
provider
string
user_id
required
string
device_id
string
signup_channel
string
signup_session
string
signup_trusted
boolean
scopes
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "provider": "nfrontSdk|nfrontSignup",
  • "user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "device_id": "f3c9f184-9ce4-4f78-bf6b-4427865736a6",
  • "signup_channel": "IB|MB",
  • "signup_session": "string",
  • "signup_trusted": true,
  • "scopes": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "access_token": "4E4F54205245414C2044415441202D207468697320",
  • "token_type": "bearer",
  • "expires_in": 3600,
  • "refresh_token": "4E4F54205245414C2044415441202D207468697320",
  • "refresh_expires_in": 3600,
  • "scope": "Token scope"
}

refreshAccessToken

Authorizations:
oauth
Request Body schema: application/json
required
refresh_token
required
string
object (RefreshAccessTokenValidationData)

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "string",
  • "validationData": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "access_token": "4E4F54205245414C2044415441202D207468697320",
  • "token_type": "bearer",
  • "expires_in": 3600,
  • "refresh_token": "4E4F54205245414C2044415441202D207468697320",
  • "refresh_expires_in": 3600,
  • "scope": "Token scope"
}

otp-internal

Retrieve OTP settings by criteria

Authorizations:
oauth
query Parameters
otpOperationType
required
string
otpOperationCode
required
string
otpType
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "operation_type": "SERVICE",
  • "operation_code": "DEFAULT",
  • "is_active": true,
  • "otp_types": [
    ],
  • "duration": 0,
  • "length": 0,
  • "max_retries": 0,
  • "format": "NUMERIC",
  • "is_split": true,
  • "alert_type": [
    ],
  • "rate_limit": 10,
  • "lock_duration": 600,
  • "bypass_on_trusted_device": true,
  • "bypass_on_untrusted_device": true
}

Get OTP settings

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Create OTP settings

Authorizations:
oauth
Request Body schema: application/json
required
operation_type
required
string (OtpOperationType)
Enum: "SERVICE" "TRANSACTION"
operation_code
required
string (OtpOperationCode)
Enum: "DEFAULT" "LOGIN" "VERIFY_USER" "SET_PASSWORD" "RESET_PASSWORD" "REVEAL_CARD" "CHANGE_PIN" "SHOW_PIN" "ACTIVATE_CARD" "REACTIVATE_CARD" "BLOCK_CARD" "FUNDS_TRANSFER" "MC_CROSS_BORDER" "BILLERS_PAYMENT" "CL_TOPUP" "CL_FIRSTTOPUP" "CL_WITHDRAWAL" "USER_ALIAS_CREATE" "USER_ALIAS_CHANGE" "CHECKOUT_PAYMENT" "UPDATE_BALANCE_LIMIT" "UPDATE_VELOCITY_LIMIT" "ENABLE_BIOMETRICS" "DISABLE_BIOMETRICS"
is_active
required
boolean
otp_types
required
Array of strings (OtpType) >= 0 items
Items Enum: "OTP" "AUTH_PASSWORD" "AUTH_PASSCODE" "VOUCHERCODE" "BIOMETRIC"
duration
required
integer

Duration in seconds for which OTP remains valid

length
required
integer

Number of digits

max_retries
required
integer

Maximum invalid retries

format
required
string (OtpFormat)
Enum: "NUMERIC" "ALPHANUMERIC"
is_split
required
boolean

Split OTP Flag (true / false)

alert_type
required
Array of strings (AlertType) non-empty
Items Enum: "SMS" "EMAIL" "WHATSAPP"

Alert type

rate_limit
required
integer
Default: 10

Rate limit specifies the number of requests that are allowed during rate limit cycle

lock_duration
required
integer
Default: 600

Lock duration specifies the duration for which OTP generation on a particular operation will be suspended for the user (seconds)

bypass_on_trusted_device
required
boolean
bypass_on_untrusted_device
boolean

Responses

Request samples

Content type
application/json
{
  • "operation_type": "SERVICE",
  • "operation_code": "DEFAULT",
  • "is_active": true,
  • "otp_types": [
    ],
  • "duration": 0,
  • "length": 0,
  • "max_retries": 0,
  • "format": "NUMERIC",
  • "is_split": true,
  • "alert_type": [
    ],
  • "rate_limit": 10,
  • "lock_duration": 600,
  • "bypass_on_trusted_device": true,
  • "bypass_on_untrusted_device": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "operation_type": "SERVICE",
  • "operation_code": "DEFAULT",
  • "is_active": true,
  • "otp_types": [
    ],
  • "duration": 0,
  • "length": 0,
  • "max_retries": 0,
  • "format": "NUMERIC",
  • "is_split": true,
  • "alert_type": [
    ],
  • "rate_limit": 10,
  • "lock_duration": 600,
  • "bypass_on_trusted_device": true,
  • "bypass_on_untrusted_device": true
}

Get OTP settings

Authorizations:
oauth
path Parameters
settings_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "operation_type": "SERVICE",
  • "operation_code": "DEFAULT",
  • "is_active": true,
  • "otp_types": [
    ],
  • "duration": 0,
  • "length": 0,
  • "max_retries": 0,
  • "format": "NUMERIC",
  • "is_split": true,
  • "alert_type": [
    ],
  • "rate_limit": 10,
  • "lock_duration": 600,
  • "bypass_on_trusted_device": true,
  • "bypass_on_untrusted_device": true
}

Update OTP settings

Authorizations:
oauth
path Parameters
settings_id
required
string
Request Body schema: application/json
required
operation_type
string (OtpOperationType)
Enum: "SERVICE" "TRANSACTION"
operation_code
string (OtpOperationCode)
Enum: "DEFAULT" "LOGIN" "VERIFY_USER" "SET_PASSWORD" "RESET_PASSWORD" "REVEAL_CARD" "CHANGE_PIN" "SHOW_PIN" "ACTIVATE_CARD" "REACTIVATE_CARD" "BLOCK_CARD" "FUNDS_TRANSFER" "MC_CROSS_BORDER" "BILLERS_PAYMENT" "CL_TOPUP" "CL_FIRSTTOPUP" "CL_WITHDRAWAL" "USER_ALIAS_CREATE" "USER_ALIAS_CHANGE" "CHECKOUT_PAYMENT" "UPDATE_BALANCE_LIMIT" "UPDATE_VELOCITY_LIMIT" "ENABLE_BIOMETRICS" "DISABLE_BIOMETRICS"
is_active
boolean
otp_types
Array of strings (OtpType)
Items Enum: "OTP" "AUTH_PASSWORD" "AUTH_PASSCODE" "VOUCHERCODE" "BIOMETRIC"
duration
integer

Duration in seconds for which OTP remains valid

length
integer

Number of digits

max_retries
integer

Maximum invalid retries

format
string (OtpFormat)
Enum: "NUMERIC" "ALPHANUMERIC"
is_split
boolean

Split OTP Flag (true / false)

alert_type
Array of strings (AlertType) non-empty
Items Enum: "SMS" "EMAIL" "WHATSAPP"

Alert type

rate_limit
integer
lock_duration
integer
bypass_on_trusted_device
boolean
bypass_on_untrusted_device
boolean

Responses

Request samples

Content type
application/json
{
  • "operation_type": "SERVICE",
  • "operation_code": "DEFAULT",
  • "is_active": true,
  • "otp_types": [
    ],
  • "duration": 0,
  • "length": 0,
  • "max_retries": 0,
  • "format": "NUMERIC",
  • "is_split": true,
  • "alert_type": [
    ],
  • "rate_limit": 0,
  • "lock_duration": 0,
  • "bypass_on_trusted_device": true,
  • "bypass_on_untrusted_device": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "operation_type": "SERVICE",
  • "operation_code": "DEFAULT",
  • "is_active": true,
  • "otp_types": [
    ],
  • "duration": 0,
  • "length": 0,
  • "max_retries": 0,
  • "format": "NUMERIC",
  • "is_split": true,
  • "alert_type": [
    ],
  • "rate_limit": 10,
  • "lock_duration": 600,
  • "bypass_on_trusted_device": true,
  • "bypass_on_untrusted_device": true
}

Process OTP generation/validation logic

Authorizations:
oauth
Request Body schema: application/json
required
user_id
required
string
fallback_email
string
fallback_mobile
string
channel
string
trusted_device
boolean

if request is made from a trusted device

fingerprint
required
string
operation_type
required
string (OtpOperationType)
Enum: "SERVICE" "TRANSACTION"
operation_code
required
string (OtpOperationCode)
Enum: "DEFAULT" "LOGIN" "VERIFY_USER" "SET_PASSWORD" "RESET_PASSWORD" "REVEAL_CARD" "CHANGE_PIN" "SHOW_PIN" "ACTIVATE_CARD" "REACTIVATE_CARD" "BLOCK_CARD" "FUNDS_TRANSFER" "MC_CROSS_BORDER" "BILLERS_PAYMENT" "CL_TOPUP" "CL_FIRSTTOPUP" "CL_WITHDRAWAL" "USER_ALIAS_CREATE" "USER_ALIAS_CHANGE" "CHECKOUT_PAYMENT" "UPDATE_BALANCE_LIMIT" "UPDATE_VELOCITY_LIMIT" "ENABLE_BIOMETRICS" "DISABLE_BIOMETRICS"
otp_id
string
otp_type
string (OtpType)
Enum: "OTP" "AUTH_PASSWORD" "AUTH_PASSCODE" "VOUCHERCODE" "BIOMETRIC"
otp_email
string

Code received by email

otp_sms
string

Code received by sms

otp_auth
string

User passcode or password, biometric info in future

auto_expire
boolean

Determines if positive verification expires Otp

device_id
string

Device id

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "fallback_email": "string",
  • "fallback_mobile": "string",
  • "channel": "string",
  • "trusted_device": true,
  • "fingerprint": "string",
  • "operation_type": "SERVICE",
  • "operation_code": "DEFAULT",
  • "otp_id": "string",
  • "otp_type": "OTP",
  • "otp_email": "string",
  • "otp_sms": "string",
  • "otp_auth": "string",
  • "auto_expire": true,
  • "device_id": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "otp_id": "string",
  • "response_type": "OTP_REQUIRED_OTP_TYPE",
  • "otp_types": [
    ],
  • "otp_settings": {
    }
}

Process OTP generation/validation logic

Authorizations:
oauth
Request Body schema: application/json
required
email
string
mobile
string
fingerprint
required
string
operation_type
required
string (OtpOperationType)
Enum: "SERVICE" "TRANSACTION"
operation_code
required
string (OtpOperationCode)
Enum: "DEFAULT" "LOGIN" "VERIFY_USER" "SET_PASSWORD" "RESET_PASSWORD" "REVEAL_CARD" "CHANGE_PIN" "SHOW_PIN" "ACTIVATE_CARD" "REACTIVATE_CARD" "BLOCK_CARD" "FUNDS_TRANSFER" "MC_CROSS_BORDER" "BILLERS_PAYMENT" "CL_TOPUP" "CL_FIRSTTOPUP" "CL_WITHDRAWAL" "USER_ALIAS_CREATE" "USER_ALIAS_CHANGE" "CHECKOUT_PAYMENT" "UPDATE_BALANCE_LIMIT" "UPDATE_VELOCITY_LIMIT" "ENABLE_BIOMETRICS" "DISABLE_BIOMETRICS"
otp_id
string
otp_email
string
otp_sms
string
auto_expire
boolean

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "mobile": "string",
  • "fingerprint": "string",
  • "operation_type": "SERVICE",
  • "operation_code": "DEFAULT",
  • "otp_id": "string",
  • "otp_email": "string",
  • "otp_sms": "string",
  • "auto_expire": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "otp_id": "string",
  • "response_type": "OTP_REQUIRED_OTP_TYPE",
  • "otp_types": [
    ],
  • "otp_settings": {
    }
}

permissions

API for managing Permissions

Loads all permissions instances.

Authorizations:
oauth
query Parameters
role_category
string
channel
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "data": [
    ]
}

roles

API for managing Roles

List roles

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

name
string
category
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Creates a new role

Authorizations:
oauth
Request Body schema: application/json
required
name
required
string <= 40 characters
description
string <= 300 characters
category
required
string (RoleCategory)
Enum: "ADMIN" "RESTRICTED" "GENERAL" "MOBILE"
status
string (RoleStatus)
Enum: "ACTIVE" "INACTIVE"
permissions
Array of strings non-empty

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "category": "ADMIN",
  • "status": "ACTIVE",
  • "permissions": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "category": "ADMIN",
  • "permissions": [
    ],
  • "status": "ACTIVE",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Get role

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "category": "ADMIN",
  • "permissions": [
    ],
  • "status": "ACTIVE",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2019-08-24T14:15:22Z"
}

Update role

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string <= 40 characters
description
string <= 300 characters
category
string (RoleCategory)
Enum: "ADMIN" "RESTRICTED" "GENERAL" "MOBILE"
status
string (RoleStatus)
Enum: "ACTIVE" "INACTIVE"
permissions
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "description": "string",
  • "category": "ADMIN",
  • "status": "ACTIVE",
  • "permissions": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "name": "string",
  • "description": "string",
  • "category": "ADMIN",
  • "permissions": [
    ],
  • "status": "ACTIVE",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2019-08-24T14:15:22Z"
}

rbac-internal

API for rbac

Loads all permission ids for given roles.

Authorizations:
oauth
Request Body schema: application/json
required
roles
Array of strings

Responses

Request samples

Content type
application/json
{
  • "roles": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "permissions": [
    ]
}

hierarchies

API for managing Hierarchies

List hierarchies

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

name
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Creates a new hierarchy

Authorizations:
oauth
Request Body schema: application/json
required
id
string

The unique identifier of the hierarchy

name
required
string

Unique name of the tenant / hierarchy

enforce_levels
boolean
Default: false

If true, system will enforce the escalation levels as per the configured hierarchy otherwise system will not escalate for approval as per the hierarchy.

required
Array of objects (HierarchyLevel) non-empty

Hierarchy / Escalation levels

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "enforce_levels": false,
  • "levels": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "name": "string",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "enforce_levels": false,
  • "levels": [
    ]
}

Get hierarchy

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "name": "string",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "enforce_levels": false,
  • "levels": [
    ]
}

Update hierarchy

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
name
string

Unique name of the tenant / hierarchy

enforce_levels
boolean
Default: false

If true, system will enforce the escalation levels as per the configured hierarchy otherwise system will not escalate for approval as per the hierarchy.

Array of objects (HierarchyLevel)

Hierarchy / Escalation levels

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "enforce_levels": false,
  • "levels": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "name": "string",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2019-08-24T14:15:22Z",
  • "enforce_levels": false,
  • "levels": [
    ]
}

sdkInit

sdk initialization

Authorizations:
x-consumer-usernameoauth
Request Body schema: application/json
required
user_id
required
string
device_id
required
string

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "device_id": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "access_token": "4E4F54205245414C2044415441202D207468697320",
  • "token_type": "bearer",
  • "expires_in": 3600
}

sdkSettings

createSdkSettings

Authorizations:
oauth
Request Body schema: application/json
required
card_types
required
Array of strings (CardType) non-empty unique
Items Enum: "PHYSICAL" "VIRTUAL"
card_products
required
Array of strings non-empty unique
master_card_product
string <= 36 characters
activate_cards_upon_top_up
boolean
notification_provider
required
string (NotificationProvider)
Value: "FIREBASE"

Supported notification providers

Array of objects (CardCurrencyProduct)
object (NotificationSettings)
object (CardAutoCreationSettings)
object (CardAutoCreationSettings)
app_download_link
string
app_login_link
string
onboarding_token_expiry
integer <int32> >= 0
user_id_generation_required
boolean
object (UserIdGenerationSettings)

Responses

Request samples

Content type
application/json
{
  • "card_types": [
    ],
  • "card_products": [
    ],
  • "master_card_product": "string",
  • "activate_cards_upon_top_up": true,
  • "notification_provider": "FIREBASE",
  • "card_currency_products": [
    ],
  • "notification_settings": {
    },
  • "child_auto_card_creation": {
    },
  • "parent_auto_card_creation": {
    },
  • "app_download_link": "string",
  • "app_login_link": "string",
  • "onboarding_token_expiry": 0,
  • "user_id_generation_required": true,
  • "user_id_generation_settings": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "tenant_id": "string",
  • "card_types": [
    ],
  • "card_products": [
    ],
  • "master_card_product": "string",
  • "activate_cards_upon_top_up": true,
  • "notification_provider": "FIREBASE",
  • "card_currency_products": [
    ],
  • "notification_settings": {
    },
  • "child_auto_card_creation": {
    },
  • "parent_auto_card_creation": {
    },
  • "app_download_link": "string",
  • "app_login_link": "string",
  • "onboarding_token_expiry": 0,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "user_id_generation_required": true,
  • "user_id_generation_settings": {
    }
}

updateSdkSettings

Authorizations:
oauth
Request Body schema: application/json
required
card_types
Array of strings (CardType) non-empty unique
Items Enum: "PHYSICAL" "VIRTUAL"
card_products
Array of strings non-empty unique
master_card_product
string <= 36 characters
activate_cards_upon_top_up
boolean
notification_provider
string (NotificationProvider)
Value: "FIREBASE"

Supported notification providers

Array of objects (CardCurrencyProduct)
object (NotificationSettings)
object (CardAutoCreationSettings)
object (CardAutoCreationSettings)
app_download_link
string
app_login_link
string
onboarding_token_expiry
integer <int32> >= 0
user_id_generation_required
boolean
object (UserIdGenerationSettings)

Responses

Request samples

Content type
application/json
{
  • "card_types": [
    ],
  • "card_products": [
    ],
  • "master_card_product": "string",
  • "activate_cards_upon_top_up": true,
  • "notification_provider": "FIREBASE",
  • "card_currency_products": [
    ],
  • "notification_settings": {
    },
  • "child_auto_card_creation": {
    },
  • "parent_auto_card_creation": {
    },
  • "app_download_link": "string",
  • "app_login_link": "string",
  • "onboarding_token_expiry": 0,
  • "user_id_generation_required": true,
  • "user_id_generation_settings": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "tenant_id": "string",
  • "card_types": [
    ],
  • "card_products": [
    ],
  • "master_card_product": "string",
  • "activate_cards_upon_top_up": true,
  • "notification_provider": "FIREBASE",
  • "card_currency_products": [
    ],
  • "notification_settings": {
    },
  • "child_auto_card_creation": {
    },
  • "parent_auto_card_creation": {
    },
  • "app_download_link": "string",
  • "app_login_link": "string",
  • "onboarding_token_expiry": 0,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "user_id_generation_required": true,
  • "user_id_generation_settings": {
    }
}

getSdkSettings

Authorizations:
oauth

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "tenant_id": "string",
  • "card_types": [
    ],
  • "card_products": [
    ],
  • "master_card_product": "string",
  • "activate_cards_upon_top_up": true,
  • "notification_provider": "FIREBASE",
  • "card_currency_products": [
    ],
  • "notification_settings": {
    },
  • "child_auto_card_creation": {
    },
  • "parent_auto_card_creation": {
    },
  • "app_download_link": "string",
  • "app_login_link": "string",
  • "onboarding_token_expiry": 0,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "user_id_generation_required": true,
  • "user_id_generation_settings": {
    }
}

channelSettings

createChannelSettings

Authorizations:
oauth
Request Body schema: application/json
required
channel_id
required
string (SdkChannel)
Enum: "IB" "MB" "ATM" "BO" "KIOSK" "POS" "CRM" "API"
channel_name
required
string
signup_flow
required
string (SdkSignupFlow)
Enum: "PASSWORD" "PASSWORD_WITH_PASSCODE" "PASSCODE"

Supported flows

signup_identification_types
Array of strings (SdkSignupIdentificationType) non-empty unique
Items Enum: "EMAIL" "MOBILE"
allowed_trusted_devices_number
required
integer [ 0 .. 99 ]
internal_deeplink
string <= 200 characters
user_notification_required
boolean

Responses

Request samples

Content type
application/json
{
  • "channel_id": "IB",
  • "channel_name": "string",
  • "signup_flow": "PASSWORD",
  • "signup_identification_types": [
    ],
  • "allowed_trusted_devices_number": 99,
  • "internal_deeplink": "string",
  • "user_notification_required": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "channel_id": "string",
  • "channel_name": "string",
  • "signup_flow": "PASSWORD",
  • "signup_identification_types": [
    ],
  • "allowed_trusted_devices_number": 0,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "internal_deeplink": "string",
  • "user_notification_required": true
}

getAllChannelSettings

Authorizations:
oauth

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "data": [
    ]
}

updateChannelSettings

Authorizations:
oauth
path Parameters
channel_id
required
string
Request Body schema: application/json
required
channel_name
string
signup_flow
string (SdkSignupFlow)
Enum: "PASSWORD" "PASSWORD_WITH_PASSCODE" "PASSCODE"

Supported flows

signup_identification_types
Array of strings (SdkSignupIdentificationType) non-empty unique
Items Enum: "EMAIL" "MOBILE"
allowed_trusted_devices_number
integer [ 0 .. 99 ]
internal_deeplink
string <= 200 characters
user_notification_required
boolean

Responses

Request samples

Content type
application/json
{
  • "channel_name": "string",
  • "signup_flow": "PASSWORD",
  • "signup_identification_types": [
    ],
  • "allowed_trusted_devices_number": 99,
  • "internal_deeplink": "string",
  • "user_notification_required": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "channel_id": "string",
  • "channel_name": "string",
  • "signup_flow": "PASSWORD",
  • "signup_identification_types": [
    ],
  • "allowed_trusted_devices_number": 0,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "internal_deeplink": "string",
  • "user_notification_required": true
}

getChannelSettings

Authorizations:
oauth
path Parameters
channel_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "channel_id": "string",
  • "channel_name": "string",
  • "signup_flow": "PASSWORD",
  • "signup_identification_types": [
    ],
  • "allowed_trusted_devices_number": 0,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "internal_deeplink": "string",
  • "user_notification_required": true
}

signup-internal

loadPasswordPolicies

Authorizations:
oauth
query Parameters
type
string
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

createPasswordPolicy

Authorizations:
oauth
Request Body schema: application/json
required
name
required
string <= 36 characters
type
required
string (SignupPasswordType)
Enum: "PASSWORD" "PASSCODE"

The sign-up password type.

description
required
string <= 50 characters
is_active
required
boolean
required
Array of objects (SignupPasswordPolicyRuleRequest) non-empty
required
object (SignupPasswordPolicySettingsRequest)

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "type": "PASSWORD",
  • "description": "string",
  • "is_active": true,
  • "rules": [
    ],
  • "settings": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "5e18bf36-9356-4437-a11f-b2e425556096",
  • "type": "PASSWORD",
  • "name": "Policy 1",
  • "description": "Some info",
  • "is_active": true,
  • "is_default": false,
  • "rules": [
    ],
  • "settings": {
    }
}

loadPasswordPolicy

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "5e18bf36-9356-4437-a11f-b2e425556096",
  • "type": "PASSWORD",
  • "name": "Policy 1",
  • "description": "Some info",
  • "is_active": true,
  • "is_default": false,
  • "rules": [
    ],
  • "settings": {
    }
}

updatePasswordPolicy

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
description
string <= 50 characters
is_active
boolean
Array of objects (SignupPasswordPolicyRuleRequest) non-empty
object (SignupPasswordPolicySettingsRequest)

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "is_active": true,
  • "rules": [
    ],
  • "settings": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "5e18bf36-9356-4437-a11f-b2e425556096",
  • "type": "PASSWORD",
  • "name": "Policy 1",
  • "description": "Some info",
  • "is_active": true,
  • "is_default": false,
  • "rules": [
    ],
  • "settings": {
    }
}

loadSignupSessionSummary

Authorizations:
oauth
path Parameters
session_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "is_active": true
}

changePassword

Authorizations:
oauth
Request Body schema: application/json
required
old_password
string

The old password.

old_passcode
string

The old passcode.

new_password
string

The new password.

new_passcode
string

The new passcode.

Responses

Request samples

Content type
application/json
{
  • "old_password": "12345",
  • "old_passcode": "1234",
  • "new_password": "505087",
  • "new_passcode": "9797"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "available_auth_methods": [
    ]
}

setPassword

Authorizations:
oauth
header Parameters
otp_id
string

Return id of otp when challenged to provide sms or email code

otp_type
string

Selected type of otp if provided with choice

otp_email
string

Return code received over email along with otp_id

otp_sms
string

Return code received over sms along with otp_id

otp_auth
string

Return user autentication info.

Request Body schema: application/json
required
password
string
passcode
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "passcode": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "available_auth_methods": [
    ]
}

setPasswordWithoutV2

Authorizations:
oauth
header Parameters
otp_id
string

Return id of otp when challenged to provide sms or email code

otp_type
string

Selected type of otp if provided with choice

otp_email
string

Return code received over email along with otp_id

otp_sms
string

Return code received over sms along with otp_id

otp_auth
string

Return user autentication info

Request Body schema: application/json
required
password
string
passcode
string

Responses

Request samples

Content type
application/json
{
  • "password": "string",
  • "passcode": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "available_auth_methods": [
    ]
}

getTrustedDevices

Authorizations:
oauth

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

createTrustedDevice

Authorizations:
oauth
Request Body schema: application/json
required
device_id
string
device_name
string

Responses

Request samples

Content type
application/json
{
  • "device_id": "string",
  • "device_name": "string"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "user_id": "string",
  • "device_id": "string",
  • "device_name": "string",
  • "channel": "IB",
  • "status": "INACTIVE",
  • "status_reason_code": "I0",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

getTrustedDevice

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "user_id": "string",
  • "device_id": "string",
  • "device_name": "string",
  • "channel": "IB",
  • "status": "INACTIVE",
  • "status_reason_code": "I0",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

updateTrustedDevice

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
status
string (SignupUserTrustedDeviceStatus)
Enum: "INACTIVE" "ACTIVE" "SUSPENDED" "TERMINATED"
status_reason_code
string (SignupUserStatusReasonCode)
Enum: "I0" "A0" "S0" "T0"

Responses

Request samples

Content type
application/json
{
  • "status": "INACTIVE",
  • "status_reason_code": "I0"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "user_id": "string",
  • "device_id": "string",
  • "device_name": "string",
  • "channel": "IB",
  • "status": "INACTIVE",
  • "status_reason_code": "I0",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

removeTrustedDevices

Authorizations:
oauth
path Parameters
id
required
string

Responses

loadUserAuthInfo

Authorizations:
oauth
path Parameters
user_id
required
string
channel
required
string
query Parameters
passwordType
string

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

verifyUserAuthInfo

Authorizations:
oauth
path Parameters
user_id
required
string
channel
required
string
Request Body schema: application/json
required
type
string (SignupPasswordType)
Enum: "PASSWORD" "PASSCODE"

The sign-up password type.

password
string

Responses

Request samples

Content type
application/json
{
  • "type": "PASSWORD",
  • "password": "string"
}

loadUser

Authorizations:
oauth
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "5e18bf36-9356-4437-a11f-b2e425556096",
  • "username": "John",
  • "verified_mobile": "+971502562929",
  • "verified_email": "example@gmail.com",
  • "notification_email": "example2@gmail.com",
  • "parent_user_id": "6688bf36-9356-4437-a11f-b2e425556096",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

createSupplementaryUser

Authorizations:
oauth
Request Body schema: application/json
required
parent_user_id
required
string
is_minor
boolean
Default: true
username
string
object (SupplementaryUserIdentification)

Responses

Request samples

Content type
application/json
{
  • "parent_user_id": "string",
  • "is_minor": true,
  • "username": "string",
  • "identification": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "5e18bf36-9356-4437-a11f-b2e425556096",
  • "username": "John",
  • "verified_mobile": "+971502562929",
  • "verified_email": "example@gmail.com",
  • "notification_email": "example2@gmail.com",
  • "parent_user_id": "6688bf36-9356-4437-a11f-b2e425556096",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Enable Biometrics

Authorizations:
oauth
header Parameters
x-nfront-device-id
required
string
otp_id
string

Return id of otp when challenged to provide sms or email code

otp_type
string

Selected type of otp if provided with choice

otp_email
string

Return code received over email along with otp_id

otp_sms
string

Return code received over sms along with otp_id

otp_auth
string

Return user autentication info

Request Body schema: application/json
required
public_key
required
string

Responses

Request samples

Content type
application/json
{
  • "public_key": "string"
}

Disable Biometrics

Authorizations:
oauth
header Parameters
x-nfront-device-id
required
string
otp_id
string

Return id of otp when challenged to provide sms or email code

otp_type
string

Selected type of otp if provided with choice

otp_email
string

Return code received over email along with otp_id

otp_sms
string

Return code received over sms along with otp_id

otp_auth
string

Return user autentication info

Responses

Verify Biometrics

Authorizations:
oauth
Request Body schema: application/json
required
user_id
required
string
device_id
required
string
token
required
string
token_signature
required
string

Responses

Request samples

Content type
application/json
{
  • "user_id": "string",
  • "device_id": "string",
  • "token": "string",
  • "token_signature": "string"
}

Get Biometric Status

Authorizations:
oauth
header Parameters
x-nfront-device-id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "biometric_enabled": true
}

Get Biometric Status

Authorizations:
oauth
query Parameters
device_id
required
string
user_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "biometric_enabled": true
}

transactions

proxy-accounts

List accounts

Authorizations:
oauth
query Parameters
user_id
string
type
string
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "MjAxOC0wMS0wMlQxOTo0MjozMi45ODda",
  • "has_more": true,
  • "data": [
    ]
}

Create account

Authorizations:
oauth
Request Body schema: application/json
required
id
string <= 36 characters

The unique identifier of the account. If this information is not present in the request,the system generates one automatically.

user_id
required
string

The unique identifier of the user.

card_product_id
required
string

The unique identifier of the card product. This token ID is referred to as an existing card product.

type
required
string (AccountType)
Enum: "PREPAID" "DEBIT" "CREDIT" "SAVINGS" "COLLATERAL" "SECURITY" "MASTER"

Supported account types.

currencies
Array of strings

An array of currencies. It is used to create account with several currencies. If currency is not passed in this API, account is created with only 1 currency (base currency).

Responses

Request samples

Content type
application/json
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "gg5a80f-e641-4045-8a80-54841e4a55555",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "type": "PREPAID",
  • "currencies": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "gg5a80f-e641-4045-8a80-54841e4a55555",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "type": "PREPAID",
  • "subType": "REVOLVING",
  • "balances": {
    },
  • "ledger_balances": {
    },
  • "status": "ACTIVE",
  • "currencies": [
    ],
  • "wallet_details": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "modified_by": "API"
}

Get account

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "gg5a80f-e641-4045-8a80-54841e4a55555",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "type": "PREPAID",
  • "subType": "REVOLVING",
  • "balances": {
    },
  • "ledger_balances": {
    },
  • "status": "ACTIVE",
  • "currencies": [
    ],
  • "wallet_details": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "modified_by": "API"
}

Update account

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
Array of objects (WalletDetails)

An array of wallet details.

Responses

Request samples

Content type
application/json
{
  • "wallet_details": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "gg5a80f-e641-4045-8a80-54841e4a55555",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "type": "PREPAID",
  • "subType": "REVOLVING",
  • "balances": {
    },
  • "ledger_balances": {
    },
  • "status": "ACTIVE",
  • "currencies": [
    ],
  • "wallet_details": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "modified_by": "API"
}

Search for load/unload transactions

Authorizations:
x-consumer-usernameoauth
path Parameters
id
required
string
query Parameters
type
required
string

LOAD or UNLOAD

Request Body schema: application/json
required
query
string

A search query.

sort_by
string

The way results should be sorted.

order_by
string (SortDirection)
Enum: "asc" "desc"

The way results should be ordered (ascending or descending).

matcher
string (SearchMatcher)
Enum: "and" "or"

Search matcher.

Array of objects (SearchFilter)

An array of search filters.

object (Cursors)

Cursors

limit
integer <int32>

Search limit.

Responses

Request samples

Content type
application/json
{
  • "query": "Transfer",
  • "sort_by": "By name",
  • "order_by": "asc",
  • "matcher": "and",
  • "filters": [
    ],
  • "cursors": {
    },
  • "limit": 0
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Change account status

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
status
required
string (AccountStatus)
Enum: "ACTIVE" "SUSPENDED" "TERMINATED"

Account status.

  1. The card account when created shall be in Active status. While in Active status the account can be used for loading/unloading of funds and to process card authorizations and clearings.

  2. The account status can be changed from Active to Suspended status. When in Suspended status the account does not allow loading/unloading of funds and to process card authorizations. However clearings coming from the scheme are processed. Suspended status is a temporary status and the account status is allowed to change back to Active status.

  3. The account status can be changed to Terminated status. This is a permanent status, the account status can be changed to Terminated status only when card account closure operation is explicitly performed. You can update account status to Terminated if account has no balance or account has no pending authorizations.

modified_by
string
Default: "API"

This field indicates the user who executed the operation.

Responses

Request samples

Content type
application/json
{
  • "status": "ACTIVE",
  • "modified_by": "API"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "gg5a80f-e641-4045-8a80-54841e4a55555",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "type": "PREPAID",
  • "subType": "REVOLVING",
  • "balances": {
    },
  • "ledger_balances": {
    },
  • "status": "ACTIVE",
  • "currencies": [
    ],
  • "wallet_details": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "modified_by": "API"
}

Link cards to the account

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
ids
required
Array of strings

The unique identifier or the proxy number of the card(s).

dry_run
required
boolean
Default: false

This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false, and the default value is false.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ],
  • "dry_run": false
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Get balancelimits by account id

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Linking the balance limit with account

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
balance_limit_id
required
string

The unique identifier of the balance limit.

Responses

Request samples

Content type
application/json
{
  • "balance_limit_id": "d089a80f-e641-4045-8a80-54841e4a7458"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "balance_limit_id": "d089a80f-e641-4045-8a80-54841e4a7458"
}

Unlinking the balance limit with account

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
balance_limit_id
required
string

The unique identifier of the balance limit.

Responses

Request samples

Content type
application/json
{
  • "balance_limit_id": "d089a80f-e641-4045-8a80-54841e4a7458"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "balance_limit_id": "d089a80f-e641-4045-8a80-54841e4a7458"
}

Return the cards related to the account

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Load account funds

Authorizations:
oauth
path Parameters
id
required
string
header Parameters
X-Nymos-Idempotency-Key
required
string <= 36 characters

Unique transaction id

Request Body schema: application/json
required
currency
required
string^[A-Z]{3}$

3-letter ISO_4217 code representing the currency.

amount
required
number <decimal>

Funds amount of the operation.

note
string

Additional description to the load account funds operation that is being performed can be added in this field.

dry_run
boolean
Default: false

This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false, and the default value is false.

reference_number
string

This parameter is searched against 'transaction_id'. This parameter is optional.

Responses

Request samples

Content type
application/json
{
  • "currency": "USD",
  • "amount": 123.45,
  • "note": "Performing operation for 123.45 USD",
  • "dry_run": false,
  • "reference_number": "3e50d5f7-6c18-4768-81c5-e4bc31f209db"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "transaction_id": "123456789012",
  • "account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "request": {
    },
  • "result": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "source_channel": "DAPI"
}

Unload account funds

Authorizations:
oauth
path Parameters
id
required
string
header Parameters
X-Nymos-Idempotency-Key
required
string <= 36 characters

Unique transaction id

Request Body schema: application/json
required
currency
required
string^[A-Z]{3}$

3-letter ISO_4217 code representing the currency.

amount
required
number <decimal>

Funds amount of the operation.

note
string

Additional description to the load account funds operation that is being performed can be added in this field.

dry_run
boolean
Default: false

This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false, and the default value is false.

reference_number
string

This parameter is searched against 'transaction_id'. This parameter is optional.

Responses

Request samples

Content type
application/json
{
  • "currency": "USD",
  • "amount": 123.45,
  • "note": "Performing operation for 123.45 USD",
  • "dry_run": false,
  • "reference_number": "3e50d5f7-6c18-4768-81c5-e4bc31f209db"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "transaction_id": "123456789012",
  • "account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "request": {
    },
  • "result": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "source_channel": "DAPI"
}

proxy-admins

API for managing User and their related information

Change User status

Authorizations:
oauth
path Parameters
user_id
required
string
Request Body schema: application/json
required
status
required
string (UserStatus)
Enum: "PENDINGKYC" "PENDINGKYB" "ACTIVE" "SUSPENDED" "TERMINATED" "PENDINGIDVERIFICATION"

The status of the user.

status_reason_code
required
string (UserStatusReasonCode)
Enum: "I0" "A0" "A1" "A2" "A3" "A4" "A5" "A6" "A7" "A8" "B0" "B0I" "B1" "B1I" "B2" "B3" "B4" "B5" "B6" "B7" "B8" "B9" "B10" "B11" "B1E" "B2E" "B0E" "B9E" "B10E" "B11E" "B12" "B19" "S0" "S1" "S2" "S3" "S4" "S5" "S6" "S7" "S8" "S9" "T0" "T1" "T2" "T3" "T4" "T5" "T6" "T7" "T8" "T9" "T10" "T11" "T12" "T13" "T12E" "T13E" "T14" "O1"

Status Change Reason Code:

  • I0: Initial status.
  • A0: First time activation: when activated from PENDINGKYC to ACTIVE status.
  • A1: Resumed from Suspended status: when user is moved back to ACTIVE status.
  • A2: Admin Activated the user from status suspended.
  • A3: Admin activated the user by manual intervention from the dashboard.
  • A4: Admin Activated the business user from status suspended.
  • A5: Admin Activated.
  • A6: Document expired or about to expire.
  • A7: ID renewed.
  • A8: ID re-verification failed after document expiration.
  • B0: Documents are uploaded successfully for identity verification.
  • B0I: Documents are uploaded successfully, but user profile is not complete.
  • B1: Identity is not verified, manual intervention required.
  • B1I: Documents are verified, manual intervention required.
  • B2: SDK token is no longer valid, please generate a new SDK token.
  • B3: Admin approved, proceed to KYC verification flow.
  • B4: Name mismatched.
  • B5: Identity verification consider with caution status and name mismatched.
  • B6: Identity verification consider.
  • B7: Date of birth consider.
  • B8: Documents are uploaded successfully for identity verification (where provider is not Onfido).
  • B9: Document issuing country mismatch.
  • B10: Identity verification consider with caution status and document issuing country mismatch.
  • B11: Documents are uploaded successfully for identity verification (multiple providers).
  • B1E: Identity is not verified, manual intervention required in Re-Uploading Case.
  • B2E: Generate SDK token, document expired (same as B2).
  • B0E: Documents re-uploaded after document expiration for identity verification (same as B0).
  • B9E: Document issuing country mismatch upon IDV re-verification after document expiration.
  • B10E: Identity verification consider with caution status and document issuing country mismatch upon IDV re-verification after document expiration.
  • B11E: Documents re-uploaded after document expiration for identity verification (Onfido) - same as B0E (multiple providers configured).
  • B12: Resubmission of document (configured provider is not Onfido).
  • B19: Allowed number of users per National ID/Passport limit is exceeded.
  • S0: Temporary suspension: initiated by the user or system user or the system.
  • S1: Inactivity over time.
  • S2: Suspended by Admin.
  • S3: Suspended by Admin.
  • S4: Suspended by Admin.
  • S5: Suspended by Admin.
  • S6: Suspended by Admin.
  • S7: IDV not renewed and document expiration grace period reached.
  • S8: Allowed number of users per National ID/Passport limit is exceeded.
  • S9: Suspended by Host.
  • T0: Closed by user.
  • T1: Closed by issuer.
  • T2: Failed KYC.
  • T3: Terminated by Admin.
  • T4: Terminated by Admin.
  • T5: Admin terminated due to ID verification failed.
  • T6: Admin terminated due to KYC failed.
  • T7: Admin terminated due to limited time exceeded and action taken for ID verification fail.
  • T8: Terminated by Admin.
  • T9: Admin terminated due to ID verification failed.
  • T10: Admin terminated due to limited time exceeded and action taken for KYB fail.
  • T11: Admin terminated due to certain reason.
  • T12: System terminated due to ID verification rejected.
  • T13: System terminated due to ID verification suspected.
  • T12E: System terminated due to ID verification rejected after document expiration for identity verification (same as T12).
  • T13E: System terminated due to ID verification suspected after document expiration for identity verification (same as T13).
  • T14: Allowed number of users per National ID/Passport limit is exceeded.
  • O1: Other reason.
note
string

This field is to capture additional information while changing the user status.

modified_by
string
Default: "API"

This field indicates the user who executed the operation.

Responses

Request samples

Content type
application/json
{
  • "status": "PENDINGKYC",
  • "status_reason_code": "I0",
  • "note": "Some note regarding the reason of user status change.",
  • "modified_by": "API"
}

Response samples

Content type
application/json;charset=UTF-8
{ }

Get count of customer, accounts and cards

Authorizations:
oauth
query Parameters
duration
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

Get count of customer, accounts and cards

Authorizations:
oauth
query Parameters
duration
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

proxy-allowedlists

Returns list of allowedCountries

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Get allowed countries by id

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name": "Country list 1",
  • "allow": true,
  • "active": true,
  • "country_codes": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z"
}

Create a new allowed mcc list

Authorizations:
oauth
Request Body schema: application/json
required
id
string <= 36 characters

The unique identifier of the allowed MCCs list.

name
required
string [ 1 .. 50 ] characters

The MCC list name.

active
boolean

If this parameter is set as 'true', then the MCC list must be checked. If it is set as 'false', then the MCC list must not be checked. Default value is 'true'.

required
Array of objects (MccInfo)

The MCC information.

Responses

Request samples

Content type
application/json
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name": "MCC List 01",
  • "active": true,
  • "mccs": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name": "MCC List 01",
  • "active": true,
  • "mccs": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z"
}

Returns list of allowedMccs

Authorizations:
oauth
query Parameters
name
string

If included then allowed mccs will be filtered by Name

mcc_id
string

If included then allowed mccs will be filtered by MCC Id

limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Get a new allowed mcc by id

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name": "MCC List 01",
  • "active": true,
  • "mccs": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z"
}

Update a new allowed mcc by id

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$
Request Body schema: application/json
required
active
boolean

If this parameter is set as 'true', then the MCC list must be checked. If it is set as 'false', then the MCC list must not be checked. Default value is 'true'.

Array of objects (MccInfo)

The MCC information.

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "mccs": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name": "MCC List 01",
  • "active": true,
  • "mccs": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z"
}

proxy-card-products

createCardProduct

Authorizations:
oauth
Request Body schema: application/json
required
id
string <= 36 characters ^[a-zA-Z\-0-9]+$

The unique identifier of the card product. If this information is not present in the request, the system generates one automatically.

description
required
string <= 40 characters

The name of the card product. We recommend using a unique string.

product_category
string <= 40 characters

Category of the Card Product

status
string (CardProductStatusCreate)
Enum: "INACTIVE" "ACTIVE"

This is the card product status. When card product is created, it has status 'INACTIVE'. Once a card is issued for the card product, the status will become 'ACTIVE'.

required
Array of objects (CurrencySettings) non-empty

An array of currency settings to define the related characteristics such as supported currencies, settlement currencies, priority, currency status, etc. for the card product.

required
object (CardSettings)

An array of card settings to define the related characteristics such as bin, pan length, pan range, card validity code, etc. for the card product.

object (CardProductCreditLimits)
object (AccountSettings)

An array of account settings to define the related characteristics such as link account to card, number of cards per account etc. for the card product.

object (PinSettings)

An array of PIN settings to define the related characteristics such as PIN type, PIN length, and PIN retries for the card product.

object (AuthSettings)

An array of authorization settings to define the related characteristics such as transaction controlling (enabling/disabling), authorization aging, etc. for the card product. Note that auth settings cannot be updated for an ACTIVE card product.

object (CardProductCreditSettings)

Card product credit settings.

pan_format_token
string <= 36 characters

Identifier for the Pan Format Token. If not provided then default PAN format will be used.

track_format_token
string <= 36 characters

Identifier for the Track Format. If not provided then default Track format will be used.

proxy_format_token
string <= 36 characters

Identifier for Proxy format

type
string (CardProductType)
Enum: "PREPAID" "CREDIT"

Card product type.

sub_type
string (CardProductSubType)
Enum: "SECURE" "REVOLVING"

Card product sub-type.

is_multi_currency_product
boolean
Default: false

Indicates whether the product is single currency or multi currency supported.

object (WalletSettings)

Wallet settings. If 'is_multi_currency_product' = true, then it becomes mandatory.

Array of objects (FxRatesSettings)

An array of FX rates settings.

Responses

Request samples

Content type
application/json
{
  • "id": "cardproduct1",
  • "description": "Some description of the cardproduct1",
  • "product_category": "string",
  • "status": "INACTIVE",
  • "currency_settings": [
    ],
  • "card_settings": {
    },
  • "credit_limits": {
    },
  • "account_settings": {
    },
  • "pin_settings": {
    },
  • "auth_settings": {
    },
  • "credit_settings": {
    },
  • "pan_format_token": "default_pan_format",
  • "track_format_token": "default_track_format",
  • "proxy_format_token": "default_proxy_format",
  • "type": "PREPAID",
  • "sub_type": "SECURE",
  • "is_multi_currency_product": true,
  • "wallet_settings": {
    },
  • "fxrates_settings": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the card product",
  • "product_category": "string",
  • "status": "INACTIVE",
  • "currency_settings": [
    ],
  • "card_settings": {
    },
  • "credit_settings": {
    },
  • "account_settings": {
    },
  • "pin_settings": {
    },
  • "auth_settings": {
    },
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "pan_format_token": "default_pan_format",
  • "track_format_token": "default_track_format",
  • "proxy_format_token": "default_proxy_format",
  • "type": "PREPAID",
  • "sub_type": "SECURE",
  • "is_multi_currency_product": true,
  • "wallet_settings": {
    },
  • "fxrates_settings": [
    ]
}

List all card products

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Get a Card Product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the card product",
  • "product_category": "string",
  • "status": "INACTIVE",
  • "currency_settings": [
    ],
  • "card_settings": {
    },
  • "credit_settings": {
    },
  • "account_settings": {
    },
  • "pin_settings": {
    },
  • "auth_settings": {
    },
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "pan_format_token": "default_pan_format",
  • "track_format_token": "default_track_format",
  • "proxy_format_token": "default_proxy_format",
  • "type": "PREPAID",
  • "sub_type": "SECURE",
  • "is_multi_currency_product": true,
  • "wallet_settings": {
    },
  • "fxrates_settings": [
    ]
}

Update a Card Product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Request Body schema: application/json
required
description
string

The name of the card product. We recommend using a unique string.

status
string (CardProductStatus)
Enum: "INACTIVE" "ACTIVE" "TERMINATED"

This is the card product status. When card product is created, it has status 'INACTIVE'. Once a card is issued for the card product, the status will become 'ACTIVE'.

Array of objects (CurrencySettings)

An array of currency settings to define the related characteristics such as supported currencies, settlement currencies, priority, currency status, etc. for the card product. Already added currencies cannot be deleted but can be marked as inactive. When product status is active then currency fields can't be modified for currency with priority = 1.

product_category
string <= 40 characters

Category of the Card Product

object (CardSettingsUpdateRequest)

An array of card settings to define the related characteristics such as bin, pan length, pan range, card validity code, etc. for the card product.

object (AccountSettings)

An array of account settings to define the related characteristics such as link account to card, number of cards per account etc. for the card product.

object (PinSettings)

An array of PIN settings to define the related characteristics such as PIN type, PIN length, and PIN retries for the card product.

object (AuthSettings)

An array of authorization settings to define the related characteristics such as transaction controlling (enabling/disabling), authorization aging, etc. for the card product. Note that auth settings cannot be updated for an ACTIVE card product.

object (CardProductCreditSettings)

Card product credit settings.

pan_format_token
string <= 36 characters

Identifier for the Pan Format Token. If not provided then default PAN format will be used.

track_format_token
string <= 36 characters

Identifier for the Track Format. If not provided then default Track format will be used.

proxy_format_token
string <= 36 characters

Identifier for Proxy format

type
string (CardProductType)
Enum: "PREPAID" "CREDIT"

Card product type.

is_multi_currency_product
boolean

Indicates whether the product is single currency or multi currency supported.

object (WalletSettings)

Wallet settings. If 'is_multi_currency_product' = true, then it becomes mandatory.

Array of objects (FxRatesSettings)

An array of FX rates settings.

Responses

Request samples

Content type
application/json
{
  • "description": "Some description of the card product",
  • "status": "INACTIVE",
  • "currency_settings": [
    ],
  • "product_category": "string",
  • "card_settings": {
    },
  • "account_settings": {
    },
  • "pin_settings": {
    },
  • "auth_settings": {
    },
  • "credit_settings": {
    },
  • "pan_format_token": "default_pan_format",
  • "track_format_token": "default_track_format",
  • "proxy_format_token": "default_proxy_format",
  • "type": "PREPAID",
  • "is_multi_currency_product": true,
  • "wallet_settings": {
    },
  • "fxrates_settings": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the card product",
  • "product_category": "string",
  • "status": "INACTIVE",
  • "currency_settings": [
    ],
  • "card_settings": {
    },
  • "credit_settings": {
    },
  • "account_settings": {
    },
  • "pin_settings": {
    },
  • "auth_settings": {
    },
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "pan_format_token": "default_pan_format",
  • "track_format_token": "default_track_format",
  • "proxy_format_token": "default_proxy_format",
  • "type": "PREPAID",
  • "sub_type": "SECURE",
  • "is_multi_currency_product": true,
  • "wallet_settings": {
    },
  • "fxrates_settings": [
    ]
}

Get a list of Velocity Limits related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Link a Velocity Limits related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Request Body schema: application/json
required

The Velocity Limit ID list to be linked with Card Product

ids
Array of strings

An array of IDs.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Unlink a Velocity Limits related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Request Body schema: application/json
required

The Velocity Limit ID list to be unlinked with Card Product

ids
Array of strings

An array of IDs.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Link Advanced Velocity Limits related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Request Body schema: application/json
required

The Advanced Velocity Limit ID list to be linked with Card Product

ids
Array of strings

An array of IDs.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Unlink Advanced Velocity Limits related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Request Body schema: application/json
required

The Velocity Limit ID list to be unlinked with Card Product

ids
Array of strings

An array of IDs.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Get a list of Balance Limits related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Link a Balance Limits related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Request Body schema: application/json
required

The Balance Limit ID list to be linked with Card Product

ids
Array of strings

An array of IDs.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Unlink a Balance Limit related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Request Body schema: application/json
required

The Balance Limit ID list to be unlinked with Card Product

ids
Array of strings

An array of IDs.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Get a list of Fees related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Link a Fees related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Request Body schema: application/json
required

The Fee ID list to be linked with Card Product

ids
Array of strings

An array of IDs.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Unlink a Fee related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Request Body schema: application/json
required

The Fee ID list to be unlinked with Card Product

ids
Array of strings

An array of IDs.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Upload card design image for product

Authorizations:
oauth
path Parameters
product_id
required
string

The Card Product ID

Request Body schema: multipart/form-data
required
file
required
string <binary>

Image file to be uploaded.

is_default
required
boolean

Is design default

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

Get card design file

Authorizations:
oauth
path Parameters
product_id
required
string

The Card Product ID

design_id
required
string

The design image ID

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "FileUploadContent",
  • "user_id": "user120",
  • "metadata": {
    },
  • "content": "2rl0Dvc1gTrOTTqzgNaK62wj9tT91kEZRjUGF2kWWeBN4BGy7xYdAR7Mc6duajDBLQ_y8pBKeXaxRPUXIcK5K734Z7rmtAYIzMam2RClvKcU"
}

Update card design image for product

Authorizations:
oauth
path Parameters
product_id
required
string

The Card Product ID

design_id
required
string

The design image ID

Request Body schema: multipart/form-data
required
file
required
string <binary>

Image file to be uploaded.

is_default
required
boolean

Is design default

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

Get card designs metadata for product

Authorizations:
oauth
path Parameters
product_id
required
string

The Card Product ID

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

Get APR profiles for the given card product id, optionally for specific AprName

Authorizations:
oauth
path Parameters
product_id
required
string
query Parameters
apr_name
string

optionally return only apr profiles for specific AprName, like PURCHASE_APR or CASHADVANCE_APR

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "apr_profiles": [
    ],
  • "apr_profiles_with_errors": [
    ]
}

Create one or more APR profiles for the given card product id

Authorizations:
oauth
path Parameters
product_id
required
string
Request Body schema: application/json
required

list of apr profiles to create under the card product

Array
id
string <= 36 characters

Unique ID for APR profile.

profile_name
required
string

Name of the profile.

apr_name
required
string (AprName)
Enum: "PURCHASE_APR" "CASHADVANCE_APR"

The APR name for which the APR profile is being created.

fc_method_name
required
string (AprFcMethodName)
Value: "AVERAGE_DAILY_BALANCE"

Interest calculation method to be used for the APR profile.

apr_type
string (AprType)
Default: "FIXED"
Value: "FIXED"

The type of APR.

apr_value
required
number >= 0

The APR value intended for use with a specific APR ID.

effective_from
required
string (AprEffectiveFrom)
Value: "SPECIFIC_DATE"

Indicate from when this APR should be applied.

effective_date
string <date>

The date when new APR will become applicable. If the effective date is not provided, the system will automatically insert today’s date.

applicable_on
string (AprApplicableOn)
Default: "OVERALL_BALANCE"
Value: "OVERALL_BALANCE"

Indicate the balance on which this APR should be applied.

interest_trigger_date
required
string (AprInterestTriggerDate)
Enum: "DUE_DATE" "TRANSACTION_DATE"

The date from which the interest should be charged.

apply_daily_compounding
boolean

This field indicates if previous daily interest is compounded in the current day's APR calculation.

apply_monthly_compounding
boolean

If true, then system will consider FC balance bucket as part of overall purchase balance when computing interest for the billing period. Only applicable for PURCHASE_APR.

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json;charset=UTF-8
{
  • "apr_profiles": [
    ],
  • "apr_profiles_with_errors": [
    ]
}

Get the APR profile with the provided id, for the given card product

Authorizations:
oauth
path Parameters
product_id
required
string
profile_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "profile_name": "profile1",
  • "apr_name": "PURCHASE_APR",
  • "fc_method_name": "AVERAGE_DAILY_BALANCE",
  • "apr_type": "FIXED",
  • "apr_value": 0,
  • "effective_from": "SPECIFIC_DATE",
  • "effective_date": "2022-05-04T19:42:32.987Z",
  • "applicable_on": "OVERALL_BALANCE",
  • "interest_trigger_date": "DUE_DATE",
  • "apply_daily_compounding": false,
  • "apply_monthly_compounding": false
}

Get a list of Charges related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Link a Charges related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Request Body schema: application/json
required

The Fee ID list to be linked with Card Product

ids
Array of strings[ items <= 36 characters ]

An array of IDs.

Responses

Request samples

Content type
application/json
{
  • "ids": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6"
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Unlink a Charges related to the card product

Authorizations:
oauth
path Parameters
id
required
string

The Card Product ID

Request Body schema: application/json
required

The Fee ID list to be unlinked with Card Product

ids
Array of strings[ items <= 36 characters ]

An array of IDs.

Responses

Request samples

Content type
application/json
{
  • "ids": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6"
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

proxy-cards

Get cards

Authorizations:
oauth
query Parameters
user_id
string

If included then cards will be filtered by user ID

bulk_issuance_id
string

If included then cards will be filtered by bulk issuance ID

proxy_number
string

If included then cards will be filtered by Proxy Number

bin
string

If included then cards will be filtered by Bin

last_four
string

If included then cards will be filtered by Last four

limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "MjAxOC0wMS0wMlQxOTo0MjozMi45ODda",
  • "has_more": true,
  • "data": [
    ]
}

Create a new card

Authorizations:
oauth
header Parameters
x-nymos-idempotency-key
required
string <= 36 characters
Request Body schema: application/json
required
id
string <= 36 characters

The unique identifier of the card. If you do not include a token, the system generates one automatically. This token is necessary for use in other API calls and this value cannot be updated.

user_id
required
string <= 36 characters

Token identifier of the user who owns this card.

card_type
required
string (CardType)
Enum: "PHYSICAL" "VIRTUAL"

Supported card types

card_product_id
required
string

The unique identifier of the card product. This token id is referred to as an existing card product. The card creating with this card product token will inherit all of its characteristics.

reference_card_id
string <= 36 characters

Token identifier of the card to refer to when creating a card linked to an existing account.

bulk_issuance_id
string <= 36 characters

Token identifier of the bulk issuance request to which this card belongs to.

name_on_card
string <= 20 characters

Name to print on the card and track data. If this field finds empty in the request, then the name of the user profile will be printed on the card.

object (CardShippingDetails)

Details of card shipping destination.

dry_run
boolean

This field value decides whether to create a resource or not after performing all necessary operations. Applicable values for this field are true/false and the default value is false.

card_validity_term
integer <int32> [ 1 .. 99 ]

This is the term (in months) for which a newly created card will be valid for. Used to set the expiry date for the card. The expiry date shall be calculated from the date of card creation till the number of months given by this parameter. This field is optional; if it is empty, then card_validity_term from card_product shall be used. Card validity term of the card can not be greater than that of the card product.

extra_embossing_line
string <= 20 characters ^[a-zA-Z0-9\s]+$

Extra embossing line.

object (CreditSettingsRequest)

The exposed revolving credit settings.

object (CreditLimitsRequest)

the exposed revolving credit limits in the create-card/update-card API

delivery_charge_id
string <= 36 characters

Identifier of the delivery charge.

Responses

Request samples

Content type
application/json
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "card_type": "PHYSICAL",
  • "card_product_id": "aabc9d-996azam799-9ac99879b9a9bC99",
  • "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name_on_card": "John Smith",
  • "shipping_details": {
    },
  • "dry_run": false,
  • "card_validity_term": 36,
  • "extra_embossing_line": "CLASSIC",
  • "credit_settings": {
    },
  • "credit_limits": {
    },
  • "delivery_charge_id": "d089a80f-e641-4045-7880-54841e4a7458"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "card_type": "PHYSICAL",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name_on_card": "John Smith",
  • "card_product_name": "string",
  • "shipping_details": {
    },
  • "status": "INACTIVE",
  • "status_reason": "I0",
  • "fulfillment_status": "CREATED",
  • "bin": "123456",
  • "last_four": "5789",
  • "expiry_date": "01/2025",
  • "pin_retries": 0,
  • "proxy_number": "0000367466",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "modified_by": "API",
  • "extra_embossing_line": "CLASSIC",
  • "card_soft_expiry": "01/2025",
  • "auth_settings": {
    },
  • "is_account_linked": true,
  • "delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
  • "change_to_physical": true,
  • "balances": {
    }
}

Get card data

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "card_type": "PHYSICAL",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name_on_card": "John Smith",
  • "card_product_name": "string",
  • "shipping_details": {
    },
  • "status": "INACTIVE",
  • "status_reason": "I0",
  • "fulfillment_status": "CREATED",
  • "bin": "123456",
  • "last_four": "5789",
  • "expiry_date": "01/2025",
  • "pin_retries": 0,
  • "proxy_number": "0000367466",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "modified_by": "API",
  • "extra_embossing_line": "CLASSIC",
  • "card_soft_expiry": "01/2025",
  • "auth_settings": {
    },
  • "is_account_linked": true,
  • "delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
  • "change_to_physical": true,
  • "balances": {
    }
}

Update a card

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$
Request Body schema: application/json
required
bulk_issuance_id
string <= 36 characters

Token identifier of the bulk issuance request to which this card belongs to.

name_on_card
string <= 20 characters

Name to print on the card and track data. If this field finds empty in the request, then the name of the user profile will be printed on the card.

object (CardShippingDetails)

Details of card shipping destination.

extra_embossing_line
string <= 20 characters ^[a-zA-Z0-9\s]+$

Extra embossing line.

change_to_physical
boolean
object (CreditSettingsRequest)

The exposed revolving credit settings.

object (CreditLimitsRequest)

the exposed revolving credit limits in the create-card/update-card API

Responses

Request samples

Content type
application/json
{
  • "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name_on_card": "John Smith",
  • "shipping_details": {
    },
  • "extra_embossing_line": "CLASSIC",
  • "change_to_physical": true,
  • "credit_settings": {
    },
  • "credit_limits": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "card_type": "PHYSICAL",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name_on_card": "John Smith",
  • "card_product_name": "string",
  • "shipping_details": {
    },
  • "status": "INACTIVE",
  • "status_reason": "I0",
  • "fulfillment_status": "CREATED",
  • "bin": "123456",
  • "last_four": "5789",
  • "expiry_date": "01/2025",
  • "pin_retries": 0,
  • "proxy_number": "0000367466",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "modified_by": "API",
  • "extra_embossing_line": "CLASSIC",
  • "card_soft_expiry": "01/2025",
  • "auth_settings": {
    },
  • "is_account_linked": true,
  • "delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
  • "change_to_physical": true,
  • "balances": {
    }
}

changeCardStatus

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$
Request Body schema: application/json
required
status
required
string (CardStatus)
Enum: "INACTIVE" "ACTIVE" "SUSPENDED" "TERMINATED"

The status of a card.

status_reason_code
required
string (StatusChangeReason)
Enum: "A0" "A1" "A3" "AT" "I1" "S0" "S1" "S3" "S4" "S5" "S6" "S7" "ST" "T0" "T1" "T2" "T3" "T4" "T5" "T6" "T7" "T8" "T9" "T10" "T11" "T12" "T13" "T14" "T15" "T16" "T17" "T18"

Status Change Reason Code:

  • A0: First time activation: when activated from Inactive to Active status
  • A1: Resumed from Suspended status: when card is moved back to Active status
  • A3: Activated by admin
  • I1: Updated soft expiry of SUSPENDED(S2) card
  • S0: Temporary suspension: initiated by the user or system user or the system
  • S1: PIN retries exhausted: when bad PIN retries are exhausted
  • S3: Admin rejected due to ID verification failed
  • S4: Admin suspended due to fraudulent activity
  • S5: Admin rejected due to ID verification failed
  • S6: Admin suspended due to certain reason
  • S7: Admin suspended due to being delinquent for a certain amount of time
  • T0: Card Lost
  • T1: Card Stolen
  • T2: Card Expired
  • T3: Card Damaged
  • T4: Closed by user
  • T5: Closed by issuer
  • T6: Closed by issuer after renewal
  • S7: Admin suspended due to being delinquent for a certain amount of time
  • T7: Admin terminated due to limited time exceeded and action taken for ID verification fail
  • T8: Admin terminated due to KYC OGS response
  • T9: Admin terminated due to ID verification failed
  • T10: Admin terminated due to limited time exceeded and action taken for KYB fail
  • T11: Admin terminated due to certain reason
  • T12: System terminated due to ID verification rejected
  • T13: System terminated due to ID verification suspected
  • T14: Failed KYC
  • T15: Fraudulent activity was identified
  • T16: Matched with an Office of Foreign Assets Control list
  • T17: Admin terminated due to ID verification failed
  • T18: Admin terminated due to KYC failed
object (CoreNote)

This field is to capture additional information by the user while changing the card status. E.g. how the card got stolen, what is the reason behind a damage, etc.

modified_by
string <= 50 characters
Default: "API"

This field indicates the user who executed the operation.

Responses

Request samples

Content type
application/json
{
  • "status": "INACTIVE",
  • "status_reason_code": "A0",
  • "note": {
    },
  • "modified_by": "API"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "user_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "card_type": "PHYSICAL",
  • "card_product_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "reference_card_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "bulk_issuance_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "name_on_card": "John Smith",
  • "card_product_name": "string",
  • "shipping_details": {
    },
  • "status": "INACTIVE",
  • "status_reason": "I0",
  • "fulfillment_status": "CREATED",
  • "bin": "123456",
  • "last_four": "5789",
  • "expiry_date": "01/2025",
  • "pin_retries": 0,
  • "proxy_number": "0000367466",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "modified_by": "API",
  • "extra_embossing_line": "CLASSIC",
  • "card_soft_expiry": "01/2025",
  • "auth_settings": {
    },
  • "is_account_linked": true,
  • "delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
  • "change_to_physical": true,
  • "balances": {
    }
}

getCardAccounts

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

List all the cards that are eligible for renewal

Authorizations:
oauth
query Parameters
product_id
required
string

product ID is using to retrieve the renewal configuration

start_date
string <date-time>
end_date
string <date-time>

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "MjAxOC0wMS0wMlQxOTo0MjozMi45ODda",
  • "has_more": true,
  • "data": [
    ]
}

Mark cards for renewal

Authorizations:
oauth
Request Body schema: application/json
required
object (MarkCardsForRenewalRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json;charset=UTF-8
{ }

Fetch all limits associated with card

Authorizations:
oauth
path Parameters
id
required
string
query Parameters
type
string
Enum: "ADVANCED_VELOCITY_LIMIT" "VELOCITY_LIMITS" "BALANCE_LIMITS"
Example: type=VELOCITY_LIMITS

The type of limit.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "user_id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "velocity_limits": [
    ],
  • "balance_limits": [
    ],
  • "advanced_velocity_limits": [
    ]
}

getAllCardLimits

Authorizations:
oauth
path Parameters
id
required
string
query Parameters
type
string
Enum: "ADVANCED_VELOCITY_LIMIT" "VELOCITY_LIMITS" "BALANCE_LIMITS"
Example: type=VELOCITY_LIMITS

The type of limit.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "user_id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "velocity_limits": [
    ],
  • "balance_limits": [
    ],
  • "advanced_velocity_limits": [
    ]
}

Get card authsettings data

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "allow_atm": true,
  • "allow_pos": true,
  • "allow_chip": true,
  • "allow_magstripe": true,
  • "allow_chip_fallback": true,
  • "allow_without_pin": true,
  • "allow_ecommerce_non_3DS": true,
  • "allow_ecommerce_3DS": true,
  • "allow_ecommerce_without_CVV": true,
  • "allow_account_verification_without_CVV": true,
  • "allow_quasi_cash": true,
  • "allow_scheme_account_funding": true,
  • "allow_scheme_credits": true,
  • "allow_contactless": true,
  • "allowed_mccs_id": "a8180db3-b2e9-4ae0-93cd-2a0b52a99737",
  • "allowed_countries_id": "8358c501-56a3-43b0-b2b3-a2c49f3c33ab"
}

upsert the authsettings

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
object (AuthSettingsUpsertModel)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json;charset=UTF-8
{
  • "allow_atm": true,
  • "allow_pos": true,
  • "allow_chip": true,
  • "allow_magstripe": true,
  • "allow_chip_fallback": true,
  • "allow_without_pin": true,
  • "allow_ecommerce_non_3DS": true,
  • "allow_ecommerce_3DS": true,
  • "allow_ecommerce_without_CVV": true,
  • "allow_account_verification_without_CVV": true,
  • "allow_quasi_cash": true,
  • "allow_scheme_account_funding": true,
  • "allow_scheme_credits": true,
  • "allow_contactless": true,
  • "allowed_mccs_id": "a8180db3-b2e9-4ae0-93cd-2a0b52a99737",
  • "allowed_countries_id": "8358c501-56a3-43b0-b2b3-a2c49f3c33ab"
}

Sets velocity limits for a card.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$
Request Body schema: application/json
required
ids
Array of strings

An array of data.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Removes velocity limits for a card.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$
Request Body schema: application/json
required
ids
Array of strings

An array of data.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Sets advanced velocity limits for a card.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$
Request Body schema: application/json
required
ids
Array of strings

An array of data.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

Removes velocity limits for a card.

Authorizations:
oauth
path Parameters
id
required
string^[a-zA-Z\-0-9]+$
Request Body schema: application/json
required
ids
Array of strings

An array of data.

Responses

Request samples

Content type
application/json
{
  • "ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
[
  • "string"
]

proxy-charges

API for managing User and their related information

listCharges

Authorizations:
oauth
query Parameters
charge_type
string
ids
string
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "has_more": true,
  • "after": "string",
  • "data": [
    ]
}

createCharges

Authorizations:
oauth
Request Body schema: application/json
required
id
string <= 36 characters

The unique identifier of the charge.

description
required
string <= 50 characters

Description of the charge.

type
required
string (Type)
Enum: "FLAT" "PERCENTAGE" "MAX_PERC_OR_FLAT" "MIN_PERC_OR_FLAT"

The charge type.

currency
required
string^[A-Z]{3}$

The charge currency.

amount
number >= 0

The charge amount.

percentage
number [ 0 .. 100 ]

Percentage of the charge.

frequency_period
number >= 0
Default: 1

Charges frequency period.

on_first
boolean
Default: false

This parameter indicates whether charge is applicable on first month or year. It is applicable for frequency "MONTHLY" and "YEARLY".

active
boolean

The charge status.

charge_type
required
string (ChargesType)
Enum: "PHYSICAL_CARD_ISSUANCE" "VIRTUAL_CARD_ISSUANCE" "PHYSICAL_CARD_REPLACEMENT" "VIRTUAL_CARD_REPLACEMENT" "MAINTENANCE" "CHANGE_PIN" "LATE_PAYMENT" "DELIVERY" "FINANCIAL_CHARGES" "CARD_ACTIVATION_CHARGES" "DIGITAL_CARD_ISSUANCE"

The type of charge operation.

frequency
string (ChargesFrequency)
Enum: "DAYS" "MONTHLY" "YEARLY"

Frequency of charging.

application_type
string (ChargesApplicationType)
Default: "SCHEDULED"
Enum: "INSTANT" "SCHEDULED"

Charges application type. If "application_type" is "INSTANT", "account_type" should be "MASTER".

account_type
string (ChargesAccountType)
Enum: "PREPAID" "MASTER"

Charges account type.

allow_overdraft
boolean
Default: false

This field indicates whether overdraft is allowed or not. The default value is 'false'.

wallet_provider
string (ChargesWalletProvider)
Enum: "GOOGLE" "APPLE" "SAMSUNG" "ANY"

Charges wallet provider.

channel
string (ChargesChannel)
Enum: "VISA" "MASTERCARD"

Charges channel.

Responses

Request samples

Content type
application/json
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "description": "Withdrawal charges",
  • "type": "FLAT",
  • "currency": "USD",
  • "amount": 2,
  • "percentage": 15,
  • "frequency_period": 5,
  • "on_first": true,
  • "active": true,
  • "charge_type": "PHYSICAL_CARD_ISSUANCE",
  • "frequency": "MONTHLY",
  • "application_type": "INSTANT",
  • "account_type": "PREPAID",
  • "allow_overdraft": false,
  • "wallet_provider": "GOOGLE",
  • "channel": "VISA"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "description": "Withdrawal charges",
  • "type": "FLAT",
  • "currency": "USD",
  • "amount": 2,
  • "percentage": 15,
  • "frequency_period": 5,
  • "on_first": true,
  • "active": true,
  • "charge_type": "PHYSICAL_CARD_ISSUANCE",
  • "frequency": "MONTHLY",
  • "application_type": "INSTANT",
  • "account_type": "PREPAID",
  • "allow_overdraft": false,
  • "wallet_provider": "GOOGLE",
  • "channel": "VISA",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z"
}

getCharges

Authorizations:
oauth
path Parameters
charges_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "description": "Withdrawal charges",
  • "type": "FLAT",
  • "currency": "USD",
  • "amount": 2,
  • "percentage": 15,
  • "frequency_period": 5,
  • "on_first": true,
  • "active": true,
  • "charge_type": "PHYSICAL_CARD_ISSUANCE",
  • "frequency": "MONTHLY",
  • "application_type": "INSTANT",
  • "account_type": "PREPAID",
  • "allow_overdraft": false,
  • "wallet_provider": "GOOGLE",
  • "channel": "VISA",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z"
}

updateCharges

Authorizations:
oauth
path Parameters
charges_id
required
string
Request Body schema: application/json
required
description
string <= 50 characters

Description of the charge.

type
string (Type)
Enum: "FLAT" "PERCENTAGE" "MAX_PERC_OR_FLAT" "MIN_PERC_OR_FLAT"

The charge type.

currency
string^[A-Z]{3}$

The charge currency.

amount
number >= 0

The charge amount.

percentage
number [ 0 .. 100 ]

Percentage of the charge.

frequency_period
number >= 0
Default: 1

Charges frequency period.

on_first
boolean
Default: false

This parameter indicates whether charge is applicable on first month or year. It is applicable for frequency "MONTHLY" and "YEARLY".

active
boolean

The charge status.

charge_type
string (ChargesType)
Enum: "PHYSICAL_CARD_ISSUANCE" "VIRTUAL_CARD_ISSUANCE" "PHYSICAL_CARD_REPLACEMENT" "VIRTUAL_CARD_REPLACEMENT" "MAINTENANCE" "CHANGE_PIN" "LATE_PAYMENT" "DELIVERY" "FINANCIAL_CHARGES" "CARD_ACTIVATION_CHARGES" "DIGITAL_CARD_ISSUANCE"

The type of charge operation.

frequency
string (ChargesFrequency)
Enum: "DAYS" "MONTHLY" "YEARLY"

Frequency of charging.

application_type
string (ChargesApplicationType)
Default: "SCHEDULED"
Enum: "INSTANT" "SCHEDULED"

Charges application type. If "application_type" is "INSTANT", "account_type" should be "MASTER".

account_type
string (ChargesAccountType)
Enum: "PREPAID" "MASTER"

Charges account type.

allow_overdraft
boolean
Default: false

This field indicates whether overdraft is allowed or not. The default value is 'false'.

wallet_provider
string (ChargesWalletProvider)
Enum: "GOOGLE" "APPLE" "SAMSUNG" "ANY"

Charges wallet provider.

channel
string (ChargesChannel)
Enum: "VISA" "MASTERCARD"

Charges channel.

Responses

Request samples

Content type
application/json
{
  • "description": "Withdrawal charges",
  • "type": "FLAT",
  • "currency": "USD",
  • "amount": 2,
  • "percentage": 15,
  • "frequency_period": 5,
  • "on_first": true,
  • "active": true,
  • "charge_type": "PHYSICAL_CARD_ISSUANCE",
  • "frequency": "MONTHLY",
  • "application_type": "INSTANT",
  • "account_type": "PREPAID",
  • "allow_overdraft": false,
  • "wallet_provider": "GOOGLE",
  • "channel": "VISA"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "description": "Withdrawal charges",
  • "type": "FLAT",
  • "currency": "USD",
  • "amount": 2,
  • "percentage": 15,
  • "frequency_period": 5,
  • "on_first": true,
  • "active": true,
  • "charge_type": "PHYSICAL_CARD_ISSUANCE",
  • "frequency": "MONTHLY",
  • "application_type": "INSTANT",
  • "account_type": "PREPAID",
  • "allow_overdraft": false,
  • "wallet_provider": "GOOGLE",
  • "channel": "VISA",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z"
}

proxy-fees

listFees

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "has_more": true,
  • "after": "MjAxOC0wMS0wMlQxOTo0MjozMi45ODda",
  • "data": [
    ]
}

createFee

Authorizations:
oauth
Request Body schema: application/json
required
id
string <= 36 characters

The unique identifier of the fee. If this information is not present in the request, the system generates one automatically.

description
required
string <= 50 characters

The name of the fee. We recommend using a unique string.

type
required
string (FeeType)
Enum: "FLAT" "PERCENTAGE" "MAX_PERC_OR_FLAT" "MIN_PERC_OR_FLAT" "MAX_PERC_OR_FLAT_W_CAP" "MIN_PERC_OR_FLAT_W_CAP" "RANGE" "RANGE_FLAT" "RANGE_PERCENTAGE" "RANGE_MAX_PERC_OR_FLAT" "RANGE_MIN_PERC_OR_FLAT" "RANGE_MAX_PERC_OR_FLAT_W_CAP" "RANGE_MIN_PERC_OR_FLAT_W_CAP"

Fee types:

  • FLAT: A flat fee refers to a fixed amount a cardholder pays for performing a transaction regardless of a transaction amount.In case of single currency products, the currency of the flat fee is the one supported by the card product.
  • PERCENTAGE: A percentage fee applied on the transaction amount a cardholder pays for performing a transaction. The fee is calculated by applying the percentage to ISO field 6 billing amount coming in authorization from the payment scheme.
  • MAX_PERC_OR_FLAT: A maximum fee selects between an applied percentage fee and flat fee a cardholder pays for performing a transaction.
  • MIN_PERC_OR_FLAT: A minimum fee selects between an applied percentage fee and flat fee a cardholder pays for performing a transaction.
  • MAX_PERC_OR_FLAT_W_CAP: A maximum fee selects between an applied percentage fee and a flat fee. Note that the configured maximum cap limit fee will be applied if the selected fee is greater than the configured cap limit fee.
  • MIN_PERC_OR_FLAT_W_CAP: A minimum fee selects between an applied percentage fee and a flat fee. Note that the configured miminum cap limiy fee will be applied if the selected fee is lesser than the configured cap limit fee.
  • RANGE: Transaction amount based fee slabs where each slab has a configured flat fee or a percentage fee.
  • RANGE_FLAT: Transaction amount based fee slabs where each slab has a configured flat fee.
  • RANGE_PERCENTAGE: Transaction amount based fee slabs where each slab has a configured percentage fee.
  • RANGE_MAX_PERC_OR_FLAT: Transaction amount based fee slabs where each slab has a flat fee and a percentage fee configured and the the maximum fee between the two is applied.
  • RANGE_MIN_PERC_OR_FLAT: Transaction amount based fee slabs where each slab has a flat fee and a percentage fee configured and the the minimum fee between the two is applied.
  • RANGE_MAX_PERC_OR_FLAT_W_CAP: A maximum fee selects between an applied percentage fee and a flat fee based on transaction amount range. Note that the configured maximum cap limit fee will be applied if the selected fee is greater than the configured cap limit fee.
  • RANGE_MIN_PERC_OR_FLAT_W_CAP: A minimum fee selects between an applied percentage fee and a flat fee based on transaction amount range. Note that the configured minimum cap limit fee will be applied if the selected fee is lesser than the configured cap limit fee.
currency
required
string^([\*]{3}|[A-Z]{3})$

Currency code or ***. Value *** is only applicable for transaction types 'PURCHASE_FOREIGN_CURRENCY' and 'WITHDRAWAL_FOREIGN_CURRENCY'.

amount
number >= 0

Fee amount. It is applicable if fee type includes flat option.

percentage
number [ 0 .. 100 ]

Fee percentage. It is applicable if fee type includes percentage option.

Array of objects (Range)

Array of ranges where fee is applicable.

transaction_type
required
string (TransactionType)
Enum: "WITHDRAWALS" "PURCHASES" "BALANCE_INQUIRIES" "TRANSFERS" "LOADS" "UNLOADS" "PURCHASE_FOREIGN_CURRENCY" "WITHDRAWAL_FOREIGN_CURRENCY"

The type of transaction. 'PURCHASE_FOREIGN_CURRENCY' is only applicable to 'PURCHASES' in foreign currencies. 'WITHDRAWAL_FOREIGN_CURRENCY' is only applicable to 'WITHDRAWALS' in foreign currencies.

transaction_origin
string (TransactionOrigin)
Enum: "DOMESTIC" "FOREIGN" "ANY"

Origin of transaction. This field is applicable for transaction types 'WITHDRAWALS', 'PURCHASES', 'PURCHASE_FOREIGN_CURRENCY' and 'WITHDRAWAL_FOREIGN_CURRENCY'.

transfer_type
Array of strings (TransferType)
Items Enum: "CHA2CHA" "CHA2CHCA" "CHA2AMA" "CHA2AMCA" "CHA2CHMCA" "CHA2CHMA" "CHCA2CHCA" "CHCA2CHA" "CHCA2AMA" "CHCA2AMCA" "CHCA2CHMCA" "CHCA2CHMA" "AMA2AMA" "AMA2CHA" "AMA2CHCA" "AMA2AMCA" "AMA2CHMCA" "AMA2CHMA" "AMCA2AMCA" "AMCA2CHA" "AMCA2CHCA" "AMCA2CHMCA" "AMCA2AMA" "AMCA2CHMA" "CHMCA2CHMCA" "CHMCA2CHA" "CHMCA2CHCA" "CHMCA2AMCA" "CHMCA2AMA" "CHMCA2CHMA" "CHMA2CHMA" "CHMA2CHA" "CHMA2CHCA" "CHMA2AMCA" "CHMA2AMA" "CHMA2CHMCA" "GL2BPA" "GL2CHA" "GL2APA" "GL2BLA" "CHA2BLA" "BLA2CHA" "CHA2APA" "APA2CHA"

Type of transfers

source_channel
string (SourceChannel)
Enum: "ANY" "MPGS" "DAPI" "LEAN" "API" "CHECKOUT"

Type of source channel only applicable for transaction_type = TRANSFERS. Default value is "ANY".

Responses

Request samples

Content type
application/json
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Withdrawal Fee",
  • "type": "FLAT",
  • "currency": "USD",
  • "amount": 2,
  • "percentage": 5,
  • "range": [
    ],
  • "transaction_type": "WITHDRAWALS",
  • "transaction_origin": "DOMESTIC",
  • "transfer_type": [
    ],
  • "source_channel": "ANY"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Withdrawal Fee",
  • "active": true,
  • "type": "FLAT",
  • "currency": "USD",
  • "amount": 2,
  • "percentage": 5,
  • "range": [
    ],
  • "transaction_type": "WITHDRAWALS",
  • "transaction_origin": "DOMESTIC",
  • "transfer_type": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "source_channel": "ANY"
}

getFee

Authorizations:
oauth
path Parameters
fee_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Withdrawal Fee",
  • "active": true,
  • "type": "FLAT",
  • "currency": "USD",
  • "amount": 2,
  • "percentage": 5,
  • "range": [
    ],
  • "transaction_type": "WITHDRAWALS",
  • "transaction_origin": "DOMESTIC",
  • "transfer_type": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "source_channel": "ANY"
}

updateFee

Authorizations:
oauth
path Parameters
fee_id
required
string
Request Body schema: application/json
required
description
string <= 50 characters

Fee description.

active
boolean

Fee status.

type
string (FeeType)
Enum: "FLAT" "PERCENTAGE" "MAX_PERC_OR_FLAT" "MIN_PERC_OR_FLAT" "MAX_PERC_OR_FLAT_W_CAP" "MIN_PERC_OR_FLAT_W_CAP" "RANGE" "RANGE_FLAT" "RANGE_PERCENTAGE" "RANGE_MAX_PERC_OR_FLAT" "RANGE_MIN_PERC_OR_FLAT" "RANGE_MAX_PERC_OR_FLAT_W_CAP" "RANGE_MIN_PERC_OR_FLAT_W_CAP"

Fee types:

  • FLAT: A flat fee refers to a fixed amount a cardholder pays for performing a transaction regardless of a transaction amount.In case of single currency products, the currency of the flat fee is the one supported by the card product.
  • PERCENTAGE: A percentage fee applied on the transaction amount a cardholder pays for performing a transaction. The fee is calculated by applying the percentage to ISO field 6 billing amount coming in authorization from the payment scheme.
  • MAX_PERC_OR_FLAT: A maximum fee selects between an applied percentage fee and flat fee a cardholder pays for performing a transaction.
  • MIN_PERC_OR_FLAT: A minimum fee selects between an applied percentage fee and flat fee a cardholder pays for performing a transaction.
  • MAX_PERC_OR_FLAT_W_CAP: A maximum fee selects between an applied percentage fee and a flat fee. Note that the configured maximum cap limit fee will be applied if the selected fee is greater than the configured cap limit fee.
  • MIN_PERC_OR_FLAT_W_CAP: A minimum fee selects between an applied percentage fee and a flat fee. Note that the configured miminum cap limiy fee will be applied if the selected fee is lesser than the configured cap limit fee.
  • RANGE: Transaction amount based fee slabs where each slab has a configured flat fee or a percentage fee.
  • RANGE_FLAT: Transaction amount based fee slabs where each slab has a configured flat fee.
  • RANGE_PERCENTAGE: Transaction amount based fee slabs where each slab has a configured percentage fee.
  • RANGE_MAX_PERC_OR_FLAT: Transaction amount based fee slabs where each slab has a flat fee and a percentage fee configured and the the maximum fee between the two is applied.
  • RANGE_MIN_PERC_OR_FLAT: Transaction amount based fee slabs where each slab has a flat fee and a percentage fee configured and the the minimum fee between the two is applied.
  • RANGE_MAX_PERC_OR_FLAT_W_CAP: A maximum fee selects between an applied percentage fee and a flat fee based on transaction amount range. Note that the configured maximum cap limit fee will be applied if the selected fee is greater than the configured cap limit fee.
  • RANGE_MIN_PERC_OR_FLAT_W_CAP: A minimum fee selects between an applied percentage fee and a flat fee based on transaction amount range. Note that the configured minimum cap limit fee will be applied if the selected fee is lesser than the configured cap limit fee.
currency
string^([\*]{3}|[A-Z]{3})$

Currency code or ***. Value *** is only applicable for transaction types 'PURCHASE_FOREIGN_CURRENCY' and 'WITHDRAWAL_FOREIGN_CURRENCY'.

amount
number >= 0

Fee amount. It is applicable if fee type includes flat option.

percentage
number [ 0 .. 100 ]

Fee percentage. It is applicable if fee type includes percentage option.

Array of objects (Range)

Array of ranges where fee is applicable.

transaction_type
string (TransactionType)
Enum: "WITHDRAWALS" "PURCHASES" "BALANCE_INQUIRIES" "TRANSFERS" "LOADS" "UNLOADS" "PURCHASE_FOREIGN_CURRENCY" "WITHDRAWAL_FOREIGN_CURRENCY"

The type of transaction. 'PURCHASE_FOREIGN_CURRENCY' is only applicable to 'PURCHASES' in foreign currencies. 'WITHDRAWAL_FOREIGN_CURRENCY' is only applicable to 'WITHDRAWALS' in foreign currencies.

transaction_origin
string (TransactionOrigin)
Enum: "DOMESTIC" "FOREIGN" "ANY"

Origin of transaction. This field is applicable for transaction types 'WITHDRAWALS', 'PURCHASES', 'PURCHASE_FOREIGN_CURRENCY' and 'WITHDRAWAL_FOREIGN_CURRENCY'.

transfer_type
Array of strings (TransferType)
Items Enum: "CHA2CHA" "CHA2CHCA" "CHA2AMA" "CHA2AMCA" "CHA2CHMCA" "CHA2CHMA" "CHCA2CHCA" "CHCA2CHA" "CHCA2AMA" "CHCA2AMCA" "CHCA2CHMCA" "CHCA2CHMA" "AMA2AMA" "AMA2CHA" "AMA2CHCA" "AMA2AMCA" "AMA2CHMCA" "AMA2CHMA" "AMCA2AMCA" "AMCA2CHA" "AMCA2CHCA" "AMCA2CHMCA" "AMCA2AMA" "AMCA2CHMA" "CHMCA2CHMCA" "CHMCA2CHA" "CHMCA2CHCA" "CHMCA2AMCA" "CHMCA2AMA" "CHMCA2CHMA" "CHMA2CHMA" "CHMA2CHA" "CHMA2CHCA" "CHMA2AMCA" "CHMA2AMA" "CHMA2CHMCA" "GL2BPA" "GL2CHA" "GL2APA" "GL2BLA" "CHA2BLA" "BLA2CHA" "CHA2APA" "APA2CHA"

Type of transfers

source_channel
string (SourceChannel)
Enum: "ANY" "MPGS" "DAPI" "LEAN" "API" "CHECKOUT"

Type of source channel only applicable for transaction_type = TRANSFERS. Default value is "ANY".

Responses

Request samples

Content type
application/json
{
  • "description": "Withdrawal Fee",
  • "active": true,
  • "type": "FLAT",
  • "currency": "USD",
  • "amount": 2,
  • "percentage": 5,
  • "range": [
    ],
  • "transaction_type": "WITHDRAWALS",
  • "transaction_origin": "DOMESTIC",
  • "transfer_type": [
    ],
  • "source_channel": "ANY"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Withdrawal Fee",
  • "active": true,
  • "type": "FLAT",
  • "currency": "USD",
  • "amount": 2,
  • "percentage": 5,
  • "range": [
    ],
  • "transaction_type": "WITHDRAWALS",
  • "transaction_origin": "DOMESTIC",
  • "transfer_type": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "source_channel": "ANY"
}

proxy-identityverification

Get reports by id

Authorizations:
oauth
path Parameters
user_id
required
string

user id

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

proxy-balance-limits

List all balance limit

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "has_more": true,
  • "data": [
    ]
}

Create a Balance limit

Authorizations:
oauth
Request Body schema: application/json
required
id
string

The unique identifier of the balance limit. If this information is not present in the request, the system generates one automatically.

description
required
string

The name of the balance limit. We recommend using a unique string.

active
boolean

This parameter defines whether the balance limits are going to be activated or not at the time of its creation. By default the balance limit is activated on its creation.

type
required
string (BalanceLimitType)
Value: "PER_ACCOUNT"

Type of balance limit.

min_amount
required
number <decimal> >= 0

The minimum balance an account can hold.

max_amount
required
number <decimal> >= 0

The maximum balance an account can hold.

currency
required
string <iso-4217> ^[A-Z]{3}$

3-letter ISO_4217 code representing the currency

Responses

Request samples

Content type
application/json
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the balance limit",
  • "active": true,
  • "type": "PER_ACCOUNT",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the balance limit",
  • "active": true,
  • "type": "PER_ACCOUNT",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Get a Balance limit

Authorizations:
oauth
path Parameters
id
required
string

The Balance limit id

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the balance limit",
  • "active": true,
  • "type": "PER_ACCOUNT",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Update a Balance limit

Authorizations:
oauth
path Parameters
id
required
string

The Balance limit id

Request Body schema: application/json
required
description
string

The name of the balance limit. We recommend using a unique string.

active
boolean

This parameter defines whether the balance limits are going to be activated or not at the time of its creation. By default the balance limit is activated on its creation.

type
string (BalanceLimitType)
Value: "PER_ACCOUNT"

Type of balance limit.

min_amount
number <decimal> >= 0

The minimum balance an account can hold.

max_amount
number <decimal> >= 0

The maximum balance an account can hold.

currency
string <iso-4217> ^[A-Z]{3}$

3-letter ISO_4217 code representing the currency

Responses

Request samples

Content type
application/json
{
  • "description": "Some description of the balance limit",
  • "active": true,
  • "type": "PER_ACCOUNT",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the balance limit",
  • "active": true,
  • "type": "PER_ACCOUNT",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

proxy-velocity-limits

List all Velocity limit

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "has_more": true,
  • "data": [
    ]
}

Create a Velocity limit

Authorizations:
oauth
Request Body schema: application/json
required
id
string <= 36 characters

The unique identifier of the velocity limit. If this information is not present in the request, the system generates one automatically.

description
required
string <= 40 characters

The name of the velocity limit. We recommend using a unique string.

active
boolean

This parameter defines whether the velocity limits are going to be activated or not at the time of its creation. By default the velocity limit is activated on its creation.

type
required
string (VelocityLimitType)
Enum: "PER_TRANSACTION" "PER_CARD" "PER_ACCOUNT" "PER_USER"

Type of velocity limit.

min_amount
number <decimal> [ 0 .. 999999999999 ]

The minimum amount of a transaction. The transaction amount can not be lesser than the amount defined here.

max_amount
number <decimal> [ 0 .. 999999999999 ]

The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.

currency
required
string <iso-4217> ^[A-Z]{3}$

3-letter ISO_4217 code representing the currency.

frequency
integer [ 0 .. 999999999 ]

It restricts a number of transactions a user can perform within a specified period of time.

period
string (Period)
Enum: "DAILY" "MONTHLY" "YEARLY" "ALL_TIME" "NUM_OF_DAYS"

It specifies the time period of the velocity limit for the transaction frequency.

num_of_days
integer [ 0 .. 999999999 ]

During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’ and apply the limit accordingly. This field will only be used when ‘period’ = ‘NUM_OF_DAYS’.

transaction_scope
required
Array of strings (TransactionScope) non-empty
Items Enum: "WITHDRAWALS" "PURCHASES" "OUTGOING_TRANSFERS" "UNLOADS" "SCHEME_ACCOUNT_FUNDING" "QUASI_CASH" "PURCHASES_CONTACTLESS_NO_PIN" "LOADS" "INCOMING_TRANSFERS" "SCHEME_CREDITS" "INITIAL_LOAD"

This parameter is to define a transaction scope for this velocity limit.

channel_scope
string (ChannelScopeValues)
Enum: "VISA" "MASTERCARD" "WESTERNUNION"

This parameter is used to create a velocity limit for the channels defined in the system.

Responses

Request samples

Content type
application/json
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "type": "PER_TRANSACTION",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR",
  • "frequency": 999999999,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "type": "PER_TRANSACTION",
  • "min_amount": 100,
  • "max_amount": 1000,
  • "currency": "EUR",
  • "frequency": 0,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Get a Velocity limit

Authorizations:
oauth
path Parameters
id
required
string

The Velocity limit id

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "type": "PER_TRANSACTION",
  • "min_amount": 100,
  • "max_amount": 1000,
  • "currency": "EUR",
  • "frequency": 0,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Update a Velocity limit

Authorizations:
oauth
path Parameters
id
required
string

The Velocity limit id

Request Body schema: application/json
required
description
string <= 40 characters

Velocity limit description.

active
boolean

This parameter describes if velocity limit is activated or not.

type
string (VelocityLimitType)
Enum: "PER_TRANSACTION" "PER_CARD" "PER_ACCOUNT" "PER_USER"

Type of velocity limit.

min_amount
number <decimal> [ 0 .. 999999999999 ]

The minimum amount of a transaction. The transaction amount can not be lesser than the amount defined here.

max_amount
number <decimal> [ 0 .. 999999999999 ]

The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.

currency
string <iso-4217> ^[A-Z]{3}$

3-letter ISO_4217 code representing the currency.

frequency
integer [ 0 .. 999999999 ]

It restricts a number of transactions a user can perform within a specified period of time.

period
string (Period)
Enum: "DAILY" "MONTHLY" "YEARLY" "ALL_TIME" "NUM_OF_DAYS"

It specifies the time period of the velocity limit for the transaction frequency.

num_of_days
integer [ 0 .. 999999999 ]

During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’ and apply the limit accordingly. This field will only be used when ‘period’ = ‘NUM_OF_DAYS’’

transaction_scope
Array of strings (TransactionScope) non-empty
Items Enum: "WITHDRAWALS" "PURCHASES" "OUTGOING_TRANSFERS" "UNLOADS" "SCHEME_ACCOUNT_FUNDING" "QUASI_CASH" "PURCHASES_CONTACTLESS_NO_PIN" "LOADS" "INCOMING_TRANSFERS" "SCHEME_CREDITS" "INITIAL_LOAD"

This parameter array contains the transaction scope for this velocity limit.

channel_scope
string (ChannelScopeValues)
Enum: "VISA" "MASTERCARD" "WESTERNUNION"

This parameter is used to create a velocity limit for the channels defined in the system.

Responses

Request samples

Content type
application/json
{
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "type": "PER_TRANSACTION",
  • "min_amount": 1500.1,
  • "max_amount": 1500.1,
  • "currency": "EUR",
  • "frequency": 999999999,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "description": "Some description of the velocity Limit",
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "type": "PER_TRANSACTION",
  • "min_amount": 100,
  • "max_amount": 1000,
  • "currency": "EUR",
  • "frequency": 0,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "transaction_scope": [
    ],
  • "channel_scope": "VISA",
  • "program_level": true,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

List all Velocity limit condition types

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

Get a Velocity limit condition type

Authorizations:
oauth
path Parameters
id
required
string

The Velocity limit condition type id

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

proxy-advanced-limits

Create Advanced Velocity Limits

Authorizations:
oauth
Request Body schema: application/json
required
id
string <= 36 characters

Unique ID for the advanced velocity limit.

name
required
string [ 1 .. 100 ] characters

The name of advanced velocity limit.

type
required
string (AdvancedVelocityLimitType)
Enum: "PER_CARD" "PER_ACCOUNT" "PER_USER"

Type of advanced velocity limit.

description
string [ 1 .. 400 ] characters

The additional information.

currency
required
string <iso-4217> ^[A-Z]{3}$

3-letter ISO_4217 code representing the currency.

transaction_scope
required
Array of strings (TransactionScope)
Items Enum: "WITHDRAWALS" "PURCHASES" "OUTGOING_TRANSFERS" "UNLOADS" "SCHEME_ACCOUNT_FUNDING" "QUASI_CASH" "PURCHASES_CONTACTLESS_NO_PIN" "LOADS" "INCOMING_TRANSFERS" "SCHEME_CREDITS" "INITIAL_LOAD"

The transaction scope.

active
boolean
Default: true

This parameter describes if advanced velocity limit is activated or not.

amount
number <decimal> [ 0 .. 999999999999 ]

The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.

frequency
integer [ 0 .. 999999999 ]

It restricts a number of transactions a user can perform within a specified period of time.

period
string (AdvancedVelocityLimitPeriod)
Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY" "ALL_TIME" "NUM_OF_DAYS"

It specifies the time period of the advanced velocity limit for the transaction frequency.

num_of_days
integer [ 0 .. 999999999 ]

During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’ and apply the limit accordingly. This field will only be used when ‘period’ = ‘num_of_days’

effective_from
string <date-time>

The date and time from which the limit is effective.

effective_to
string <date-time>
Default: "2099-12-31T11:59:59.999Z"

The date and time to which the limit is effective.

Array of objects (Conditions)

An array of conditions.

group
string (Group)
Enum: "SINGLE" "AGGREGATE"

The advanced velocity limit group.

Responses

Request samples

Content type
application/json
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "name": "limit1",
  • "type": "PER_CARD",
  • "description": "Some description",
  • "currency": "EUR",
  • "transaction_scope": [
    ],
  • "active": true,
  • "amount": 1500.1,
  • "frequency": 999999999,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "effective_from": "2018-01-02T19:42:32.987Z",
  • "effective_to": "2018-01-02T19:42:32.987Z",
  • "conditions": [
    ],
  • "group": "SINGLE"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "name": "limit1",
  • "type": "PER_CARD",
  • "description": "Some description",
  • "currency": "EUR",
  • "transaction_scope": [
    ],
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "amount": 1500.1,
  • "frequency": 999999999,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "effective_from": "2018-01-02T19:42:32.987Z",
  • "effective_to": "2018-01-02T19:42:32.987Z",
  • "program_level": false,
  • "conditions": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "group": "SINGLE"
}

List of Advanced Velocity Limit

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Get Advanced Velocity limit

Authorizations:
oauth
path Parameters
id
required
string

The Velocity limit id

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "name": "limit1",
  • "type": "PER_CARD",
  • "description": "Some description",
  • "currency": "EUR",
  • "transaction_scope": [
    ],
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "amount": 1500.1,
  • "frequency": 999999999,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "effective_from": "2018-01-02T19:42:32.987Z",
  • "effective_to": "2018-01-02T19:42:32.987Z",
  • "program_level": false,
  • "conditions": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "group": "SINGLE"
}

Update Advanced Velocity limit

Authorizations:
oauth
path Parameters
id
required
string

The Balance limit id

Request Body schema: application/json
required
name
string [ 1 .. 100 ] characters

The name of advanced velocity limit.

type
string (AdvancedVelocityLimitType)
Enum: "PER_CARD" "PER_ACCOUNT" "PER_USER"

Type of advanced velocity limit.

description
string [ 1 .. 400 ] characters

The additional information.

currency
string <iso-4217> ^[A-Z]{3}$

3-letter ISO_4217 code representing the currency.

transaction_scope
Array of strings (TransactionScope)
Items Enum: "WITHDRAWALS" "PURCHASES" "OUTGOING_TRANSFERS" "UNLOADS" "SCHEME_ACCOUNT_FUNDING" "QUASI_CASH" "PURCHASES_CONTACTLESS_NO_PIN" "LOADS" "INCOMING_TRANSFERS" "SCHEME_CREDITS" "INITIAL_LOAD"

The transaction scope.

active
boolean
Default: true

This parameter describes if advanced velocity limit is activated or not.

amount
number <decimal> [ 0 .. 999999999999 ]

The maximum amount of a transaction. The transaction amount can not be greater than the amount defined here.

frequency
integer [ 0 .. 999999999 ]

It restricts a number of transactions a user can perform within a specified period of time.

period
string (AdvancedVelocityLimitPeriod)
Enum: "DAILY" "WEEKLY" "MONTHLY" "YEARLY" "ALL_TIME" "NUM_OF_DAYS"

It specifies the time period of the advanced velocity limit for the transaction frequency.

num_of_days
integer [ 0 .. 999999999 ]

During transaction, it will bring the transaction data starting from the ‘currentDay - numberOfDays’ and apply the limit accordingly. This field will only be used when ‘period’ = ‘num_of_days’

effective_from
string <date-time>

The date and time from which the limit is effective.

effective_to
string <date-time>

The date and time to which the limit is effective.

Array of objects (Conditions)

An array of conditions.

group
string (Group)
Enum: "SINGLE" "AGGREGATE"

The advanced velocity limit group.

Responses

Request samples

Content type
application/json
{
  • "name": "limit1",
  • "type": "PER_CARD",
  • "description": "Some description",
  • "currency": "EUR",
  • "transaction_scope": [
    ],
  • "active": true,
  • "amount": 1500.1,
  • "frequency": 999999999,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "effective_from": "2018-01-02T19:42:32.987Z",
  • "effective_to": "2018-01-02T19:42:32.987Z",
  • "conditions": [
    ],
  • "group": "SINGLE"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "name": "limit1",
  • "type": "PER_CARD",
  • "description": "Some description",
  • "currency": "EUR",
  • "transaction_scope": [
    ],
  • "active": true,
  • "consumed_limit": 883.05,
  • "consumed_frequency": 2.1,
  • "amount": 1500.1,
  • "frequency": 999999999,
  • "period": "DAILY",
  • "num_of_days": 15,
  • "effective_from": "2018-01-02T19:42:32.987Z",
  • "effective_to": "2018-01-02T19:42:32.987Z",
  • "program_level": false,
  • "conditions": [
    ],
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "group": "SINGLE"
}

proxy-webhook-notifications

create webhook notification

Endpoint is used to create webhook notification

Authorizations:
oauth
Request Body schema: application/json
required
endpoint
required
string

The enpoint to which the message will be delivered.

events
required
Array of strings (WebhookEvent)
Items Enum: "CARD_STATUS_CHANGE" "TRANSACTION" "KYC_RESULT" "USER_CREATED" "USER_STATUS_CHANGE" "USER_DOCUMENT_ALERT" "IDENTITY_VERIFICATION" "PIN_CHANGE" "EXPIRED_AUTH" "CHARGE_APPLIED" "CARD_PROVISIONING" "ACCOUNT_STATUS_CHANGE" "TOKEN_NOTIFICATION" "CHECKOUT_PAYMENTS" "SUCCESSFULLY_CREATED"

Events to which you can subscribe. Please note that CARD_PROVISIONING event is only applicable for VISA at the moment.

object (WebhooksConfig)

Authentication config, supports basic auth and custom headers.

Responses

Request samples

Content type
application/json
{
  • "endpoint": "https://example.com/",
  • "events": [
    ],
  • "config": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "b012776c-ab74-4ece-8403-0bbb9130508c",
  • "active": true,
  • "events": [
    ],
  • "endpoint": "https://example.com/",
  • "config": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

list webhook notifications

List webhook notification

Authorizations:
oauth

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

get webhook notification by event

Get webhook notification

Authorizations:
oauth
path Parameters
id
required
string

Unique identifier for the webhook

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "b012776c-ab74-4ece-8403-0bbb9130508c",
  • "active": true,
  • "events": [
    ],
  • "endpoint": "https://example.com/",
  • "config": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

update webhook notification

Endpoint is used to update webhook notification

Authorizations:
oauth
path Parameters
id
required
string

Unique identifier for the webhook

Request Body schema: application/json
required
object (WebhookUpdateRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "b012776c-ab74-4ece-8403-0bbb9130508c",
  • "active": true,
  • "events": [
    ],
  • "endpoint": "https://example.com/",
  • "config": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

trigger an webhook notification for testing purposes

Endpoint is used to send webhook notification

Authorizations:
oauth
path Parameters
id
required
string

Unique identifier for the webhook

Request Body schema: application/json
required
string

Responses

Request samples

Content type
application/json
"string"

Response samples

Content type
application/json;charset=UTF-8
"string"

proxy-notificationtemplates

Load all templates

Authorizations:
oauth
query Parameters
language
string
cardProductId
string
category
string
Enum: "THREE_D_SECURE_OTP" "ITSP_OTP" "ONBOARDING_SMS"
walletProvider
string
Enum: "APPLEPAY" "SAMSUNGPAY" "GOOGLEPAY"

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Create a new template

Authorizations:
oauth
Request Body schema: application/json
required
language
required
string

A language attribute identifying the language used in the template. ISO language codes are used.

text
required
string

A free text field for defining the SMS text.

category
required
string (NotificationTemplatesCategory)
Enum: "THREE_D_SECURE_OTP" "ITSP_OTP"

A notification category field that informs about the type of event to which this template is associated.

card_product_id
required
string

The notification template is linked with the card product id shared in this parameter.

wallet_provider
string (WalletProvider)
Enum: "APPLEPAY" "SAMSUNGPAY" "GOOGLEPAY"

The wallet provider.

object (EmailData)

Optional email OTP template. It is applicable for ITSP_OTP category only.

Responses

Request samples

Content type
application/json
{
  • "language": "EN",
  • "text": "Dear Customer, OTP for the online transaction from <MERCHANT_NAME> of <TRANSACTION_AMOUNT> on your card ending with <CARD_LAST4_DIGITS> is <OTP>. If you did not initiate this transaction, call +97144111000.",
  • "category": "THREE_D_SECURE_OTP",
  • "card_product_id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "wallet_provider": "APPLEPAY",
  • "email": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "language": "EN",
  • "text": "Dear Customer, OTP for the online transaction from <MERCHANT_NAME> of <TRANSACTION_AMOUNT> on your card ending with <CARD_LAST4_DIGITS> is <OTP>. If you did not initiate this transaction, call +97144111000.",
  • "category": "THREE_D_SECURE_OTP",
  • "card_product_id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "wallet_provider": "APPLEPAY",
  • "email": {
    }
}

Load template by id

Authorizations:
oauth
path Parameters
template_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "language": "EN",
  • "text": "Dear Customer, OTP for the online transaction from <MERCHANT_NAME> of <TRANSACTION_AMOUNT> on your card ending with <CARD_LAST4_DIGITS> is <OTP>. If you did not initiate this transaction, call +97144111000.",
  • "category": "THREE_D_SECURE_OTP",
  • "card_product_id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "wallet_provider": "APPLEPAY",
  • "email": {
    }
}

update template

Authorizations:
oauth
path Parameters
template_id
required
string
Request Body schema: application/json
required
language
string

A language attribute identifying the language used in the template. ISO language codes are used.

text
string

A free text field for defining the SMS text.

category
string (NotificationTemplatesCategory)
Enum: "THREE_D_SECURE_OTP" "ITSP_OTP"

A notification category field that informs about the type of event to which this template is associated.

card_product_id
string

ID of the card product.

wallet_provider
string (WalletProvider)
Enum: "APPLEPAY" "SAMSUNGPAY" "GOOGLEPAY"

The wallet provider.

object (EmailData)

Optional email OTP template. It is applicable for ITSP_OTP category only.

Responses

Request samples

Content type
application/json
{
  • "language": "EN",
  • "text": "Dear Customer, OTP for the online transaction from <MERCHANT_NAME> of <TRANSACTION_AMOUNT> on your card ending with <CARD_LAST4_DIGITS> is <OTP>. If you did not initiate this transaction, call +97144111000.",
  • "category": "THREE_D_SECURE_OTP",
  • "card_product_id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "wallet_provider": "APPLEPAY",
  • "email": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "language": "EN",
  • "text": "Dear Customer, OTP for the online transaction from <MERCHANT_NAME> of <TRANSACTION_AMOUNT> on your card ending with <CARD_LAST4_DIGITS> is <OTP>. If you did not initiate this transaction, call +97144111000.",
  • "category": "THREE_D_SECURE_OTP",
  • "card_product_id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "wallet_provider": "APPLEPAY",
  • "email": {
    }
}

Load all placeholders

Authorizations:
oauth

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Load Placeholder by ID

Authorizations:
oauth
path Parameters
placeholder_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "placeholder": "<TRANSACTION_AMOUNT>",
  • "source": "string",
  • "masking": false
}

Get operations

Authorizations:
oauth

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Get operation

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "789-748",
  • "code": "PURCHASES",
  • "type": "TRANSACTION"
}

proxy-tenantsettings

uploadPortalConfiguration

Authorizations:
oauth
Request Body schema: application/json
required
object (UploadPortalConfigurationRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json;charset=UTF-8
{ }

updatePortalConfiguration

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
object (UploadPortalConfigurationRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json;charset=UTF-8
{ }

getPortalConfiguration

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

getPortalConfigurationMetadata

Authorizations:
oauth

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

proxy-transactions

Search for Nymcard Transactions instances

Authorizations:
oauth
Request Body schema: application/json
required
query
string

A search query.

sort_by
string

The way results should be sorted.

order_by
string (SortDirection)
Enum: "asc" "desc"

The way results should be ordered (ascending or descending).

matcher
string (SearchMatcher)
Enum: "and" "or"

Search matcher.

Array of objects (SearchFilter)

An array of search filters.

object (Cursors)

Cursors

limit
integer <int32>

Search limit.

Responses

Request samples

Content type
application/json
{
  • "query": "Transfer",
  • "sort_by": "By name",
  • "order_by": "asc",
  • "matcher": "and",
  • "filters": [
    ],
  • "cursors": {
    },
  • "limit": 0
}

Response samples

Content type
application/json;charset=UTF-8
Example
{
  • "paging": {
    },
  • "data": "AdminIndexCollection"
}

Get count of Nymcard Transactions

Authorizations:
oauth
query Parameters
duration
string
transaction_type
string

comma separated transaction types

transfer_type
string

comma separated transfer types

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

Search for Nymcard Transactions

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "LoadTransaction01",
  • "transaction_timestamp": "2021-12-16T14:04:24.593Z",
  • "parent_transaction_id": "5efss08-0558-47ac-b722-4e45r176fb4f",
  • "network": "VISA",
  • "message_type": "API",
  • "transaction_type": "WALLET_CREDIT",
  • "transaction_description": "Wallet Credit",
  • "transmission_date_time": "2018-01-02T19:42:32.987Z",
  • "date_time_acquirer": "2018-01-02T19:42:32.987Z",
  • "card_id": "45678912314567891231456789123121",
  • "card_first_6_digits": "494964",
  • "card_last_4_digits": "6404",
  • "card_expiry_date": "052022",
  • "user_id": "5c0afa53-6ec0-4b08-a180-199352385c9b",
  • "account_id1": "5c0sds53-6ec0-4b08-a180-199352385c9b",
  • "card_product_1": "dfgafa53-6ec0-4b08-a180-199352385c9b",
  • "account_id2": "thfafa53-6ec0-4b08-a180-199352385c9b",
  • "card_product_2": "8uhafa53-6ec0-4b08-a180-199352385c9b",
  • "acquirer_id": "12345678901",
  • "merchant_id": "CARD ACCEPTOR",
  • "mcc": "5947",
  • "merchant_name": "ACQUIRER NAME",
  • "merchant_city": "CITY NAME",
  • "merchant_country": "USA",
  • "terminal_id": "TERMID01",
  • "stan": "000042",
  • "rrn": "13501404242y",
  • "auth_id_response": "476628",
  • "network_transaction_id": "234551234561008",
  • "transaction_amount": 500,
  • "transaction_currency": "USD",
  • "billing_amount": 4,
  • "billing_currency": "USD",
  • "billing_amount_account": 4,
  • "billing_currency_account": "USD",
  • "conversion_rate_billing_account": 4,
  • "acquirer_fee_amount": 2,
  • "conversion_rate_billing": "61000000",
  • "fee_amount": 2,
  • "fee_details": [
    ],
  • "original_amount": 2,
  • "original_amount_billing": "4",
  • "status_code": "0000",
  • "status_description": "Transaction approved",
  • "sender_user_id": "hkuser282",
  • "transfer_id": "234551234561008",
  • "load_id": "LoadTransaction01",
  • "unload_id": "234551234561008",
  • "eci": "05",
  • "ecommerce_security_level": "3DS1",
  • "card_entry": "Physical entry",
  • "pos_environment": "E-Commerce",
  • "fallback": false,
  • "pin_present": false,
  • "moto": false,
  • "recurring": false,
  • "installment_transaction": false,
  • "auth_expired_at": "2018-01-02T19:42:32.987Z",
  • "auth_expired_by": "AUTO",
  • "is_reversed": "YES",
  • "is_settled": "YES",
  • "source_channel": "DAPI",
  • "notes": "Performing operation for 12.50 USD",
  • "external_reference_number": "2b2c3e7c-a07c-11ed-a8fc-0242ac120002",
  • "external_reference_date": "2018-01-02T19:42:32.987Z",
  • "reference_number": "04a466da-cbab-11ed-afa1-0242ac120002",
  • "sweep_details": [
    ],
  • "type": "HOLD",
  • "quote_id": "g189a80f-e641-4045-8a80-54841e4a1234",
  • "receiver_user_id": "g157a80f-e641-7745-8a80-99841e4a1234"
}

proxy-users

API for managing User and their related information

Loads all Users instances.

Authorizations:
oauth
query Parameters
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

parent_user_id
string

parent id to retrieve child users.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "Durable version of current results",
  • "has_more": true,
  • "data": [
    ]
}

Create an user

Authorizations:
oauth
Request Body schema: application/json
required

user info

id
string

Unique identifier of the user. If this information is not present in the request, the system generates one automatically. Please note that this token ID is necessary for use in other API calls, so we recommend that rather than let the system generate one, you use a simple string that is easy to remember. This value cannot be updated.

title
string (UserTitle)
Enum: "MR" "MRS" "MISS"

The user's title/prefix.

first_name
required
string <= 60 characters

User's first name. This parameter is optional for 'user_type'=BUSINESS. Note, that when you want to simulate an Identity Verification process, please provide both the user's 'first_name' and 'last_name' parameters. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

middle_name
string <= 60 characters

User's middle name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

last_name
string <= 60 characters

User's last name. This parameter is mandatory to provide when Identity verification is required. Note, that when you want to simulate an Identity Verification process, please provide both the user's 'first_name' and 'last_name' parameters. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

native_name
string <= 60 characters

Native name of the user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

native_last_name
string <= 60 characters

Native last name.

full_legal_name
string <= 200 characters

Individual user name use for document verification process. It should has the same name as on legal ID document.

full_name_local_language
string <= 50 characters

User's father’s name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

father_name
string <= 60 characters

User's father’s name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

mother_name
string <= 60 characters

User's mother's name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

grandfather_name
string <= 60 characters

User's grandfather’s name.

family_name
string <= 60 characters

User's family name.

marital_status
string

User's marital status.

employment_status
string

User's employment status.

business_type
string <= 50 characters

User / Agent's business type information.

legal_form
string <= 50 characters

User / Agent's legal form information.

date_of_birth
string <date>

The date of birth of the user in the following format - yyyy-mm-dd. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

email
string <= 255 characters

A valid email address for the user.

mobile
string

Mobile number of the user (including area code), appended with "+" symbol and the first three digits to identify the country calling code. Please do not include hyphens, spaces or parentheses.

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

gender
string (UserGender)
Enum: "MALE" "FEMALE"

The gender of the user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

education_level
string <= 50 characters

Education level.

preferred_language
string

A selected language for 3D Secure and digital wallet token notifications sent to this user. By default, notifications are sent in English. The supported value should be provided in ISO language format.

place_of_birth
string

The place of birth of the user. The format should be ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

place_of_birth_city
string <= 50 characters

The city of birth.

nationality
string

Nationality; must be one of ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

parent_user_id
string

Unique identifier of parent user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

created_by
string <= 50 characters

Identifier of user's creator.

country_residence
string <= 3 characters

The country where the individual user resides or is currently citizen of. The format is ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

country_tax_residence
string <= 3 characters

The country for which the tax rules apply to the individual/business user and the user pays tax according to it. The format is ISO alpha 3-character country code.

employment_type
string (EmploymentType)
Enum: "SALARIED" "SELF_EMPLOYED" "RETIRED" "NOT_EMPLOYED" "BUSINESS_OWNER" "STUDENT" "HOMEMAKER" "OTHER"

The employment type of the individual user.

employment_title
string <= 50 characters

The job title (designation) for user_type = INDIVIDUAL. For user_type = BUSINESS this field can give the designation of the primary contact person of the business.

monthly_salary
number >= 0

The monthly salary of the user_type = INDIVIDUAL.

company_name
string <= 200 characters

The company name for which the individual works for in case of SALARIED or company name that the individual runs in case of SELF-EMPLOYED or BUSINESS_OWNER. This parameter is required if "employment_type" = 'SALARIED", "EMPLOYED" or "BUSINESS_OWNER".

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

company_country
string <= 3 characters

Company country in format of ISO alpha 3-character country code. For user_type = INDIVIDUAL this field indicates the country in which the company is registered and conducts its business and activities. For user_type = BUSINESS this field indicates the country in which the business is registered and conducts its activities.

industry_type
string (IndustryType)
Enum: "I01" "I02" "I03" "I04" "I05" "I06" "I07" "I08" "I09" "I11" "I12" "I13" "I14" "I15" "I16" "I17" "I18" "I19" "I20" "I21" "I22" "I23" "I24" "I25" "I26" "I27" "I28" "I29" "I30" "I00"

Type of industry:

  • I01: Gambling/Casinos
  • I02: Defence/Military goods or Arms Dealers and Manufacturers
  • I03: Exchange Companies / Bureaus de Change, Money Changers, Hawala dealers / Other Finance Companies (For e.g. Derivatives Trading, Hedge Funds, Unregistered/Pvt Collective Investment Schemes)
  • I04: Real Estate Brokers / Real Estate Agencies / Real Estate Developers (Non * Govt)
  • I05: Charity Organizations, Religious/Social/Non * Profit Organizations, Cooperative/Social/Professional Societies & associations
  • I06: Auction Houses
  • I07: Dealers in Luxury Goods: (Definition of Luxury Goods include: Precious metals & Stones, Jewelry & Antiques, Art, Furs, Yachts , Executive/Private Jets)
  • I08: Trust Service Providers, Lawyers, Accountants, Tax Advisers, Auditors
  • I09: Private Banking Relationship
  • I11: Agriculture, Forestry, Fishing, and Hunting
  • I12: Mining, Quarrying, and Oil and Gas Extraction
  • I13: Utilities (water, gas, electricity)
  • I14: Telecommunications
  • I15: Construction
  • I16: Manufacturing
  • I17: Wholesale Trade
  • I18: Retail Trade and Commerce
  • I19: Transportation and Warehousing
  • I20: Technology
  • I21: Finance and Insurance
  • I22: Real Estate and Rental and Leasing
  • I23: Professional, Scientific, and Technical Services
  • I24: Management of Companies and Enterprises
  • I25: Educational Services
  • I26: Health Care and Social Assistance
  • I27: Arts, Entertainment, and Recreation
  • I28: Hotels and Food Services
  • I29: Public Administration
  • I30: Administrative and Support and Waste Management
  • I00: Other
expected_monthly_balance
number >= 0

For user_type = INDIVIDUAL this field indicates the expected monthly balance the individual user is planning to maintain in his accounts. For user_type = BUSINESS this field indicates the expected monthly balance the business is planning to maintain in its accounts.

relationship_with_parent
string (RelationshipWithParent)
Enum: "SON" "DAUGHTER" "NEPHEW" "NIECE" "HUSBAND" "WIFE" "FATHER" "MOTHER" "EMPLOYEE" "OTHER"

For a child user this field indicates the relationship of the child user with the parent user.

user_type
string (UserType)
Enum: "INDIVIDUAL" "BUSINESS" "DIRECTOR" "SIGNATURE" "SHAREHOLDER" "SHAREHOLDER_BUSINESS" "AGENT"

The type of the user. You can find all necessary fields per each user type in this GSG doc - https://docs.nymcard.com/get-started/program-management/necessary-parameters-per-user-type. Note, that 'AGENT' user can have a 'parent_user_id' corresponding to an 'AGENT' or 'BUSINESS' user (and not the other user types).

business_legal_name
string <= 200 characters

The business legal name. This field may be used for KYB verification. Applicable for 'user_type' = BUSINESS.

business_dba_name
string <= 50 characters

The business’s secondary name. This field may be used for KYB verification, if the business name is different from the legal business name. Applicable for 'user_type' = BUSINESS.

date_established
string <date-time>

The established date and time. Applicable for 'user_type' = BUSINESS.

phone_number
string^\+\d+

The telephone number.

website
string <= 50 characters

The website. Applicable for 'user_type' = BUSINESS.

designation
string <= 50 characters

It is mandatory to provide this parameter if 'user_type' is DIRECTOR or SIGNATURE. The valid designation should be provided, such as: CEO, CPO, CEO - (region name).

shares_percentage
number <float>

It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.

share_controller_name
string <= 100 characters

It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

incorporation_type
string (UserIncorporationType)
Enum: "LTD" "LLC" "FZE" "FZCO" "FZ-LLC" "INC" "FOUNDATION" "TRUST" "FUND" "PUBLIC_TRADED" "GOVT_OWNED" "LLP" "OTHER"

This parameter indicates whether this business entity is Limited, LLC, Free-zone or anything else.

entity_registered_no
string <= 50 characters

This parameter describes the business/entity registered number.

old_entity_name
string <= 50 characters

This parameter describes the business’s old name.

old_entity_ops_start_date
string <date-time>

It is the start date when the business was operated under old name.

old_entity_ops_end_date
string <date-time>

It is the end date when the business was operated under old name.

regulated_entity
boolean

This parameter indicates if the entity is a regulated entity or no. Possible values are true/false.

regulator_name
string <= 50 characters

This parameter indicates the regulator’s name. It is applicable if 'regulated_entity' parameter is set as 'true'.

business_activities
string <= 1000 characters

This parameter describes the business/entity activities such as Payment Service Provider, IT service provider etc. It can be a comma separated values.

other_operated_countries
string

This parameter indicates the valid country's name(s), where the business is operated.

tax_residence_country
string <= 50 characters

This parameter indicates the name of a country, where the business has a tax residence.

tin
string <= 50 characters

Tax identification number.

external_auditor_name
string <= 50 characters

Name of the external auditor.

director_list
Array of strings

The list of directors. Up to 10 directors can be linked to a business user; but directors should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

signature_list
Array of strings

The list of signatures. Up to 10 signatures can be linked to a business user; but the signatures should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

shareholder_list
Array of strings

The list of shareholders. Up to 50 shareholders can be linked to a business user; but the shareholders should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

company_onbehalf
boolean

This parameter indicates if the company is opened on behalf of another person. Possible values are true/false.

company_onbehalf_relation
string <= 50 characters

In this parameter you should confirm the relationship of the beneficial owner. It is applicable if 'company_onbehalf' parameter is set as 'true'.

object (UserGroupAdditionalInfo)

The additional information, which describes whether entity is a part of a group etc.

object (UserPepCheckInfo)

The information about checking politically exposed persons (“PEPs”) among main shareholders, directors of the entity.

no_of_employees
integer <int32> (UserNoOfEmployees)

This parameter describes the number of employees for the business entity.

accept_cash_check
boolean

This parameter indicates whether the corporate company accepts cash from end users or not. Possible values are true/false.

annual_turnover
number

This parameter describes the annual turnover of the business entity.

source_of_funds
string <= 50 characters

This parameter describes how is the company being funded.

source_fund_uae
boolean

This parameter indicates whether the business source of funds is derived from outside of the UAE or no. Possible values are true/false.

object (UserDueDiligenceDeclaration)

The information about due diligence declaration.

license_type
string <= 100 characters

The license type. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.

license_expiry
string <date>

The license expiry. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.

estimated_activity_through_nymcard
string

This parameter is optional and applicable for 'user_type' = BUSINESS.

expected_number_of_cards
integer <int32> >= 0

This parameter is optional and applicable for 'user_type' = BUSINESS.

expected_use_of_ncs_services
string

This parameter is optional and applicable for 'user_type' = BUSINESS.

object

This parameter holds additional fields configured in tenant settings. This parameter is optional.

Responses

Request samples

Content type
application/json
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "title": "MR",
  • "first_name": "John",
  • "middle_name": "Anthony",
  • "last_name": "Smith",
  • "native_name": "John Smith",
  • "native_last_name": "Júañ Hérreró",
  • "full_legal_name": "John Smith",
  • "full_name_local_language": "Volodymyr",
  • "father_name": "John Smith",
  • "mother_name": "Mary Ann",
  • "grandfather_name": "Andrew",
  • "family_name": "Smith",
  • "marital_status": "Divorced",
  • "employment_status": "Worker",
  • "business_type": "LCC",
  • "legal_form": "Company",
  • "date_of_birth": "2012-05-04",
  • "email": "bob@example.com",
  • "mobile": "+551185249635",
  • "address": {
    },
  • "gender": "MALE",
  • "education_level": "Graduate",
  • "preferred_language": "EN",
  • "place_of_birth": "USA",
  • "place_of_birth_city": "Toronto",
  • "nationality": "USA",
  • "parent_user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "created_by": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "country_residence": "USA",
  • "country_tax_residence": "USA",
  • "employment_type": "SALARIED",
  • "employment_title": "QAE",
  • "monthly_salary": "12000",
  • "company_name": "Example",
  • "company_address": {
    },
  • "company_country": "USA",
  • "industry_type": "I01",
  • "expected_monthly_balance": "100000",
  • "relationship_with_parent": "SON",
  • "user_type": "INDIVIDUAL",
  • "business_legal_name": "Insurance corporation",
  • "business_dba_name": "John Smith insurance corporation",
  • "date_established": "2012-05-04T19:42:32.987Z",
  • "phone_number": "+551185249635",
  • "website": "example.com",
  • "designation": "CEO",
  • "shares_percentage": 100,
  • "share_controller_name": "Nabil Benaissa",
  • "local_address": {
    },
  • "incorporation_type": "LTD",
  • "entity_registered_no": "2233445533",
  • "old_entity_name": "Old name",
  • "old_entity_ops_start_date": "2012-05-04",
  • "old_entity_ops_end_date": "2014-05-04",
  • "regulated_entity": true,
  • "regulator_name": "ABC",
  • "business_activities": "IT Services",
  • "other_operated_countries": "US",
  • "tax_residence_country": "UAE",
  • "tin": "1122334455",
  • "external_auditor_name": "ABC",
  • "director_list": [
    ],
  • "signature_list": [
    ],
  • "shareholder_list": [
    ],
  • "company_onbehalf": true,
  • "company_onbehalf_relation": "John Smith",
  • "group_additional_info": {
    },
  • "pep_check_info": {
    },
  • "no_of_employees": 25,
  • "accept_cash_check": true,
  • "annual_turnover": 0,
  • "source_of_funds": "Business",
  • "source_fund_uae": true,
  • "due_diligence_declaration": {
    },
  • "license_type": "Test License Updated",
  • "license_expiry": "2025-06-06",
  • "estimated_activity_through_nymcard": "ABCD",
  • "expected_number_of_cards": "1",
  • "expected_use_of_ncs_services": "ABCD",
  • "custom_info": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{ }

Get details from an existing User instance.

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

Update an user for given Id

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
title
string (UserTitle)
Enum: "MR" "MRS" "MISS"

The user's title/prefix.

first_name
string

User's first name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

middle_name
string

User's middle name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

last_name
string

User's last name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

native_name
string

Native name of the user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

native_last_name
string <= 60 characters

Native last name.

full_legal_name
string

Individual user name use for document verification process. It should has the same name as on legal ID document.

full_name_local_language
string <= 50 characters

User's full name in local language. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

father_name
string <= 50 characters

User's father’s name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

mother_name
string <= 50 characters

User's mother's name. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

grandfather_name
string <= 50 characters

User's grandfather’s name.

family_name
string <= 50 characters

User's family name.

marital_status
string

User's marital status.

employment_status
string

User's employment status.

business_type
string <= 50 characters

User / Agent's business type information.

legal_form
string <= 50 characters

User / Agent's legal form information.

date_of_birth
string <date>

The date of birth of the user in the following format - yyyy-mm-dd. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

email
string <= 255 characters

A valid email address for the user.

mobile
string

Mobile number of the user (including area code), appended with "+" symbol and the first three digits to identify the country calling code. Please do not include hyphens, spaces or parentheses.

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

gender
string (UserGender)
Enum: "MALE" "FEMALE"

The gender of the user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

education_level
string <= 50 characters

Education level.

preferred_language
string

A selected language for 3D Secure and digital wallet token notifications sent to this user. By default, notifications are sent in English. The supported value should be provided in ISO language format.

place_of_birth
string

The place of birth of the user. The format should be ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

place_of_birth_city
string <= 50 characters

The city of birth.

nationality
string

Nationality; must be one of ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

parent_user_id
string

Unique identifier of parent user. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

country_residence
string <= 3 characters

The country where the individual user resides or is currently citizen of. The format is ISO alpha 3-character country code. Note, that if KYC settings=true at the tenant level, this parameter can not be updated for user with ACTIVE status.

country_tax_residence
string <= 3 characters

The country for which the tax rules apply to the individual/business user and the user pays tax according to it. The format is ISO alpha 3-character country code.

employment_type
string (EmploymentType)
Enum: "SALARIED" "SELF_EMPLOYED" "RETIRED" "NOT_EMPLOYED" "BUSINESS_OWNER" "STUDENT" "HOMEMAKER" "OTHER"

The employment type of the individual user.

employment_title
string <= 50 characters

The job title (designation) for user_type = INDIVIDUAL. For user_type = BUSINESS this field can give the designation of the primary contact person of the business.

monthly_salary
number >= 0

The monthly salary of the user_type = INDIVIDUAL.

company_name
string <= 200 characters

The company name for which the individual works for in case of SALARIED OR company name that the individual runs in case of SELF-EMPLOYED OR BUSINESS_OWNER. This parameter is required if "employment_type" = 'SALARIED", "EMPLOYED" or "BUSINESS_OWNER".

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

company_country
string <= 3 characters

Company country in format of ISO alpha 3-character country code. For user_type = INDIVIDUAL this field indicates the country in which the company is registered and conducts its business and activities. For user_type = BUSINESS this field indicates the country in which the Business is registered and conducts its activities.

industry_type
string (IndustryType)
Enum: "I01" "I02" "I03" "I04" "I05" "I06" "I07" "I08" "I09" "I11" "I12" "I13" "I14" "I15" "I16" "I17" "I18" "I19" "I20" "I21" "I22" "I23" "I24" "I25" "I26" "I27" "I28" "I29" "I30" "I00"

Type of industry:

  • I01: Gambling/Casinos
  • I02: Defence/Military goods or Arms Dealers and Manufacturers
  • I03: Exchange Companies / Bureaus de Change, Money Changers, Hawala dealers / Other Finance Companies (For e.g. Derivatives Trading, Hedge Funds, Unregistered/Pvt Collective Investment Schemes)
  • I04: Real Estate Brokers / Real Estate Agencies / Real Estate Developers (Non * Govt)
  • I05: Charity Organizations, Religious/Social/Non * Profit Organizations, Cooperative/Social/Professional Societies & associations
  • I06: Auction Houses
  • I07: Dealers in Luxury Goods: (Definition of Luxury Goods include: Precious metals & Stones, Jewelry & Antiques, Art, Furs, Yachts , Executive/Private Jets)
  • I08: Trust Service Providers, Lawyers, Accountants, Tax Advisers, Auditors
  • I09: Private Banking Relationship
  • I11: Agriculture, Forestry, Fishing, and Hunting
  • I12: Mining, Quarrying, and Oil and Gas Extraction
  • I13: Utilities (water, gas, electricity)
  • I14: Telecommunications
  • I15: Construction
  • I16: Manufacturing
  • I17: Wholesale Trade
  • I18: Retail Trade and Commerce
  • I19: Transportation and Warehousing
  • I20: Technology
  • I21: Finance and Insurance
  • I22: Real Estate and Rental and Leasing
  • I23: Professional, Scientific, and Technical Services
  • I24: Management of Companies and Enterprises
  • I25: Educational Services
  • I26: Health Care and Social Assistance
  • I27: Arts, Entertainment, and Recreation
  • I28: Hotels and Food Services
  • I29: Public Administration
  • I30: Administrative and Support and Waste Management
  • I00: Other
expected_monthly_balance
number >= 0

For user_type = INDIVIDUAL this field indicates the expected monthly balance the individual user is planning to maintain in his accounts. For user_type = BUSINESS this field indicates the expected monthly balance the business is planning to maintain in its accounts.

relationship_with_parent
string (RelationshipWithParent)
Enum: "SON" "DAUGHTER" "NEPHEW" "NIECE" "HUSBAND" "WIFE" "FATHER" "MOTHER" "EMPLOYEE" "OTHER"

For a child user this field indicates the relationship of the child user with the parent user.

business_legal_name
string <= 200 characters

The business legal name. This field may be used for KYB verification. Applicable for 'user_type' = BUSINESS.

business_dba_name
string <= 50 characters

The business’s secondary name. This field may be used for KYB verification, if the business name is different from the legal business name. Applicable for 'user_type' = BUSINESS.

date_established
string <date-time>

The established date and time. Applicable for 'user_type' = BUSINESS.

phone_number
string^\+\d+

The telephone number.

website
string <= 50 characters

The website. Applicable for 'user_type' = BUSINESS.

designation
string <= 50 characters

It is mandatory to provide this parameter if 'user_type' is DIRECTOR or SIGNATURE. The valid designation should be provided, such as: CEO, CPO, CEO - (region name).

shares_percentage
number <float>

It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.

share_controller_name
string <= 100 characters

It is mandatory to provide this parameter if 'user_type' is SHAREHOLDER or SHAREHOLDER_BUSINESS.

object (Address)

The details of the address. "ADDRESS" parameter stands for user's address. "COMPANY_ADDRESS" parameter stands for company's address. "LOCAL_ADDRESS" parameter stands for designated address shared in onboarding form for shareholders. It is mandatory to provide "LOCAL_ADDRESS" parameter if 'user_type' is SHAREHOLDER.

incorporation_type
string (UserIncorporationType)
Enum: "LTD" "LLC" "FZE" "FZCO" "FZ-LLC" "INC" "FOUNDATION" "TRUST" "FUND" "PUBLIC_TRADED" "GOVT_OWNED" "LLP" "OTHER"

This parameter indicates whether this business entity is Limited, LLC, Free-zone or anything else.

entity_registered_no
string <= 50 characters

This parameter describes the business/entity registered number.

old_entity_name
string <= 50 characters

This parameter describes the business’s old name.

old_entity_ops_start_date
string <date-time>

It is the start date when the business was operated under old name.

old_entity_ops_end_date
string <date-time>

It is the end date when the business was operated under old name.

regulated_entity
boolean

This parameter indicates if the entity is a regulated entity or no. Possible values are true/false.

regulator_name
string <= 50 characters

This parameter indicates the regulator’s name. It is applicable if 'regulated_entity' parameter is set as 'true'.

business_activities
string <= 1000 characters

This parameter describes the business/entity activities such as Payment Service Provider, IT service provider etc. It can be a comma separated values.

other_operated_countries
string

This parameter indicates the valid country's name(s), where the business is operated.

tax_residence_country
string <= 50 characters

This parameter indicates the name of a country, where the business has a tax residence.

tin
string <= 50 characters

Tax identification number.

external_auditor_name
string <= 50 characters

Name of the external auditor.

director_list
Array of strings

The list of directors. Up to 10 directors can be linked to a business user; but directors should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

signature_list
Array of strings

The list of signatures. Up to 10 signatures can be linked to a business user; but the signatures should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

shareholder_list
Array of strings

The list of shareholders. Up to 50 shareholders can be linked to a business user; but the shareholders should be created prior creating the business user (if providing any ID in the list), else you can link the user later with the business.

company_onbehalf
boolean

This parameter indicates if the company is opened on behalf of another person. Possible values are true/false.

company_onbehalf_relation
string <= 50 characters

In this parameter you should confirm the relationship of the beneficial owner. It is applicable if 'company_onbehalf' parameter is set as 'true'.

object (UserGroupAdditionalInfo)

The additional information, which describes whether entity is a part of a group etc.

object (UserPepCheckInfo)

The information about checking politically exposed persons (“PEPs”) among main shareholders, directors of the entity.

no_of_employees
integer <int32> (UserNoOfEmployees)

This parameter describes the number of employees for the business entity.

accept_cash_check
boolean

This parameter indicates whether the corporate company accepts cash from end users or not. Possible values are true/false.

annual_turnover
number

This parameter describes the annual turnover of the business entity.

source_of_funds
string <= 50 characters

This parameter describes how is the company being funded.

source_fund_uae
boolean

This parameter indicates whether the business source of funds is derived from outside of the UAE or no. Possible values are true/false.

object (UserDueDiligenceDeclaration)

The information about due diligence declaration.

license_type
string <= 100 characters

The license type. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.

license_expiry
string <date>

The license expiry. This parameter is applicable for 'user_type' = SHAREHOLDER_BUSINESS.

estimated_activity_through_nymcard
string

This parameter is optional and applicable for 'user_type' = BUSINESS.

expected_number_of_cards
integer <int32> >= 0

This parameter is optional and applicable for 'user_type' = BUSINESS.

expected_use_of_ncs_services
string

This parameter is optional and applicable for 'user_type' = BUSINESS.

object

This parameter holds additional fields configured in tenant settings. This parameter is optional.

Responses

Request samples

Content type
application/json
{
  • "title": "MR",
  • "first_name": "John",
  • "middle_name": "Anthony",
  • "last_name": "Smith",
  • "native_name": "John Smith",
  • "native_last_name": "Júañ Hérreró",
  • "full_legal_name": "John Smith",
  • "full_name_local_language": "Volodymyr",
  • "father_name": "John Smith",
  • "mother_name": "Mary Ann",
  • "grandfather_name": "Andrew",
  • "family_name": "Smith",
  • "marital_status": "Divorced",
  • "employment_status": "Worker",
  • "business_type": "LCC",
  • "legal_form": "Company",
  • "date_of_birth": "2012-05-04",
  • "email": "bob@example.com",
  • "mobile": "+551185249635",
  • "address": {
    },
  • "gender": "MALE",
  • "education_level": "Graduate",
  • "preferred_language": "EN",
  • "place_of_birth": "USA",
  • "place_of_birth_city": "Toronto",
  • "nationality": "USA",
  • "parent_user_id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "country_residence": "USA",
  • "country_tax_residence": "USA",
  • "employment_type": "SALARIED",
  • "employment_title": "QAE",
  • "monthly_salary": "12000",
  • "company_name": "Example",
  • "company_address": {
    },
  • "company_country": "USA",
  • "industry_type": "I01",
  • "expected_monthly_balance": "100000",
  • "relationship_with_parent": "SON",
  • "business_legal_name": "Insurance corporation",
  • "business_dba_name": "John Smith insurance corporation",
  • "date_established": "2012-05-04T19:42:32.987Z",
  • "phone_number": "+551185249635",
  • "website": "example.com",
  • "designation": "CEO",
  • "shares_percentage": 100,
  • "share_controller_name": "Nabil Benaissa",
  • "local_address": {
    },
  • "incorporation_type": "LTD",
  • "entity_registered_no": "2233445533",
  • "old_entity_name": "Old name",
  • "old_entity_ops_start_date": "2012-05-04",
  • "old_entity_ops_end_date": "2014-05-04",
  • "regulated_entity": true,
  • "regulator_name": "ABC",
  • "business_activities": "IT Services",
  • "other_operated_countries": "US",
  • "tax_residence_country": "UAE",
  • "tin": "1122334455",
  • "external_auditor_name": "ABC",
  • "director_list": [
    ],
  • "signature_list": [
    ],
  • "shareholder_list": [
    ],
  • "company_onbehalf": true,
  • "company_onbehalf_relation": "John Smith",
  • "group_additional_info": {
    },
  • "pep_check_info": {
    },
  • "no_of_employees": 25,
  • "accept_cash_check": true,
  • "annual_turnover": 0,
  • "source_of_funds": "Business",
  • "source_fund_uae": true,
  • "due_diligence_declaration": {
    },
  • "license_type": "Test License Updated",
  • "license_expiry": "2025-06-06",
  • "estimated_activity_through_nymcard": "ABCD",
  • "expected_number_of_cards": "1",
  • "expected_use_of_ncs_services": "ABCD",
  • "custom_info": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{ }

Upload User Avatar

Authorizations:
oauth
path Parameters
user_id
required
string
Request Body schema: multipart/form-data
required
file
required
string <binary>

The file to be uploaded.

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

Get user's avatar

Authorizations:
oauth
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "FileUploadContent",
  • "user_id": "user120",
  • "metadata": {
    },
  • "content": "2rl0Dvc1gTrOTTqzgNaK62wj9tT91kEZRjUGF2kWWeBN4BGy7xYdAR7Mc6duajDBLQ_y8pBKeXaxRPUXIcK5K734Z7rmtAYIzMam2RClvKcU"
}

Change User status.

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
status
required
string (CardStatus)
Enum: "INACTIVE" "ACTIVE" "SUSPENDED" "TERMINATED"

The status of a card.

status_reason_code
required
string (StatusChangeReason)
Enum: "A0" "A1" "A3" "AT" "I1" "S0" "S1" "S3" "S4" "S5" "S6" "S7" "ST" "T0" "T1" "T2" "T3" "T4" "T5" "T6" "T7" "T8" "T9" "T10" "T11" "T12" "T13" "T14" "T15" "T16" "T17" "T18"

Status Change Reason Code:

  • A0: First time activation: when activated from Inactive to Active status
  • A1: Resumed from Suspended status: when card is moved back to Active status
  • A3: Activated by admin
  • I1: Updated soft expiry of SUSPENDED(S2) card
  • S0: Temporary suspension: initiated by the user or system user or the system
  • S1: PIN retries exhausted: when bad PIN retries are exhausted
  • S3: Admin rejected due to ID verification failed
  • S4: Admin suspended due to fraudulent activity
  • S5: Admin rejected due to ID verification failed
  • S6: Admin suspended due to certain reason
  • S7: Admin suspended due to being delinquent for a certain amount of time
  • T0: Card Lost
  • T1: Card Stolen
  • T2: Card Expired
  • T3: Card Damaged
  • T4: Closed by user
  • T5: Closed by issuer
  • T6: Closed by issuer after renewal
  • S7: Admin suspended due to being delinquent for a certain amount of time
  • T7: Admin terminated due to limited time exceeded and action taken for ID verification fail
  • T8: Admin terminated due to KYC OGS response
  • T9: Admin terminated due to ID verification failed
  • T10: Admin terminated due to limited time exceeded and action taken for KYB fail
  • T11: Admin terminated due to certain reason
  • T12: System terminated due to ID verification rejected
  • T13: System terminated due to ID verification suspected
  • T14: Failed KYC
  • T15: Fraudulent activity was identified
  • T16: Matched with an Office of Foreign Assets Control list
  • T17: Admin terminated due to ID verification failed
  • T18: Admin terminated due to KYC failed
object (CoreNote)

This field is to capture additional information by the user while changing the card status. E.g. how the card got stolen, what is the reason behind a damage, etc.

modified_by
string
Default: "API"

This field indicates the user who executed the operation.

Responses

Request samples

Content type
application/json
{
  • "status": "INACTIVE",
  • "status_reason_code": "A0",
  • "note": {
    },
  • "modified_by": "API"
}

Response samples

Content type
application/json;charset=UTF-8
{ }

Change User status.

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
object (StatusChangeAdminRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json;charset=UTF-8
{ }

get kyc details by user_id

Authorizations:
oauth
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

change kyc status

Authorizations:
oauth
path Parameters
id
required
string
Request Body schema: application/json
required
object (ChangeKycStatusRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json;charset=UTF-8
{ }

Get Identifications

Authorizations:
oauth
path Parameters
user_id
required
string

user id

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

Create Identification

Authorizations:
oauth
path Parameters
user_id
required
string

user id

Request Body schema: application/json
required

user identification

type
required
string (IdentificationType)
Enum: "PASSPORT" "VISA" "NATIONAL_ID" "CIVIL_ID" "TRADE_LICENSE" "COMMERCIAL_LICENSE" "INCORPORATION_CERT" "INCUMBENCY_CERT" "MEMORANDUM_ARTICLES" "BANK_STATEMENT" "ADDITIONAL"

The identification type of file to be uploaded.

title
string <= 40 characters

The document title.

number
required
string

The document number.

issuance_authority
string

The name of issuance authority.

place_of_issuance
string

The place of issuance.

expiration_date
string

The expiration date of the document.

issuance_date
string

The issuance date of the document.

identification_note
string <= 100 characters

A note, which contains details about the identification type.

Responses

Request samples

Content type
application/json
{
  • "type": "PASSPORT",
  • "title": "SELFIE",
  • "number": "132123123",
  • "issuance_authority": "Ministry of defense",
  • "place_of_issuance": "Lebanon",
  • "expiration_date": "2022-05-04",
  • "issuance_date": "2012-05-04",
  • "identification_note": "Some note"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "3e9392df-4093-4389-a0ad-92456a181b8a",
  • "type": "PASSPORT",
  • "title": "SELFIE",
  • "user_id": "132123123",
  • "number": "132123123",
  • "issuance_authority": "Ministry of defense",
  • "place_of_issuance": "Lebanon",
  • "issuance_date": "2012-05-04T19:42:32.987Z",
  • "expiration_date": "2012-05-04T19:42:32.987Z",
  • "document_status": "PENDINGKYB",
  • "document_status_reason": "I0",
  • "files": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "identification_note": "Some note"
}

Upload a single image of identification

Authorizations:
oauth
path Parameters
user_id
required
string
identification_id
required
string
Request Body schema: application/x-www-form-urlencoded
required
string (IdentificationDocumentType)
Enum: "NATIONAL_ID_FRONT" "NATIONAL_ID_BACK" "PASSPORT_PAGE1" "PASSPORT_PAGE2" "VISA" "ADDITIONAL_PAGE_1" "ADDITIONAL_PAGE_2"

The identification document type of file to be uploaded.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "9e354f40-2ea5-43a9-92ec-2f967c3981f9.png",
  • "file_name": "9e354f40-2ea5-43a9-92ec-2f967c3981f9.png",
  • "content_type": "application/pdf",
  • "size": 4562,
  • "identification_type": "PASSPORT",
  • "identification_document_type": "NATIONAL_ID_FRONT",
  • "version": 1,
  • "created": "2012-05-04T19:42:32.987Z",
  • "title": "SELFIE"
}

Return File Content

Authorizations:
oauth
path Parameters
user_id
required
string
identification_id
required
string
file_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "FileUploadContent",
  • "user_id": "user120",
  • "metadata": {
    },
  • "content": "2rl0Dvc1gTrOTTqzgNaK62wj9tT91kEZRjUGF2kWWeBN4BGy7xYdAR7Mc6duajDBLQ_y8pBKeXaxRPUXIcK5K734Z7rmtAYIzMam2RClvKcU"
}

Search for User instances

Authorizations:
oauth
Request Body schema: application/json
required
name
string

Filter by first, middle and last names of the user. Search works for complete or partial string.

mobile
string

Filter by mobile number of the user. Search works for complete or partial string.

email
string

Filter by user's email. Search works for complete or partial string.

status
Array of strings
Items Enum: "ACTIVE" "PENDINGKYC" "PENDINGKYB" "PENDINGIDVERIFICATION" "SUSPENDED" "TERMINATED"

Filter by user's status.

user_type
string (UserType)
Enum: "INDIVIDUAL" "BUSINESS" "DIRECTOR" "SIGNATURE" "SHAREHOLDER" "SHAREHOLDER_BUSINESS" "AGENT"

The type of the user. You can find all necessary fields per each user type in this GSG doc - https://docs.nymcard.com/get-started/program-management/necessary-parameters-per-user-type. Note, that 'AGENT' user can have a 'parent_user_id' corresponding to an 'AGENT' or 'BUSINESS' user (and not the other user types).

business_legal_name
string

Filter by business legal name, search for complete or partial string.

business_dba_name
string

Filter by business DBA name, search for complete or partial string.

website
string

Filter by website, search for complete or partial string.

created_from
string <date-time>

Search users created on this date and onwards.

created_to
string <date-time>

Search users created prior to this date.

modified_from
string <date-time>

Search users modified on this date and onwards.

modified_to
string <date-time>

Search users modified prior to this date.

limit
integer

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

The way results should be sorted.

order_by
string (SortDirection)
Enum: "asc" "desc"

The way results should be ordered (ascending or descending).

Responses

Request samples

Content type
application/json
{
  • "name": "John",
  • "mobile": "+559999999995",
  • "email": "johndoe@example.com",
  • "status": [
    ],
  • "user_type": "INDIVIDUAL",
  • "business_legal_name": "Insurance corporation",
  • "business_dba_name": "John Smith insurance corporation",
  • "website": "example.com",
  • "created_from": "2012-05-04T19:42:32.987Z",
  • "created_to": "2012-05-04T19:42:32.987Z",
  • "modified_from": "2012-05-04T19:42:32.987Z",
  • "modified_to": "2012-05-04T19:42:32.987Z",
  • "limit": "10",
  • "after": "MTA=",
  • "sort_by": "created",
  • "order_by": "asc"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "Durable version of current results",
  • "has_more": true,
  • "data": [
    ]
}

Get an alias

Authorizations:
oauth
path Parameters
user_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "3e9392df-4093-4389-a0ad-92456a181b8a",
  • "alias": "Smith",
  • "status": true,
  • "user_id": "4e9392df-4093-4389-a0ad-69376a181b8a",
  • "account_id": "5e9392df-4093-4389-a0ad-036746a181b8a",
  • "full_name": "John Smith",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Create an alias

Authorizations:
oauth
path Parameters
user_id
required
string
Request Body schema: application/json
id
string <= 36 characters

The unique identifier of user alias.

alias
required
string <= 40 characters

The alias.

status
boolean

The alias status.

account_id
required
string <= 36 characters

The unique identifier of account.

Responses

Request samples

Content type
application/json
{
  • "id": "3e9392df-4093-4389-a0ad-92456a181b8a",
  • "alias": "Smith",
  • "status": true,
  • "account_id": "5e9392df-4093-4389-a0ad-036746a181b8a"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "3e9392df-4093-4389-a0ad-92456a181b8a",
  • "alias": "Smith",
  • "status": true,
  • "user_id": "4e9392df-4093-4389-a0ad-69376a181b8a",
  • "account_id": "5e9392df-4093-4389-a0ad-036746a181b8a",
  • "full_name": "John Smith",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Update an alias

Authorizations:
oauth
path Parameters
user_id
required
string
id
required
string
Request Body schema: application/json
alias
string <= 40 characters

The alias.

status
boolean

The alias status.

account_id
string <= 36 characters

The unique identifier of account.

Responses

Request samples

Content type
application/json
{
  • "alias": "Smith",
  • "status": true,
  • "account_id": "5e9392df-4093-4389-a0ad-036746a181b8a"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "3e9392df-4093-4389-a0ad-92456a181b8a",
  • "alias": "Smith",
  • "status": true,
  • "user_id": "4e9392df-4093-4389-a0ad-69376a181b8a",
  • "account_id": "5e9392df-4093-4389-a0ad-036746a181b8a",
  • "full_name": "John Smith",
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

get kyc by id

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{ }

proxy-credit

Get list of Statement stats

Authorizations:
oauth
Request Body schema: application/json
required
account_id
required
string

Identifier for the account to which the statement is attached.

statements_limit
integer [ 1 .. 12 ]

Number of statements to be retrieved.

statement_date
required
string <date>

Statement date from which statements will be retrieved. In MM/DD/YYYY format.

Responses

Request samples

Content type
application/json
{
  • "account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "statements_limit": 1,
  • "statement_date": "10/01/2023"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "statementCurrencyCode": "USD",
  • "statement_stats": [
    ]
}

proxy-locations

API for managing remittances

Get list of locations

Authorizations:
oauth
query Parameters
region
string
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

createLocation

Authorizations:
oauth
Request Body schema: application/json
required
object (LocationCreateRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "5e18bf36-9356-4437-a11f-b2e425556096",
  • "new_branch_atm": "ATM123",
  • "region": "West",
  • "area": "Downtown",
  • "location": "Main Street",
  • "responsible_branch": "Branch001",
  • "street_avenue": "5th Avenue",
  • "building": "Building A",
  • "floor": "1st",
  • "near": "Near the park",
  • "x": 40.7128,
  • "y": 74.006,
  • "number_of_atms": 2,
  • "deposit": true,
  • "pin_indicator": "Active",
  • "google_maps_status": "Verified"
}

createMultipleLocations

Authorizations:
oauth
Request Body schema: application/json
required
object (BulkCreateLocationRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

getLocations

Authorizations:
oauth
path Parameters
locations_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "5e18bf36-9356-4437-a11f-b2e425556096",
  • "new_branch_atm": "ATM123",
  • "region": "West",
  • "area": "Downtown",
  • "location": "Main Street",
  • "responsible_branch": "Branch001",
  • "street_avenue": "5th Avenue",
  • "building": "Building A",
  • "floor": "1st",
  • "near": "Near the park",
  • "x": 40.7128,
  • "y": 74.006,
  • "number_of_atms": 2,
  • "deposit": true,
  • "pin_indicator": "Active",
  • "google_maps_status": "Verified"
}

updateLocation

Authorizations:
oauth
path Parameters
locations_id
required
string
Request Body schema: application/json
required
object (LocationUpdateRequest)

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "5e18bf36-9356-4437-a11f-b2e425556096",
  • "new_branch_atm": "ATM123",
  • "region": "West",
  • "area": "Downtown",
  • "location": "Main Street",
  • "responsible_branch": "Branch001",
  • "street_avenue": "5th Avenue",
  • "building": "Building A",
  • "floor": "1st",
  • "near": "Near the park",
  • "x": 40.7128,
  • "y": 74.006,
  • "number_of_atms": 2,
  • "deposit": true,
  • "pin_indicator": "Active",
  • "google_maps_status": "Verified"
}

deleteLinkedInstrument

Authorizations:
oauth
path Parameters
locations_id
required
string

Responses

sdkSettingsV2

createSdkSettings

Authorizations:
oauth
Request Body schema: application/json
required
card_types
required
Array of strings (CardType) non-empty unique
Items Enum: "PHYSICAL" "VIRTUAL"
card_products
required
Array of strings non-empty unique
master_card_product
string <= 36 characters
activate_cards_upon_top_up
boolean
notification_provider
required
string (NotificationProvider)
Value: "FIREBASE"

Supported notification providers

Array of objects (CardCurrencyProduct)
object (NotificationSettings)
object (CardAutoCreationSettings)
Array of objects (CardAutoCreationSettings)
app_download_link
string
app_login_link
string
onboarding_token_expiry
integer <int32> >= 0
user_id_generation_required
boolean
object (UserIdGenerationSettings)
is_preferred_currency_enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "card_types": [
    ],
  • "card_products": [
    ],
  • "master_card_product": "string",
  • "activate_cards_upon_top_up": true,
  • "notification_provider": "FIREBASE",
  • "card_currency_products": [
    ],
  • "notification_settings": {
    },
  • "child_auto_card_creation": {
    },
  • "parent_auto_card_creation": [
    ],
  • "app_download_link": "string",
  • "app_login_link": "string",
  • "onboarding_token_expiry": 0,
  • "user_id_generation_required": true,
  • "user_id_generation_settings": {
    },
  • "is_preferred_currency_enabled": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "tenant_id": "string",
  • "card_types": [
    ],
  • "card_products": [
    ],
  • "master_card_product": "string",
  • "activate_cards_upon_top_up": true,
  • "notification_provider": "FIREBASE",
  • "card_currency_products": [
    ],
  • "notification_settings": {
    },
  • "child_auto_card_creation": {
    },
  • "parent_auto_card_creation": [
    ],
  • "app_download_link": "string",
  • "app_login_link": "string",
  • "onboarding_token_expiry": 0,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "user_id_generation_required": true,
  • "user_id_generation_settings": {
    },
  • "is_preferred_currency_enabled": true
}

updateSdkSettings

Authorizations:
oauth
Request Body schema: application/json
required
card_types
Array of strings (CardType) non-empty unique
Items Enum: "PHYSICAL" "VIRTUAL"
card_products
Array of strings non-empty unique
master_card_product
string <= 36 characters
activate_cards_upon_top_up
boolean
notification_provider
string (NotificationProvider)
Value: "FIREBASE"

Supported notification providers

Array of objects (CardCurrencyProduct)
object (NotificationSettings)
object (CardAutoCreationSettings)
Array of objects (CardAutoCreationSettings)
app_download_link
string
app_login_link
string
onboarding_token_expiry
integer <int32> >= 0
user_id_generation_required
boolean
object (UserIdGenerationSettings)
is_preferred_currency_enabled
boolean

Responses

Request samples

Content type
application/json
{
  • "card_types": [
    ],
  • "card_products": [
    ],
  • "master_card_product": "string",
  • "activate_cards_upon_top_up": true,
  • "notification_provider": "FIREBASE",
  • "card_currency_products": [
    ],
  • "notification_settings": {
    },
  • "child_auto_card_creation": {
    },
  • "parent_auto_card_creation": [
    ],
  • "app_download_link": "string",
  • "app_login_link": "string",
  • "onboarding_token_expiry": 0,
  • "user_id_generation_required": true,
  • "user_id_generation_settings": {
    },
  • "is_preferred_currency_enabled": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "tenant_id": "string",
  • "card_types": [
    ],
  • "card_products": [
    ],
  • "master_card_product": "string",
  • "activate_cards_upon_top_up": true,
  • "notification_provider": "FIREBASE",
  • "card_currency_products": [
    ],
  • "notification_settings": {
    },
  • "child_auto_card_creation": {
    },
  • "parent_auto_card_creation": [
    ],
  • "app_download_link": "string",
  • "app_login_link": "string",
  • "onboarding_token_expiry": 0,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "user_id_generation_required": true,
  • "user_id_generation_settings": {
    },
  • "is_preferred_currency_enabled": true
}

getSdkSettings

Authorizations:
oauth

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "tenant_id": "string",
  • "card_types": [
    ],
  • "card_products": [
    ],
  • "master_card_product": "string",
  • "activate_cards_upon_top_up": true,
  • "notification_provider": "FIREBASE",
  • "card_currency_products": [
    ],
  • "notification_settings": {
    },
  • "child_auto_card_creation": {
    },
  • "parent_auto_card_creation": [
    ],
  • "app_download_link": "string",
  • "app_login_link": "string",
  • "onboarding_token_expiry": 0,
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2018-01-02T19:42:32.987Z",
  • "user_id_generation_required": true,
  • "user_id_generation_settings": {
    },
  • "is_preferred_currency_enabled": true
}

nfront-transactions

upsertTransaction

Authorizations:
oauth
Request Body schema: application/json
required
id
string
parent_transaction_id
string
to_amount
number
from_amount
number
reversed_amount
number
to_currency
string
from_currency
string
reversed_currency
string
fee_amount
number
transaction_timestamp
string <date-time>
notes
string
sender_account_id
string
recipient_account_id
string
sender_name
string
sender_user_id
string
recipient_name
string
recipient_alias
string
recipient_nickname
string
recipient_mobile
string
recipient_user_id
string
load_type
string (NfrontLoadTransactionType)
Enum: "HOLD" "POST" "RELEASE" "COMPLETION"
type
string (NfrontTransactionType)
Enum: "FUNDS_TRANSFER" "BILL_PAYMENT" "CURRENCY_EXCHANGE" "LOAD" "LOAD_LEAN" "LOAD_CHECKOUT" "LOAD_CARDLESS" "UNLOAD" "UNLOAD_CARDLESS" "CASH_WITHDRAWAL" "ECOMMERCE" "PURCHASE" "REMITTANCES" "CASHBACK" "REVERSAL"
parent_transaction_type
string (NfrontTransactionType)
Enum: "FUNDS_TRANSFER" "BILL_PAYMENT" "CURRENCY_EXCHANGE" "LOAD" "LOAD_LEAN" "LOAD_CHECKOUT" "LOAD_CARDLESS" "UNLOAD" "UNLOAD_CARDLESS" "CASH_WITHDRAWAL" "ECOMMERCE" "PURCHASE" "REMITTANCES" "CASHBACK" "REVERSAL"
merchant_name
string
sku
string
sku_name
string
exchange_rate
number
payment_mode
string
sender_card_last4
string
recipient_card_last4
string
network_transaction_id
string
fee_currency
string
external_reference_number
string
sender_mobile
string
status_code
string
status_description
string
rrn
string
receiver_bank_name
string
receiver_bank_account
string
sender_iban
string
transaction_sources
Array of strings (NfrontTransactionSource)
Items Enum: "NFRONT" "NCORE"

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "parent_transaction_id": "string",
  • "to_amount": 0,
  • "from_amount": 0,
  • "reversed_amount": 0,
  • "to_currency": "string",
  • "from_currency": "string",
  • "reversed_currency": "string",
  • "fee_amount": 0,
  • "transaction_timestamp": "2018-01-02T19:42:32.987Z",
  • "notes": "string",
  • "sender_account_id": "string",
  • "recipient_account_id": "string",
  • "sender_name": "string",
  • "sender_user_id": "string",
  • "recipient_name": "string",
  • "recipient_alias": "string",
  • "recipient_nickname": "string",
  • "recipient_mobile": "string",
  • "recipient_user_id": "string",
  • "load_type": "HOLD",
  • "type": "FUNDS_TRANSFER",
  • "parent_transaction_type": "FUNDS_TRANSFER",
  • "merchant_name": "string",
  • "sku": "string",
  • "sku_name": "string",
  • "exchange_rate": 0,
  • "payment_mode": "string",
  • "sender_card_last4": "string",
  • "recipient_card_last4": "string",
  • "network_transaction_id": "string",
  • "fee_currency": "string",
  • "external_reference_number": "string",
  • "sender_mobile": "string",
  • "status_code": "string",
  • "status_description": "string",
  • "rrn": "string",
  • "receiver_bank_name": "string",
  • "receiver_bank_account": "string",
  • "sender_iban": "string",
  • "transaction_sources": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "parent_transaction_id": "string",
  • "to_amount": 0,
  • "from_amount": 0,
  • "reversed_amount": 0,
  • "to_currency": "string",
  • "from_currency": "string",
  • "reversed_currency": "string",
  • "fee_amount": 0,
  • "transaction_timestamp": "2018-01-02T19:42:32.987Z",
  • "notes": "string",
  • "sender_account_id": "string",
  • "recipient_account_id": "string",
  • "sender_name": "string",
  • "sender_user_id": "string",
  • "recipient_name": "string",
  • "recipient_alias": "string",
  • "recipient_nickname": "string",
  • "recipient_mobile": "string",
  • "recipient_user_id": "string",
  • "load_type": "HOLD",
  • "type": "FUNDS_TRANSFER",
  • "parent_transaction_type": "FUNDS_TRANSFER",
  • "merchant_name": "string",
  • "sku": "string",
  • "sku_name": "string",
  • "exchange_rate": 0,
  • "payment_mode": "string",
  • "sender_card_last4": "string",
  • "recipient_card_last4": "string",
  • "network_transaction_id": "string",
  • "fee_currency": "string",
  • "external_reference_number": "string",
  • "sender_mobile": "string",
  • "status_code": "string",
  • "status_description": "string",
  • "rrn": "string",
  • "receiver_bank_name": "string",
  • "receiver_bank_account": "string",
  • "sender_iban": "string",
  • "transaction_sources": [
    ]
}

Search for Nymcard Transactions instances

Authorizations:
oauth
Request Body schema: application/json
required
query
string

A search query.

sort_by
string

The way results should be sorted.

order_by
string (SortDirection)
Enum: "asc" "desc"

The way results should be ordered (ascending or descending).

matcher
string (SearchMatcher)
Enum: "and" "or"

Search matcher.

Array of objects (SearchFilter)

An array of search filters.

object (Cursors)

Cursors

limit
integer <int32>

Search limit.

Responses

Request samples

Content type
application/json
{
  • "query": "Transfer",
  • "sort_by": "By name",
  • "order_by": "asc",
  • "matcher": "and",
  • "filters": [
    ],
  • "cursors": {
    },
  • "limit": 0
}

Response samples

Content type
application/json;charset=UTF-8
Example
{
  • "paging": {
    },
  • "data": "AdminIndexCollection"
}

proxy-accounts-bulk

Upload account data for bulk processing based on template

Authorizations:
oauth
path Parameters
file_template_name
required
string
Request Body schema: multipart/form-data
required
file
required
string <binary>

The file to be uploaded, file format is limited by template (csv, json, xls).

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "string",
  • "file_name": "string",
  • "file_template_name": "string",
  • "status": "COMPLETED",
  • "status_reason_code": "P0",
  • "created": "2019-08-24T14:15:22Z",
  • "processed_on": "2019-08-24T14:15:22Z"
}

Retrieve uploaded file statuses for bulk account upload by template

Authorizations:
oauth
path Parameters
file_template_name
required
string
query Parameters
file_name
string
status
string
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Retrieve uploaded file statuses for bulk account upload

Authorizations:
oauth
query Parameters
file_name
string
status
string
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

Retrieve uploaded file data for bulk account upload

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d377441a-7621-4312-8354-bc2f27f3decf",
  • "file_name": "string",
  • "file_template_name": "string",
  • "status": "COMPLETED",
  • "status_reason_code": "P0",
  • "created": "2019-08-24T14:15:22Z",
  • "processed_on": "2019-08-24T14:15:22Z",
  • "content": [
    ]
}

Process bulk data according to file id that is uploaded

Authorizations:
oauth
Request Body schema: application/json
required
file_id
required
string

Unique id of the file that is being uploaded

record_ids
required
Array of strings

Responses

Request samples

Content type
application/json
{
  • "file_id": "string",
  • "record_ids": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d377441a-7621-4312-8354-bc2f27f3decf",
  • "file_id": "string",
  • "status": "SUCCESS",
  • "status_reason_code": "P0",
  • "processing_type": "LOAD_FUNDS",
  • "created": "2019-08-24T14:15:22Z",
  • "total_converted_amount": 0,
  • "total_amount_AED": 0,
  • "processed_items": [
    ]
}

Get bulk process info

Authorizations:
oauth
path Parameters
id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "d377441a-7621-4312-8354-bc2f27f3decf",
  • "file_id": "string",
  • "status": "SUCCESS",
  • "status_reason_code": "P0",
  • "processing_type": "LOAD_FUNDS",
  • "created": "2019-08-24T14:15:22Z",
  • "total_converted_amount": 0,
  • "total_amount_AED": 0,
  • "processed_items": [
    ]
}

proxy-remittance-beneficiary

Search beneficiary

Authorizations:
oauth
query Parameters
user_id
string
nickname
string
phone
string
category
string
category_display_name
string
subcategory
string
subcategory_display_name
string
instrument_type
string
instrument_currency
string
country
string
limit
integer <int32>

This is the maximum number of objects that may be returned. A query may return fewer than the value of limit once reached the end of the list of data.

after
string

This is the cursor that points to the end of the page of data that has been returned.

sort_by
string

Sort by field name.

order_by
string
Enum: "ASC" "DESC"

Order by.

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "after": "string",
  • "has_more": true,
  • "data": [
    ]
}

proxysdk-remittance

get all biller categories

Authorizations:
x-consumer-usernameoauth

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

get all service providers by category

Authorizations:
x-consumer-usernameoauth
path Parameters
category_code
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

get all services of specified service provider

Authorizations:
x-consumer-usernameoauth
path Parameters
service_provider_code
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

get fields of specified service

Authorizations:
x-consumer-usernameoauth
path Parameters
service_code
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
[
  • {
    }
]

biller service inquiry

Authorizations:
x-consumer-usernameoauth
path Parameters
service_code
required
string
Request Body schema: application/json
required
field_1
string
field_2
string
field_3
string
field_4
string
field_5
string
field_6
string
field_7
string
field_8
string
field_9
string
field_10
string
field_11
string
field_12
string
field_13
string
field_14
string
field_15
string
field_16
string
field_17
string
field_18
string
field_19
string
field_20
string
field_21
string
field_22
string
field_23
string
field_24
string
field_25
string
field_26
string
field_27
string
field_28
string
field_29
string
Array of objects (BillerServiceFieldKey)

Responses

Request samples

Content type
application/json
{
  • "field_1": "string",
  • "field_2": "string",
  • "field_3": "string",
  • "field_4": "string",
  • "field_5": "string",
  • "field_6": "string",
  • "field_7": "string",
  • "field_8": "string",
  • "field_9": "string",
  • "field_10": "string",
  • "field_11": "string",
  • "field_12": "string",
  • "field_13": "string",
  • "field_14": "string",
  • "field_15": "string",
  • "field_16": "string",
  • "field_17": "string",
  • "field_18": "string",
  • "field_19": "string",
  • "field_20": "string",
  • "field_21": "string",
  • "field_22": "string",
  • "field_23": "string",
  • "field_24": "string",
  • "field_25": "string",
  • "field_26": "string",
  • "field_27": "string",
  • "field_28": "string",
  • "field_29": "string",
  • "field_list": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "result_code": "string",
  • "result_message": "string",
  • "payload": {
    }
}

biller service payment

Authorizations:
x-consumer-usernameoauth
path Parameters
service_code
required
string
sender_account_id
required
string
header Parameters
x-nymos-idempotency-key
required
string <= 36 characters
otp_id
string

Return id of otp when challenged to provide sms or email code

otp_type
string

Selected type of otp if provided with choice

otp_email
string

Return code received over email along with otp_id

otp_sms
string

Return code received over sms along with otp_id

otp_auth
string

Return user autentication info

x-nfront-device-id
string
Request Body schema: application/json
required
field_1
required
string
field_2
required
number <decimal> > 0
field_3
required
string
field_4
string
field_5
string
field_6
string
field_7
string
field_8
string
field_9
string
field_10
string
field_11
string
field_12
string
field_13
string
field_14
string
field_15
string
field_16
string
field_17
string
field_18
string
field_19
string
field_20
string
field_21
string
field_22
string
field_23
string
field_24
string
field_25
string
field_26
string
field_27
string
field_28
string
field_29
string
Array of objects (BillerServiceFieldKey)

Responses

Request samples

Content type
application/json
{
  • "field_1": "string",
  • "field_2": 0,
  • "field_3": "string",
  • "field_4": "string",
  • "field_5": "string",
  • "field_6": "string",
  • "field_7": "string",
  • "field_8": "string",
  • "field_9": "string",
  • "field_10": "string",
  • "field_11": "string",
  • "field_12": "string",
  • "field_13": "string",
  • "field_14": "string",
  • "field_15": "string",
  • "field_16": "string",
  • "field_17": "string",
  • "field_18": "string",
  • "field_19": "string",
  • "field_20": "string",
  • "field_21": "string",
  • "field_22": "string",
  • "field_23": "string",
  • "field_24": "string",
  • "field_25": "string",
  • "field_26": "string",
  • "field_27": "string",
  • "field_28": "string",
  • "field_29": "string",
  • "field_list": [
    ]
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "result_code": 0,
  • "result_message": "string",
  • "payload": {
    },
  • "reference_number": "string"
}