nFront API catalog (1.0.0)

In this catalog you can find all nFront APIs. In case you need some nCore APIs, here is a link to our regular API catalog https://nymcard.com/docs/api.

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"
}

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

Payload

Content type

application/json

{"notification_email": "example@gmail.com",
"identification": {"type": "EMAIL",
"value": "2"
}
}

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

Payload

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": {"type": "EMAIL",
"value": "2"
}
}

Response samples

Content type

application/json;charset=UTF-8

{"id": "d0cd4a54-39af-49c6-9d55-c8112a613a8a",
"user": {"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"
},
"flow": "initialization",
"access_token": {"token": "309630946034960",
"refresh_token": "308645409860587",
"expires_in": 120,
"refresh_expires_in": 900,
"scopes": ["m:users"
]
},
"trusted_device": true,
"available_auth_methods": [{"type": "PASSWORD",
"expires_at": "2012-05-04T19:42:32.987Z"
}
]
}

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

Payload

Content type

application/json

{"username": "John",
"identification": {"type": "EMAIL",
"value": "2"
}
}

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

Payload

Content type

application/json

{"username": "John",
"password": "12345",
"passcode": "3453",
"otp_id": "39573047680-486",
"identification": {"type": "EMAIL",
"value": "2"
}
}

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

[{"id": "5e18bf36-9356-4437-a11f-b2e425556096",
"type": "PASSWORD",
"name": "Policy 1",
"description": "Some info",
"is_active": true,
"is_default": false,
"rules": [{"name": "Rule1",
"description": "Some  info",
"regex": "^([0-9]{4,4})$"
}
],
"settings": {"password_expiration_days": 30,
"password_reuse_restriction_number": 5,
"invalid_login_attempts_number": 3,
"invalid_login_attempts_lock_minutes": 5,
"min_length": 8,
"max_length": 30
}
}
]

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

Payload

Content type

application/json

{"identification": {"type": "EMAIL",
"value": "2"
},
"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": {"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"
},
"flow": "initialization",
"access_token": {"token": "309630946034960",
"refresh_token": "308645409860587",
"expires_in": 120,
"refresh_expires_in": 900,
"scopes": ["m:users"
]
},
"trusted_device": true,
"available_auth_methods": [{"type": "PASSWORD",
"expires_at": "2012-05-04T19:42:32.987Z"
}
]
}

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

Payload

Content type

application/json

{"username": "John",
"identification": {"type": "EMAIL",
"value": "2"
}
}

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

Payload

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": {"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"
},
"flow": "initialization",
"access_token": {"token": "309630946034960",
"refresh_token": "308645409860587",
"expires_in": 120,
"refresh_expires_in": 900,
"scopes": ["m:users"
]
},
"trusted_device": true,
"available_auth_methods": [{"type": "PASSWORD",
"expires_at": "2012-05-04T19:42:32.987Z"
}
]
}

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": ["m:users"
]
}

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

Payload

Content type

application/json

{"identification": {"type": "EMAIL",
"value": "2"
},
"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

Payload

Content type

application/json

{"query": "Transfer",
"sort_by": "By name",
"order_by": "asc",
"matcher": "and",
"filters": [{"field": "ID",
"operator": "any_of",
"values": ["21"
]
}
],
"cursors": {"after": "John Smith",
"has_more": true
},
"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": [{"fee_id": "ed2e2ddb-c028-470d-b08b-7f28bd84fbfe",
"description": "Some description",
"amount": "100.01",
"currency": "USD"
}
],
"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": [{"debit_from_currency": "USD",
"debit_from_amount": "100.01",
"credit_to_currency": "USD",
"credit_to_amount": "100.01",
"exchange_rate": "100.01"
}
],
"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": [{"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": {"USD": 125.58,
"EUR": 400.2
},
"ledger_balances": {"USD": 125.58,
"EUR": 400.2
},
"status": "ACTIVE",
"currencies": ["USD"
],
"wallet_details": [{"currency": "USD",
"priority": 0,
"status": "ACTIVE",
"allowed_load_type": "LOAD"
}
],
"created": "2012-05-04T19:42:32.987Z",
"modified": "2012-05-04T19:42:32.987Z",
"modified_by": "API"
}
]
}

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

Payload

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": ["USD"
]
}

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": {"USD": 125.58,
"EUR": 400.2
},
"ledger_balances": {"USD": 125.58,
"EUR": 400.2
},
"status": "ACTIVE",
"currencies": ["USD"
],
"wallet_details": [{"currency": "USD",
"priority": 0,
"status": "ACTIVE",
"allowed_load_type": "LOAD"
}
],
"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

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": {"USD": 125.58,
"EUR": 400.2
},
"ledger_balances": {"USD": 125.58,
"EUR": 400.2
},
"status": "ACTIVE",
"currencies": ["USD"
],
"wallet_details": [{"currency": "USD",
"priority": 0,
"status": "ACTIVE",
"allowed_load_type": "LOAD"
}
],
"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

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

Payload

Content type

application/json

{"wallet_details": [{"currency": "USD",
"priority": 0,
"status": "ACTIVE",
"allowed_load_type": "LOAD"
}
]
}

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": {"USD": 125.58,
"EUR": 400.2
},
"ledger_balances": {"USD": 125.58,
"EUR": 400.2
},
"status": "ACTIVE",
"currencies": ["USD"
],
"wallet_details": [{"currency": "USD",
"priority": 0,
"status": "ACTIVE",
"allowed_load_type": "LOAD"
}
],
"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

Payload

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": [{"fee_id": "ed2e2ddb-c028-470d-b08b-7f28bd84fbfe",
"description": "Some description",
"amount": "100.01",
"currency": "USD"
}
],
"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": [{"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": [{"fee_id": "ed2e2ddb-c028-470d-b08b-7f28bd84fbfe",
"description": "Some description",
"amount": "100.01",
"currency": "USD"
}
],
"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 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": [{"ledger_balance": 90.95,
"available_balance": 99.95,
"total_credits": 19.95,
"currency": "USD"
}
]
}

Get cards related to account

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

Authorizations:

oauth

path Parameters

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

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

Payload

Content type

application/json

{"ids": ["card327"
],
"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

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

Payload

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

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

Payload

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

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": [{"supported_currency": "EUR",
"settlement_currency": "EUR",
"priority": 1,
"status": "INACTIVE",
"allow_loads": true,
"allow_unloads": true,
"allow_scheme_debit_txn": true,
"allow_scheme_credit_txn": true,
"allow_incoming_transfer": true,
"allow_outgoing_transfer": true,
"allow_incoming_sweeps": true,
"allow_outgoing_sweeps": true,
"allow_initial_load": false
}
],
"card_settings": {"bin": "450002",
"pan_length": 16,
"pan_range": [{"start_range": 111111111,
"end_range": 999999999
}
],
"card_validity_term": 36,
"service_code": "201",
"allow_new_card_creation": true,
"num_of_physical_cards_per_user": 5,
"num_of_virtual_cards_per_user": 5,
"initial_status_of_physical_card": "INACTIVE",
"initial_status_of_virtual_card": "INACTIVE",
"generate_proxy_number": false,
"create_account_with_card": true,
"design_code": "CD_01",
"soft_expiry_period": 1,
"virtual_to_physical_expiry_duration": 3,
"soft_expiry_update_allowed": false,
"soft_expiry_setting": {"count": 5,
"grace_period": 30
}
},
"credit_settings": {"statement_on": 25,
"statement_cycle": "MONTHLY",
"grace_period": 1,
"late_payment_grace_period": 1,
"limit_late_payment_to": "REMAINING_MINIMUM_PAYMENT",
"delinquency_grace_period": 1,
"delinquency_start_after": "DUE_DATE",
"allow_account_level_definition": false,
"allow_additional_card": false,
"payment_due_on": 2,
"first_minimum_topup": 1,
"notification_send_before": 1,
"security_amount": {"type": "FLAT",
"value": 1
},
"delinquency": [{"cycle_due_date_passed": 1,
"charge_type": "FLAT",
"charge_value": 2,
"card_status": "SUSPENDED",
"card_status_reason": "S2"
}
],
"payment_settings": {"payment_transaction_types": ["WALLET_CREDIT"
],
"payment_distribution_order": "TRANSACTION_TYPE",
"transaction_type_priority": ["FEES_AND_CHARGES"
]
},
"minimum_payment_settings": {"minimum_payment_calculation_method": "PERCENTAGE_OF_STATEMENT_BALANCE",
"percentage": 1,
"minimum_payment_threshold": 0
}
},
"account_settings": {"link_account_to_card": true,
"num_of_cards_per_account": 1
},
"pin_settings": {"pin_type": "ONLINE_PIN_ONLY",
"pin_length": 4,
"pin_retries": 3
},
"auth_settings": {"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": false,
"allow_account_verification_without_CVV": false,
"allow_quasi_cash": false,
"allow_scheme_account_funding": false,
"allow_scheme_credits": false,
"allow_contactless": true,
"auth_aging": 10,
"atc_threshold": "FF",
"allowed_mccs_id": "a8180db3-b2e9-4ae0-93cd-2a0b52a99737",
"allowed_countries_id": "8358c501-56a3-43b0-b2b3-a2c49f3c33ab",
"allow_atm_deposit": true,
"allow_cash_in": true,
"allow_cash_out": true,
"allow_initial_load": false
},
"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": {"initial_num_of_wallets_offered": 0,
"maximum_active_wallets_allowed": 0,
"maximum_wallets_allowed_in_sweep": 0
},
"fxrates_settings": [{"transaction_type": "TRANSFERS",
"rate_group_id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6"
}
]
}

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

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

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

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": [{"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"
}
]
}

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": [{"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": {"method": "COURIER",
"return_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
},
"shipping_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
}
},
"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": {"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"
},
"is_account_linked": true,
"delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
"change_to_physical": true
}
]
}

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

Payload

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": {"method": "COURIER",
"return_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
},
"shipping_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
}
},
"dry_run": false,
"card_validity_term": 36,
"extra_embossing_line": "CLASSIC",
"credit_settings": {"statement_on": 25,
"grace_period": 25,
"late_payment_grace_period": 3,
"delinquency_grace_period": 3
},
"credit_limits": {"assigned_credit_limit": 50,
"cash_adv_limit_type": "PERCENTAGE",
"cash_adv_limit_value": 50
},
"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": {"method": "COURIER",
"return_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
},
"shipping_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
}
},
"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": {"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"
},
"is_account_linked": true,
"delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
"change_to_physical": true
}

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

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": {"method": "COURIER",
"return_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
},
"shipping_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
}
},
"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": {"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"
},
"is_account_linked": true,
"delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
"change_to_physical": true
}

Get accounts related to card

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

Authorizations:

oauth

path Parameters

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

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

Payload

Content type

application/json

{"status": "INACTIVE",
"status_reason_code": "A0",
"note": {"title": "Reason of termination",
"category": "Stolen",
"description": "This card is terminated because of being stolen.",
"extras": {"property1": "Hotel Z",
"property2": "Hotel Z"
}
},
"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": {"method": "COURIER",
"return_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
},
"shipping_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
}
},
"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": {"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"
},
"is_account_linked": true,
"delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
"change_to_physical": true
}

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

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

Payload

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

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

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

Payload

Content type

application/json

{"ids": ["velocitylimit02"
]
}

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

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

Payload

Content type

application/json

{"ids": ["velocitylimit02"
]
}

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

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": [{"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": ["WITHDRAWALS"
],
"channel_scope": "VISA",
"program_level": true,
"created": "2018-01-02T19:42:32.987Z",
"modified": "2012-05-04T19:42:32.987Z",
"linked_to": "CARD",
"product_limit": {"id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
"max_limit": 300,
"min_limit": 200,
"frequency": 0
}
}
],
"balance_limits": [{"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",
"linked_to": "CARD",
"product_limit": {"id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
"max_limit": 1500,
"min_limit": 1500
}
}
],
"advanced_velocity_limits": [{"id": "4b4eabfc-f839-4e51-9dc1-3dc25c5eddd6",
"name": "limit1",
"type": "PER_CARD",
"description": "Some description",
"currency": "EUR",
"transaction_scope": ["WITHDRAWALS"
],
"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": [{"type": "MCC",
"values": ["4511"
],
"active": true
}
],
"created": "2018-01-02T19:42:32.987Z",
"modified": "2012-05-04T19:42:32.987Z",
"group": "SINGLE",
"linked_to": "CARD",
"product_limit": {"id": "d089a80f-e641-4045-8a80-54841e4a7458",
"amount": 1500,
"frequency": 0
}
}
]
}

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

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": {"method": "COURIER",
"return_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
},
"shipping_address": {"first_name": "John",
"middle_name": "Anthony",
"last_name": "Smith",
"mobile": "+551185249635",
"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"country": "USA",
"postal_code": "12345"
}
},
"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": {"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"
},
"is_account_linked": true,
"delivery_charge_id": "d089a80f-e641-4045-5680-54841e4a7458",
"change_to_physical": true,
"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

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

Payload

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": ["WITHDRAWALS"
],
"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

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

Payload

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": ["WITHDRAWALS"
],
"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

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

Payload

Content type

application/json

{"active": true,
"per_transaction": {"min_amount": 1500.1,
"max_amount": 1500.1
},
"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": ["WITHDRAWALS"
],
"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": [{"type": "MCC",
"values": ["4511"
],
"active": true
}
],
"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

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

Payload

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": ["WITHDRAWALS"
],
"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": [{"type": "MCC",
"values": ["4511"
],
"active": true
}
],
"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

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

Payload

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

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": [{"force_update": true,
"from_currency": "USD",
"to_currency": "USD",
"fx_rate": "1234567890.1234567890",
"created": "2012-05-04T19:42:32.987Z",
"modified": "2012-05-04T19:42:32.987Z"
}
]
}

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": [{"from": "USD",
"to": "USD",
"exchange_rate_id": "g189a80f-e641-4045-8a80-54841e4a1234",
"exchange_rate_ids": ["g567a80f-e641-4045-8a80-54841e4a1774"
],
"exchange_rate": "1234567890.1234567890",
"quote_id": "g189a80f-e641-4045-8a80-54841e4a1234"
}
],
"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

Payload

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

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

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": [{"fee_id": "ed2e2ddb-c028-470d-b08b-7f28bd84fbfe",
"description": "Some description",
"amount": "5",
"currency": "USD"
}
],
"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

Payload

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

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

Payload

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": ["WITHDRAWALS"
],
"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": ["WITHDRAWALS"
],
"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

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": ["WITHDRAWALS"
],
"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

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

Payload

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": ["WITHDRAWALS"
],
"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": ["WITHDRAWALS"
],
"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": [{"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"
}
]
}

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

Payload

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": [{"is_read": false,
"push_id": "2b1f3e28-600b-4107-a7f5-7416d57bc42c-received",
"account_id": "d1c1fb67-c530-46cd-9c61-f12b077b553b",
"type": "transaction_wallet_transfer_received",
"title": "Fund Transfer",
"text": "You have received 20.00 AED from Shaheena Rani",
"language": "EN",
"payload": "eyJpZCI6I...Il19",
"created": "2012-05-04T19:42:32.987Z"
}
]
}

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

Payload

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

Payload

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": {"success": "https://example.com/",
"failure": "https://example.com/"
}
}

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

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": [{"id": "src_3ufzpcd64m5ufa5auvg3ruxsau",
"scheme": "VISA",
"card_type": "CREDIT",
"card": "454347******9996"
}
]
}

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

[{"id": "501867d5-eff0-4787-b58d-ff422b5fae7f",
"customer_id": "4a41deb5-04d9-4a0a-bd19-95807a2077f8",
"app_id": "b7ae2c36-3af8-4b40-8e18-1e561f4e6296",
"bank_identifier": "LEANMB1_SAU",
"status": "ACTIVE",
"beneficiary_cool_off_expiry": "2012-05-04T19:42:32.987Z",
"bank": {"connection_identifier": "LEANMB1_SAU",
"traits": ["user-input-on-login"
],
"country_code": "SAU",
"identifier": "LEANMB1_SAU",
"name": "Lean Mockbank",
"arabic_name": "Lean Mockbank",
"logo": "https://cdn.leantech.me/img/banks/white-gmockbank1.png",
"logo_alt": "https://cdn.leantech.me/img/banks/color-gmockbank1.png",
"main_color": "#1beb75",
"background_color": "#ffffff",
"theme": "dark",
"active": true,
"mock": true,
"bank_type": "RETAIL",
"supported_account_types": ["SAVINGS"
],
"transfer_limits": [{"currency": "GBP",
"min": 40,
"max": 240
}
],
"international_transfer_limits": [{"currency": "GBP",
"min": 40,
"max": 240
}
],
"international_destinations": [{"country_iso_code": "USA",
"country_name": "United States of America",
"supported_currencies": ["USD"
]
}
],
"account_type": "PERSONAL",
"supported_account_sub_types": ["CURRENT"
]
},
"accounts": [{"id": "af504ee5-3c10-4482-9a38-cc2788dc8282",
"account_id": "b29d60b0-27eb-4ab4-98c2-25d8fdc4ca77",
"account_name": "Credit Accoun",
"account_number": "116073424495131",
"iban": "AE550398116073424495131",
"currency": "AED"
}
],
"beneficiaries": [{"id": "c0767ff3-a33c-4e1a-af84-4c54f41790a1",
"payment_destination_id": "2e7a8e82-b3b8-48e8-b47d-2b266ed2191e",
"status": "ACTIVE",
"beneficiary_cool_off_expiry": "2024-10-23T14:00:13.079Z"
}
]
}
]

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

Payload

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": [{"id": "4a41deb5-04d9-4a0a-bd19-95807a2077f8",
"payment_intent_id": "1b3e3362-9205-458f-879e-aa550ce7659e",
"payment_source_id": "789e3362-9205-458f-879e-aa550ce7679e",
"sender_details": {"account_number": "1008223921001",
"iban": "AE260260001008223921001",
"name": "Acme Inc",
"description": "Some info",
"bank_transaction_description": "Transaction confirmed"
},
"recipient_details": {"account_number": "6008236921001",
"iban": "AE260260006008236921001",
"name": "Example Inc"
},
"amount": 100,
"currency": "USD",
"description": "Some info",
"reference": "94679",
"submission_timestamp": "2018-01-02T19:42:32.987Z",
"initiation_timestamp": "2018-01-02T19:42:32.987Z",
"status": "Done",
"granular_status_code": "01",
"status_additional_details": "Some info",
"display_info": "Display info",
"bank_transaction_reference": "45"
}
],
"payment_destination": {"id": "2e7a8e82-b3b8-48e8-b47d-2b266ed2191e",
"bank_identifier": "ENBD_UAE",
"name": "Acme Inc",
"iban": "AE260260001008223921001",
"display_name": "Acme USD Account",
"account_number": "1008223921001",
"swift_code": "EBILAEAD",
"status": "CONFIRMED",
"address": "123 Fake St",
"country": "ARE",
"city": "Dubai",
"default": false,
"owner_type": "APPLICATION",
"ifsc": "0980",
"sort_code": "02",
"routing_number": "897897",
"transit_code": "03",
"branch_address": "Oak street",
"currency_iso_code": "USD",
"postal_code": "79000"
},
"fee_amount": 2.5,
"fee_details": [{"fee_id": "ed2e2ddb-c028-470d-b08b-7f28bd84fbfe",
"description": "Some description",
"amount": 20,
"currency": "USD"
}
],
"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

Payload

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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": ["director_id1"
],
"signature_list": ["signature_id1"
],
"shareholder_list": ["shareholder_id1"
],
"company_onbehalf": true,
"company_onbehalf_relation": "John Smith",
"group_additional_info": {"group_entity": true,
"independent_entity": true,
"special_investment": true,
"entity_details": "Nexxo LLC"
},
"pep_check_info": {"pri_pep_check": true,
"pri_pep_check_name": "John Smith",
"sec_pep_check": true,
"sec_pep_check_name": "Adam Smith"
},
"no_of_employees": 25,
"accept_cash_check": true,
"annual_turnover": 0,
"source_of_funds": "Business",
"source_fund_uae": true,
"due_diligence_declaration": {"bankruptcy_declaration": true,
"disciplinary_declaration": true,
"fraud_aml_declaration": true,
"disqualification_declaration": true,
"conviction_accusition_declaration": true,
"breach_of_law_declaration": true
},
"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": {"property1": "string",
"property2": "string"
}
}

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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": ["director_id1"
],
"signature_list": ["signature_id1"
],
"shareholder_list": ["shareholder_id1"
],
"company_onbehalf": true,
"company_onbehalf_relation": "John Smith",
"group_additional_info": {"group_entity": true,
"independent_entity": true,
"special_investment": true,
"entity_details": "Nexxo LLC"
},
"pep_check_info": {"pri_pep_check": true,
"pri_pep_check_name": "John Smith",
"sec_pep_check": true,
"sec_pep_check_name": "Adam Smith"
},
"no_of_employees": 25,
"accept_cash_check": true,
"annual_turnover": 0,
"source_of_funds": "Business",
"source_fund_uae": true,
"due_diligence_declaration": {"bankruptcy_declaration": true,
"disciplinary_declaration": true,
"fraud_aml_declaration": true,
"disqualification_declaration": true,
"conviction_accusition_declaration": true,
"breach_of_law_declaration": true
},
"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": {"property1": "string",
"property2": "string"
}
}

Get user details

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

Authorizations:

oauth

path Parameters

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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": ["director_id1"
],
"signature_list": ["signature_id1"
],
"shareholder_list": ["shareholder_id1"
],
"company_onbehalf": true,
"company_onbehalf_relation": "John Smith",
"group_additional_info": {"group_entity": true,
"independent_entity": true,
"special_investment": true,
"entity_details": "Nexxo LLC"
},
"pep_check_info": {"pri_pep_check": true,
"pri_pep_check_name": "John Smith",
"sec_pep_check": true,
"sec_pep_check_name": "Adam Smith"
},
"no_of_employees": 25,
"accept_cash_check": true,
"annual_turnover": 0,
"source_of_funds": "Business",
"source_fund_uae": true,
"due_diligence_declaration": {"bankruptcy_declaration": true,
"disciplinary_declaration": true,
"fraud_aml_declaration": true,
"disqualification_declaration": true,
"conviction_accusition_declaration": true,
"breach_of_law_declaration": true
},
"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": {"property1": "string",
"property2": "string"
}
}

Update specific user

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

Authorizations:

oauth

path Parameters

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

Payload

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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": ["director_id1"
],
"signature_list": ["signature_id1"
],
"shareholder_list": ["shareholder_id1"
],
"company_onbehalf": true,
"company_onbehalf_relation": "John Smith",
"group_additional_info": {"group_entity": true,
"independent_entity": true,
"special_investment": true,
"entity_details": "Nexxo LLC"
},
"pep_check_info": {"pri_pep_check": true,
"pri_pep_check_name": "John Smith",
"sec_pep_check": true,
"sec_pep_check_name": "Adam Smith"
},
"no_of_employees": 25,
"accept_cash_check": true,
"annual_turnover": 0,
"source_of_funds": "Business",
"source_fund_uae": true,
"due_diligence_declaration": {"bankruptcy_declaration": true,
"disciplinary_declaration": true,
"fraud_aml_declaration": true,
"disqualification_declaration": true,
"conviction_accusition_declaration": true,
"breach_of_law_declaration": true
},
"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": {"property1": "string",
"property2": "string"
}
}

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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": ["director_id1"
],
"signature_list": ["signature_id1"
],
"shareholder_list": ["shareholder_id1"
],
"company_onbehalf": true,
"company_onbehalf_relation": "John Smith",
"group_additional_info": {"group_entity": true,
"independent_entity": true,
"special_investment": true,
"entity_details": "Nexxo LLC"
},
"pep_check_info": {"pri_pep_check": true,
"pri_pep_check_name": "John Smith",
"sec_pep_check": true,
"sec_pep_check_name": "Adam Smith"
},
"no_of_employees": 25,
"accept_cash_check": true,
"annual_turnover": 0,
"source_of_funds": "Business",
"source_fund_uae": true,
"due_diligence_declaration": {"bankruptcy_declaration": true,
"disciplinary_declaration": true,
"fraud_aml_declaration": true,
"disqualification_declaration": true,
"conviction_accusition_declaration": true,
"breach_of_law_declaration": true
},
"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": {"property1": "string",
"property2": "string"
}
}

Change user status

This API is used to change user status.

Authorizations:

oauth

path Parameters

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

Payload

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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": ["director_id1"
],
"signature_list": ["signature_id1"
],
"shareholder_list": ["shareholder_id1"
],
"company_onbehalf": true,
"company_onbehalf_relation": "John Smith",
"group_additional_info": {"group_entity": true,
"independent_entity": true,
"special_investment": true,
"entity_details": "Nexxo LLC"
},
"pep_check_info": {"pri_pep_check": true,
"pri_pep_check_name": "John Smith",
"sec_pep_check": true,
"sec_pep_check_name": "Adam Smith"
},
"no_of_employees": 25,
"accept_cash_check": true,
"annual_turnover": 0,
"source_of_funds": "Business",
"source_fund_uae": true,
"due_diligence_declaration": {"bankruptcy_declaration": true,
"disciplinary_declaration": true,
"fraud_aml_declaration": true,
"disqualification_declaration": true,
"conviction_accusition_declaration": true,
"breach_of_law_declaration": true
},
"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": {"property1": "string",
"property2": "string"
}
}

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

Payload

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

Payload

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

Payload

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

Payload

Content type

application/json

{"name": "John",
"mobile": "+559999999995",
"email": "johndoe@example.com",
"status": ["ACTIVE"
],
"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": [{"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": {"address_line1": "Flat 1904",
"address_line2": "Glass Tower",
"city": "New York City",
"state": "New York",
"postal_code": "12345",
"country": "USA",
"province": "Dakota",
"district": "Bronx",
"street": "Ivy lane",
"building": "12",
"nearest_place": "Burj Khalifa"
},
"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": ["director_id1"
],
"signature_list": ["signature_id1"
],
"shareholder_list": ["shareholder_id1"
],
"company_onbehalf": true,
"company_onbehalf_relation": "John Smith",
"group_additional_info": {"group_entity": true,
"independent_entity": true,
"special_investment": true,
"entity_details": "Nexxo LLC"
},
"pep_check_info": {"pri_pep_check": true,
"pri_pep_check_name": "John Smith",
"sec_pep_check": true,
"sec_pep_check_name": "Adam Smith"
},
"no_of_employees": 25,
"accept_cash_check": true,
"annual_turnover": 0,
"source_of_funds": "Business",
"source_fund_uae": true,
"due_diligence_declaration": {"bankruptcy_declaration": true,
"disciplinary_declaration": true,
"fraud_aml_declaration": true,
"disqualification_declaration": true,
"conviction_accusition_declaration": true,
"breach_of_law_declaration": true
},
"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": {"property1": "string",
"property2": "string"
}
}
]
}

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

[{"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": [{"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"
}
],
"created": "2012-05-04T19:42:32.987Z",
"modified": "2012-05-04T19:42:32.987Z",
"identification_note": "Some note"
}
]

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

Payload

Content type

application/json

{"sender": {"card_id": "4b4eabfc-f839-4e51-9dc1-3dc25c3eddd6",
"initiation_id": "4b4dd6",
"otp_code": "476688",
"name": "John",
"address": "New York",
"phone_mobile": "94537497",
"country_code": "USA",
"state_id": "497",
"city_id": "47",
"type_of_id": "PASSPORT",
"id_number": "4957349679797",
"id_expiry_date": "2018-01-02T19:42:32.987Z",
"date_of_birth": "1988-01-02T19:42:32.987Z",
"nationality_code": "IN",
"is_individual": true
},
"receiver": {"first_name": "David",
"last_name": "Monk",
"address": "Paris",
"mobile_phone": "0562315682",
"country_iso_code": "USA",
"nationality_iso_code": "IN",
"is_individual": true,
"state_id": "58",
"city_id": "KR",
"email": "abc@nymcard.com",
"receiver_type_id": 8,
"id_relationship_with_sender": 2,
"cpf": "12312312322"
},
"transaction_info": {"source_currency_iso_code": "PLN",
"sent_amount": 250,
"fee_amount": 2,
"payment_mode_id": "564",
"receive_currency_iso_code": "USD",
"purpose_of_remittance_id": "777",
"form_of_payment_id": "ACH",
"bank_id": "777772424",
"bank_branch_id": "3085048",
"account": "8465864",
"payer_id": "KS01",
"paying_branch_id": "KS01000088",
"account_type_id": "C"
},
"compliance": {"country_issue_iso_code": "UAE",
"source_of_funds": "Salary",
"receiver_full_name": "John Smith"
}
}

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": {"sender_id": "10794159",
"name": "MOHAMMED FAIZAL",
"account_number": "75757577897",
"address": "THE GARDENS",
"phone_mobile": "0503848530",
"phone_home": "0979079557",
"phone_work": "26352745273",
"is_individual": true,
"country_iso_code": "AE",
"country_name": "UNITED ARAB EMIRATES",
"state_id": "UAE",
"city_name": "DUBAI",
"city_id": 90047,
"type_of_id": "EI",
"id_number": "198006372612356",
"id_expiry_date": "2023-06-24T00:00:00.000-04:00",
"date_of_birth": "1989-06-01T00:00:00.000-04:00",
"email": "example@gmail.com",
"nationality_iso_code": "IN",
"sender_occupation": "Accountant"
},
"Receiver": {"full_name": "SAYUJ SATHYAN",
"full_name_other_language": "SAYUJ SATHYAN",
"first_name": "SAYUJ",
"first_name_other_language": "SAYUJ",
"second_name": "SATHYAN",
"second_name_other_language": "SATHYAN",
"last_name": "Khan",
"last_name_other_language": "Khan",
"second_last_name": "Kin",
"second_last_name_other_language": "Kin",
"complete_address": "CASH PICK-UP AT THOUSANDS OF PARTNER LOCATIONS",
"complete_address_other_language": "CASH PICK-UP AT THOUSANDS OF PARTNER LOCATIONS",
"date_of_birth": "1988-06-01T00:00:00.000-04:00",
"mobile_phone": "0562315682",
"home_phone": "8968769054",
"work_phone": "9235830975",
"is_individual": true,
"country_iso_code": "IN",
"country_name": "INDIA",
"state_name": "KERALA",
"state_id": "IN013",
"city_name": "ERNAKULAM",
"city_id": 48932,
"town_name": "Bay",
"town_id": 4857,
"notes": "Some notes",
"receiver_id_number": "385683",
"receiver_type_id": 142,
"email": "alice@abc.com",
"cpf": "12312312311",
"receiver_id": "12312312311",
"id_relationship_with_sender": 1
},
"TransactionInfo": {"payment_mode_id": "2",
"payment_mode_name": "CASH PICK UP",
"receive_currency_iso_code": "INR",
"purpose_of_remittance_id": 1,
"bank_id": "375638675",
"bank_name": "ING",
"bank_branch_id": "45",
"account": "203583098535",
"payer_name": "TRANSFAST CASH PICKUP ANYWHERE",
"payer_id": "ID99",
"paying_branch_id": "ID99000001",
"paying_branch_name": "TRANSFAST CASH PICKUP ANYWHERE",
"source_currency_name": "USD",
"source_currency_iso_code": "USD",
"rate": 73.03,
"total_sent_amount": 70.965,
"service_fee": 2.5,
"form_of_payment_id": "CA",
"form_of_payment_name": "CASH",
"payout": 5000,
"sent_amount": 68.465,
"receive_amount": 5000,
"payer_branch_adress": "CASH PICK-UP AT THOUSANDS OF PARTNER LOCATIONS",
"payer_branch_phone1": "845398465",
"payer_branch_phone2": "507850687",
"reference_number": "AB21281064007141",
"source_of_funds": "Salary",
"backend_fee": 0,
"invoice_status_time_stamps": [{"receiver_id": "8",
"cashier": "WB020005XB",
"change_status_date": "2023-07-07T06:41:29.850-04:00",
"flag_id": "R",
"flag_name": "PENDING RELEASE"
}
]
}
}

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": {"sender_id": "10794159",
"name": "MOHAMMED FAIZAL",
"account_number": "75757577897",
"address": "THE GARDENS",
"phone_mobile": "0503848530",
"phone_home": "0979079557",
"phone_work": "26352745273",
"is_individual": true,
"country_iso_code": "AE",
"country_name": "UNITED ARAB EMIRATES",
"state_id": "UAE",
"city_name": "DUBAI",
"city_id": 90047,
"type_of_id": "EI",
"id_number": "198006372612356",
"id_expiry_date": "2023-06-24T00:00:00.000-04:00",
"date_of_birth": "1989-06-01T00:00:00.000-04:00",
"email": "example@gmail.com",
"nationality_iso_code": "IN",
"sender_occupation": "Accountant"
},
"receiver": {"full_name": "SAYUJ SATHYAN",
"full_name_other_language": "SAYUJ SATHYAN",
"first_name": "SAYUJ",
"first_name_other_language": "SAYUJ",
"second_name": "SATHYAN",
"second_name_other_language": "SATHYAN",
"last_name": "Khan",
"last_name_other_language": "Khan",
"second_last_name": "Kin",
"second_last_name_other_language": "Kin",
"complete_address": "CASH PICK-UP AT THOUSANDS OF PARTNER LOCATIONS",
"complete_address_other_language": "CASH PICK-UP AT THOUSANDS OF PARTNER LOCATIONS",
"date_of_birth": "1988-06-01T00:00:00.000-04:00",
"mobile_phone": "0562315682",
"home_phone": "8968769054",
"work_phone": "9235830975",
"is_individual": true,
"country_iso_code": "IN",
"country_name": "INDIA",
"state_name": "KERALA",
"state_id": "IN013",
"city_name": "ERNAKULAM",
"city_id": 48932,
"town_name": "Bay",
"town_id": 4857,
"notes": "Some notes",
"receiver_id_number": "385683",
"receiver_type_id": 142,
"email": "alice@abc.com",
"cpf": "12312312311",
"receiver_id": "12312312311",
"id_relationship_with_sender": 1
},
"transaction_info": {"payment_mode_id": "2",
"payment_mode_name": "CASH PICK UP",
"receive_currency_iso_code": "INR",
"purpose_of_remittance_id": 1,
"bank_id": "375638675",
"bank_name": "ING",
"bank_branch_id": "45",
"account": "203583098535",
"payer_name": "TRANSFAST CASH PICKUP ANYWHERE",
"payer_id": "ID99",
"paying_branch_id": "ID99000001",
"paying_branch_name": "TRANSFAST CASH PICKUP ANYWHERE",
"source_currency_name": "USD",
"source_currency_iso_code": "USD",
"rate": 73.03,
"total_sent_amount": 70.965,
"service_fee": 2.5,
"form_of_payment_id": "CA",
"form_of_payment_name": "CASH",
"payout": 5000,
"sent_amount": 68.465,
"receive_amount": 5000,
"payer_branch_adress": "CASH PICK-UP AT THOUSANDS OF PARTNER LOCATIONS",
"payer_branch_phone1": "845398465",
"payer_branch_phone2": "507850687",
"reference_number": "AB21281064007141",
"source_of_funds": "Salary",
"backend_fee": 0,
"invoice_status_time_stamps": [{"receiver_id": "8",
"cashier": "WB020005XB",
"change_status_date": "2023-07-07T06:41:29.850-04:00",
"flag_id": "R",
"flag_name": "PENDING RELEASE"
}
]
},
"compliance": {"accumulation": 0,
"is_ssn_required": false,
"is_second_id_required": false,
"source_of_funds_required": false
}
}

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": [{"name": "ALBANIA",
"country_code": "AL"
}
]
}

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": "AL",
"name": "ALABAMA"
}
],
"id_types": [{"id": "142",
"name": "Passport",
"expdate_required": "A",
"issuedate_required": "A"
}
],
"remittance_purposes": [{"id": "1",
"name": "FAMILY MAINTENANCE"
}
],
"source_of_funds": [{"id": "1",
"name": "ACCUMULATED OWN SALARY"
}
]
}

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": [{"id": "10097",
"name": "Abbeville",
"state_id": "UA001",
"country_code": "US"
}
]
}

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": [{"id": "2",
"name": "CASH PICK UP",
"currencies": ["NPR"
]
}
]
}

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": [{"id": "AE003",
"name": "ABU DHABI COMMERCIAL BANK (ADCB)"
}
]
}

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": [{"bankBranchId": "HLALAEAA",
"bankBranchName": "OTHER (NOT LISTED)",
"bankId": "AE022"
}
]
}

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": [{"type": "utility",
"category": [{"value": "Gas",
"companies": [{"id": "586000000000001",
"name": "SSGC (Sui Southern Gas Company)"
}
]
}
]
}
]
}

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

[{"name": "Poland",
"code": "PLN"
}
]

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": [{"id": "00000000000000000100",
"description": "Electricity",
"currency": "USD",
"amount": 1,
"min_amount": 1,
"max_amount": 1,
"perform_inquiry": false,
"amount_type": "EDITABLE",
"io_fields": [{"io_id": "1",
"name": "Mobile number",
"description": "12-digit mobile number including international dialing prefix",
"operation": 2,
"data_type": "Numeric",
"max_length": 12,
"min_length": 12
}
]
}
]
}

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

Payload

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": {"amount": "1844.00",
"currency": "PKR",
"total_amount_due": "1844.00",
"mandatory_fee": "20.00",
"mandatory_fee_type": "Fixed Amount",
"additional_fee": "2",
"additional_fee_type": "Percentage",
"final_amount": "1900.88"
},
"details_base_currency": {"amount": "1844.00",
"currency": "PKR",
"total_amount_due": "1844.00",
"mandatory_fee": "20.00",
"mandatory_fee_type": "Fixed Amount",
"additional_fee": "2",
"additional_fee_type": "Percentage",
"final_amount": "1900.88"
}
}

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

Payload

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": {"CountryCode": "BGD",
"CountryName": "Bangladesh"
},
"Biller": {"BillerID": "050000000000001",
"BillerName": "Airtel"
},
"SKU": [{"CatalogVersion": "2021030101",
"SKU": "00000000000000000100",
"Currency": "USD",
"Type": "Top-up",
"Description": "Airtel USD $1 (BDT 60)",
"Amount": "1.00",
"MinAmount": "1.00",
"MaxAmount": "1.00",
"Talktime": null,
"Data": null,
"Validity": null,
"Benefits": null
}
],
"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

Payload

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": [{"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
}
]
}

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

Payload

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

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

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

Payload

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

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": [{"id": "cf2de83b-ac68-441b-bc54-21de60014d57",
"country_code": "UAE",
"name": "UNITED ARAB EMIRATES",
"iso_code_3": "UAE",
"iso_code_2": "AE",
"iban_length": 34,
"iban_format": "AE\\d{21}"
}
]
}

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": [{"id": "cf2de83b-ac68-441b-bc54-21de60014d57",
"city_code": "PKC",
"city_id": "PKC001",
"name": "KARACHI",
"country_code": "UAE",
"state_code": "PK001"
}
]
}

nFront API catalog (1.0.0)

OAuth 2.0

Sign in using custom token

Authorizations:

Request Body schema: application/x-www-form-urlencodedrequired

Responses

Response samples

Refresh access token

Authorizations:

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

Responses

Response samples

Sign-up

Verify sign-up user creation

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Create sign-up user

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Verify password reset

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Reset password

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Check username availability

Authorizations:

path Parameters

Responses

Load active password policy

Authorizations:

Responses

Response samples

Initiate authentication flow

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Verify login

Authorizations:

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Continue flow with password change

Authorizations:

path Parameters

header Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Extend auth with refresh token

Authorizations:

path Parameters

header Parameters

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

Responses

Response samples

Invalidate session

Authorizations:

path Parameters

Responses

Decode onboarding token

Authorizations:

Request Body schema: application/x-www-form-urlencoded
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required