API docs by Redocly

Getting started (1.0.0)

Learn how to create cardholders and issue cards. Learn how to create virtual and physical cards through the APIs. Virtual cards can be used instantly after creation. Physical cards are sent to you by mail. Issue a new card in several steps:

  1. Create a user
  2. Top up user wallet
  3. Issue a card for the user
  4. Activate the card

KYC Level One

The first level of KYC flow where user may be approved or rejected.

Create a User account

Authorizations:
apikey
Request Body schema: application/x-www-form-urlencoded
required
mobile
required
string
dry_run
boolean

Responses

Response samples

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

Loads all UserAccount instances.

Authorizations:
apikey
query Parameters
limit
integer <int32>

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

after
string

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

Responses

Response samples

Content type
application/json;charset=UTF-8
Example
{
  • "paging": {
    },
  • "data": "UserAccountInternalCollection"
}

Update an account for given accountId

Authorizations:
apikey
path Parameters
account_id
required
string
Request Body schema: application/json
required
required
object (UserProfile)

This model stores profile information about the user. In case the user is Iraqi (national), it does NOT require to fill in the place of birth. In case of non-locals (nationality different from Iraqi), the place of birth must be informed.

required
object (UserDocuments)

The list of legal documents that are supported by the user profile.

required
object (Address)

Address associated with the User.

dry_run
boolean

This allow submission to KYC check using dry-run, for validation purposes.

Responses

Request samples

Content type
application/json
{
  • "profile": {
    },
  • "documents": {
    },
  • "address": {
    },
  • "dry_run": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "user_account": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Submits User Account for KYC documentation check.

This endpoint allows the account admin to initiate the KYC OnBoarding check process of an existing account.

Authorizations:
apikey
path Parameters
account_id
required
string
Request Body schema: application/x-www-form-urlencoded
dry_run
boolean

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "user_account": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Approves User Account KYC documentation.

This endpoint allows the account administrator to review User documentation and APPROVE the UserAccount KYC OnBoarding in the PENDING state. The UserAccount KYC status is set to APPROVED.

Authorizations:
apikey
path Parameters
account_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "user_account": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Rejects User Account KYC documentation.

This endpoint allows the account administrator to review User documentation and REJECT the UserAccount KYC OnBoarding in the PENDING state. The UserAccount KYC status is set to REJECTED. The account note ID containing the reason and description is also saved.

Authorizations:
apikey
path Parameters
account_id
required
string
Request Body schema: application/json
required
title
string

Optional note title

category
required
string^[a-z]{1}[a-z_0-9]+[a-z0-9]{1}$

Note category

description
required
string

Notes description

object

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "category": "string",
  • "description": "string",
  • "extras": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "user_account": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

KYC Level Two

Another level of KYC flow where user may be approved or rejected. Using more criteria to be approved.

Submits User Account for KYC2 Analysis

This endpoint allows the admin with an already existing account to initiate the KYC2 check process.

Authorizations:
apikey
path Parameters
account_id
required
string

The User account id

Request Body schema: application/json
required
agent_id
required
string

Responses

Request samples

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

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "user_account": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Approve user for KYC2

This endpoint allows the account administrator to review User documentation and APPROVE the UserAccount KYC2 in the APPROVED state. The UserAccount KYC status is set to KYC2_APPROVED.

Authorizations:
apikey
path Parameters
account_id
required
string

The User account id

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "user_account": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Reject user for KYC2

This endpoint allows the account administrator to review User documentation and REJECT the UserAccount KYC2 in the. The UserAccount status will remain APPROVED.

Authorizations:
apikey
path Parameters
account_id
required
string

The User account id

Request Body schema: application/json
required
title
string

Optional note title

category
required
string^[a-z]{1}[a-z_0-9]+[a-z0-9]{1}$

Note category

description
required
string

Notes description

object

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "category": "string",
  • "description": "string",
  • "extras": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "user_account": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Account status

This section includes endpoint to follow the status changes and (un)block the account.

Get details from an existing UserAccount instance.

Authorizations:
apikey
path Parameters
account_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "user_account": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Loads an existing UserAccount instance based on email.

Authorizations:
apikey
query Parameters
email
required
string

The email linked to an account

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "user_account": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Loads an existing UserAccount instance based on mobile.

Authorizations:
apikey
query Parameters
mobile
required
string

The mobile linked to an account

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "user_account": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Approves User Account KYC documentation.

This endpoint allows the account administrator to review User documentation and APPROVE the UserAccount KYC OnBoarding in the PENDING state. The UserAccount KYC status is set to APPROVED.

Authorizations:
apikey
path Parameters
account_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "verified_mobile": 551185249635,
  • "verified_email": "bob@example.com",
  • "user_account": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Blocks an account

Authorizations:
apikey
path Parameters
account_id
required
string
Request Body schema: application/json
required
title
string

Optional note title

category
required
string^[a-z]{1}[a-z_0-9]+[a-z0-9]{1}$

Note category

description
required
string

Notes description

object

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "category": "string",
  • "description": "string",
  • "extras": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "type": "admin|user|agent|app",
  • "mobile": 551185249635,
  • "display_name": "John Doe",
  • "email": "email@nymcard.com",
  • "scopes": [
    ],
  • "status": "pending"
}

Unblocks a blocked account

Authorizations:
apikey
path Parameters
account_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "type": "admin|user|agent|app",
  • "mobile": 551185249635,
  • "display_name": "John Doe",
  • "email": "email@nymcard.com",
  • "scopes": [
    ],
  • "status": "pending"
}

Wallets

This section includes endpoint to manage funcionalities related to user wallets.

Load account wallets

Authorizations:
apikey
path Parameters
account_id
required
string

Responses

Response samples

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

Load transaction that belongs to a given wallet

Authorizations:
apikey
path Parameters
account_id
required
string
wallet_id
required
string
query Parameters
after_version
string

If set, data results must be returned after given version

Responses

Response samples

Content type
application/json;charset=UTF-8
Example
{
  • "paging": {
    },
  • "data": "UserAccountInternalCollection"
}

Load a given wallet transaction

Authorizations:
apikey
path Parameters
account_id
required
string
wallet_id
required
string
transaction_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "friendly_id": "abu3pl",
  • "provider_id": "devtools",
  • "transaction_key": "string",
  • "sender": {
    },
  • "sender_category": "wallet_credit",
  • "sender_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "sender_wallet_id": "string",
  • "receiver": {
    },
  • "receiver_category": "wallet_credit",
  • "receiver_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "receiver_wallet_id": "string",
  • "receiver_card": {
    },
  • "receiver_limit": {
    },
  • "type": "credit",
  • "details": {
    },
  • "wallet_transaction": {
    },
  • "status": "processing",
  • "status_code": 500,
  • "status_desc": "Internal error",
  • "card_product": "virtual",
  • "attempts": 5,
  • "approval_status": "pending",
  • "required_approvals": 1,
  • "created_by": {
    },
  • "approved_by": [
    ],
  • "rejected_by": [
    ],
  • "rejection_note": {
    },
  • "task": {
    },
  • "cancellation_status": "none",
  • "cancellation_note": {
    },
  • "cancellation_created_by": {
    },
  • "cancellation_approved_by": [
    ],
  • "cancellation_rejected_by": [
    ],
  • "cancellation_rejection_note": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "extras": {
    }
}

Credit funds into wallet

Authorizations:
apikey
path Parameters
account_id
required
string
wallet_id
required
string
transaction_id
required
string
Request Body schema: application/json
required
currency
required
string
amount
required
number <decimal>
description
required
string
dry_run
boolean

Indicates whether there are more data to load

Responses

Request samples

Content type
application/json
Example
{
  • "currency": "usd",
  • "amount": 99.95,
  • "description": "NymcardCmsWalletTransactionCreditDetails",
  • "dry_run": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "friendly_id": "abu3pl",
  • "provider_id": "devtools",
  • "transaction_key": "string",
  • "sender": {
    },
  • "sender_category": "wallet_credit",
  • "sender_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "sender_wallet_id": "string",
  • "receiver": {
    },
  • "receiver_category": "wallet_credit",
  • "receiver_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "receiver_wallet_id": "string",
  • "receiver_card": {
    },
  • "receiver_limit": {
    },
  • "type": "credit",
  • "details": {
    },
  • "wallet_transaction": {
    },
  • "status": "processing",
  • "status_code": 500,
  • "status_desc": "Internal error",
  • "card_product": "virtual",
  • "attempts": 5,
  • "approval_status": "pending",
  • "required_approvals": 1,
  • "created_by": {
    },
  • "approved_by": [
    ],
  • "rejected_by": [
    ],
  • "rejection_note": {
    },
  • "task": {
    },
  • "cancellation_status": "none",
  • "cancellation_note": {
    },
  • "cancellation_created_by": {
    },
  • "cancellation_approved_by": [
    ],
  • "cancellation_rejected_by": [
    ],
  • "cancellation_rejection_note": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "extras": {
    }
}

Debit funds from wallet

Authorizations:
apikey
path Parameters
account_id
required
string
wallet_id
required
string
transaction_id
required
string
Request Body schema: application/json
required
currency
required
string
amount
required
number <decimal>
description
required
string
dry_run
boolean

Indicates whether there are more data to load

Responses

Request samples

Content type
application/json
Example
{
  • "currency": "usd",
  • "amount": 99.95,
  • "description": "NymcardCmsWalletTransactionCreditDetails",
  • "dry_run": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "friendly_id": "abu3pl",
  • "provider_id": "devtools",
  • "transaction_key": "string",
  • "sender": {
    },
  • "sender_category": "wallet_credit",
  • "sender_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "sender_wallet_id": "string",
  • "receiver": {
    },
  • "receiver_category": "wallet_credit",
  • "receiver_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "receiver_wallet_id": "string",
  • "receiver_card": {
    },
  • "receiver_limit": {
    },
  • "type": "credit",
  • "details": {
    },
  • "wallet_transaction": {
    },
  • "status": "processing",
  • "status_code": 500,
  • "status_desc": "Internal error",
  • "card_product": "virtual",
  • "attempts": 5,
  • "approval_status": "pending",
  • "required_approvals": 1,
  • "created_by": {
    },
  • "approved_by": [
    ],
  • "rejected_by": [
    ],
  • "rejection_note": {
    },
  • "task": {
    },
  • "cancellation_status": "none",
  • "cancellation_note": {
    },
  • "cancellation_created_by": {
    },
  • "cancellation_approved_by": [
    ],
  • "cancellation_rejected_by": [
    ],
  • "cancellation_rejection_note": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "extras": {
    }
}

Debit a card issuance fee from wallet

Authorizations:
apikey
path Parameters
account_id
required
string
wallet_id
required
string
transaction_id
required
string
Request Body schema: application/json
required
currency
required
string
amount
required
number <decimal>
description
required
string
dry_run
boolean

Indicates whether there are more data to load

Responses

Request samples

Content type
application/json
Example
{
  • "currency": "usd",
  • "amount": 99.95,
  • "description": "NymcardCmsWalletTransactionCreditDetails",
  • "dry_run": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "friendly_id": "abu3pl",
  • "provider_id": "devtools",
  • "transaction_key": "string",
  • "sender": {
    },
  • "sender_category": "wallet_credit",
  • "sender_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "sender_wallet_id": "string",
  • "receiver": {
    },
  • "receiver_category": "wallet_credit",
  • "receiver_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "receiver_wallet_id": "string",
  • "receiver_card": {
    },
  • "receiver_limit": {
    },
  • "type": "credit",
  • "details": {
    },
  • "wallet_transaction": {
    },
  • "status": "processing",
  • "status_code": 500,
  • "status_desc": "Internal error",
  • "card_product": "virtual",
  • "attempts": 5,
  • "approval_status": "pending",
  • "required_approvals": 1,
  • "created_by": {
    },
  • "approved_by": [
    ],
  • "rejected_by": [
    ],
  • "rejection_note": {
    },
  • "task": {
    },
  • "cancellation_status": "none",
  • "cancellation_note": {
    },
  • "cancellation_created_by": {
    },
  • "cancellation_approved_by": [
    ],
  • "cancellation_rejected_by": [
    ],
  • "cancellation_rejection_note": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "extras": {
    }
}

Transfer between wallets

Authorizations:
apikey
path Parameters
account_id
required
string
wallet_id
required
string
transaction_id
required
string
query Parameters
receiver_wallet_id
required
string
Request Body schema: application/json
required
currency
required
string
amount
required
number <decimal>
description
required
string
dry_run
boolean

Indicates whether there are more data to load

Responses

Request samples

Content type
application/json
Example
{
  • "currency": "usd",
  • "amount": 99.95,
  • "description": "NymcardCmsWalletTransactionCreditDetails",
  • "dry_run": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "friendly_id": "abu3pl",
  • "provider_id": "devtools",
  • "transaction_key": "string",
  • "sender": {
    },
  • "sender_category": "wallet_credit",
  • "sender_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "sender_wallet_id": "string",
  • "receiver": {
    },
  • "receiver_category": "wallet_credit",
  • "receiver_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "receiver_wallet_id": "string",
  • "receiver_card": {
    },
  • "receiver_limit": {
    },
  • "type": "credit",
  • "details": {
    },
  • "wallet_transaction": {
    },
  • "status": "processing",
  • "status_code": 500,
  • "status_desc": "Internal error",
  • "card_product": "virtual",
  • "attempts": 5,
  • "approval_status": "pending",
  • "required_approvals": 1,
  • "created_by": {
    },
  • "approved_by": [
    ],
  • "rejected_by": [
    ],
  • "rejection_note": {
    },
  • "task": {
    },
  • "cancellation_status": "none",
  • "cancellation_note": {
    },
  • "cancellation_created_by": {
    },
  • "cancellation_approved_by": [
    ],
  • "cancellation_rejected_by": [
    ],
  • "cancellation_rejection_note": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "extras": {
    }
}

Load all cards

Authorizations:
apikey
path Parameters
account_id
required
string

Responses

Response samples

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

Get a Card data

Authorizations:
apikey
path Parameters
account_id
required
string
card_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "string",
  • "friendly_id": "abu3pl",
  • "account_id": "string",
  • "cardholder_id": "string",
  • "card": {
    },
  • "card_ref": {
    },
  • "card_account": {
    },
  • "card_bundle": {
    },
  • "card_key": "string",
  • "termination": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Load account limits

Authorizations:
apikey
path Parameters
account_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "account_id": "string",
  • "limits": {
    },
  • "reservations": [
    ],
  • "deductions": [
    ],
  • "cancellations": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Renew account limits

Authorizations:
apikey
path Parameters
account_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "account_id": "string",
  • "limits": {
    },
  • "reservations": [
    ],
  • "deductions": [
    ],
  • "cancellations": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Get Limits

Authorizations:
apikey
path Parameters
account_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "currency": "eur",
  • "available": 99.95,
  • "cards": 3
}

Cards lifecycle management

This section includes endpoint to create a virutal card and manage the money in it.

Suspend an active card

Authorizations:
apikey
path Parameters
account_id
required
string
card_id
required
string
Request Body schema: application/json
title
string

Optional note title

category
required
string^[a-z]{1}[a-z_0-9]+[a-z0-9]{1}$

Note category

description
required
string

Notes description

object

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "category": "string",
  • "description": "string",
  • "extras": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "string",
  • "friendly_id": "abu3pl",
  • "account_id": "string",
  • "cardholder_id": "string",
  • "card": {
    },
  • "card_ref": {
    },
  • "card_account": {
    },
  • "card_bundle": {
    },
  • "card_key": "string",
  • "termination": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Activate a card

Authorizations:
apikey
path Parameters
account_id
required
string
card_id
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "string",
  • "friendly_id": "abu3pl",
  • "account_id": "string",
  • "cardholder_id": "string",
  • "card": {
    },
  • "card_ref": {
    },
  • "card_account": {
    },
  • "card_bundle": {
    },
  • "card_key": "string",
  • "termination": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Terminate a card

Authorizations:
apikey
path Parameters
account_id
required
string
card_id
required
string
Request Body schema: application/json
required
required
object (CoreNote)
reason
required
string (NymcardCmsCardTerminationReason)
Enum: "lost" "stolen" "cancelled" "other"

Responses

Request samples

Content type
application/json
{
  • "note": {
    },
  • "reason": "lost"
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "string",
  • "friendly_id": "abu3pl",
  • "account_id": "string",
  • "cardholder_id": "string",
  • "card": {
    },
  • "card_ref": {
    },
  • "card_account": {
    },
  • "card_bundle": {
    },
  • "card_key": "string",
  • "termination": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Issue Bulk Gift Card

This section includes endpoint to issue new gift cark in a bulk.

Create new CMS cards in bulk

Authorizations:
apikey
Request Body schema: application/json
required
token
required
string

This attribute stores an unique key for idempotency control over requests.

card_product_id
required
string

This attribute stores the card product ID to be used when creating the cards in bulk.

number_of_cards
required
integer

The amount of cards to generate.

amount
required
number <decimal>

The card limit to be used when creating the cards.

currency
required
string <iso-4217> ^[a-z]{3}$

3-letter ISO_4217 ccode representing the currency

dry_run
boolean

Indicates whether request should run in dry-run mode

Responses

Request samples

Content type
application/json
{
  • "token": "string",
  • "card_product_id": "string",
  • "number_of_cards": 0,
  • "amount": 1500.1,
  • "currency": "eur",
  • "dry_run": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "token": "string",
  • "details": {
    },
  • "status": "pending",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Loads all card bulk issuances

Authorizations:
apikey
query Parameters
limit
integer
after
string

Responses

Response samples

Content type
application/json;charset=UTF-8
Example
{
  • "paging": {
    },
  • "data": "UserAccountInternalCollection"
}

Load a specific card bulk issuance by token

Authorizations:
apikey
path Parameters
token
required
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "token": "string",
  • "details": {
    },
  • "status": "pending",
  • "created": "2018-01-02T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Travel Card

This section includes endpoints related to Travel Cards.

Get encrypted card details

Authorizations:
apikey
path Parameters
account_id
required
string
card_id
required
string
query Parameters
device_id
required
string
enc_passcode
string

Responses

Response samples

Content type
application/json;charset=UTF-8
{
  • "card_key": "string",
  • "provider_id": "devtools",
  • "enc_number": "string",
  • "enc_security_code": "string",
  • "enc_name": "string",
  • "enc_exp_month": "string",
  • "enc_exp_year": "string"
}

Get encrypted card pin

Authorizations:
apikey
path Parameters
account_id
required
string
card_id
required
string
query Parameters
device_id
required
string
enc_passcode
string

Responses

Response samples

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

change card pin

Authorizations:
apikey
path Parameters
account_id
required
string
card_id
required
string
Request Body schema: application/json
required

the change pin details

device_id
required
string
enc_passcode
string
enc_pin
required
string

Responses

Request samples

Content type
application/json
{
  • "device_id": "string",
  • "enc_passcode": "string",
  • "enc_pin": "d089a80f-e641-4045-8a80-54841e4a7458"
}

Acivate a card by activation token

Authorizations:
apikey
path Parameters
account_id
required
string
Request Body schema: application/json
required
activation_token
required
string

A token used to activate a card

Responses

Request samples

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

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "string",
  • "friendly_id": "abu3pl",
  • "account_id": "string",
  • "cardholder_id": "string",
  • "card": {
    },
  • "card_ref": {
    },
  • "card_account": {
    },
  • "card_bundle": {
    },
  • "card_key": "string",
  • "termination": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Notes

This section includes endpoints to create and get notes.

Create card related note

Authorizations:
apikey
path Parameters
account_id
required
string
card_id
required
string
Request Body schema: application/json
required
title
string

Optional note title

category
required
string^[a-z]{1}[a-z_0-9]+[a-z0-9]{1}$

Note category

description
required
string

Notes description

object

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "category": "string",
  • "description": "string",
  • "extras": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "note": {
    },
  • "author": {
    },
  • "account": {
    },
  • "links": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Search for Notes instances

Authorizations:
apikey
Request Body schema: application/json
required
query
string
sort_by
string
order_by
string (SortDirection)
Enum: "asc" "desc"
matcher
string (SearchMatcher)
Default: ["and"]
Enum: "and" "or"
Array of objects (SearchFilter)
object (Cursors)
limit
integer <int32>

Responses

Request samples

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

Response samples

Content type
application/json;charset=UTF-8
Example
{
  • "paging": {
    },
  • "data": "UserAccountInternalCollection"
}

Create account related note

Authorizations:
apikey
path Parameters
account_id
required
string
Request Body schema: application/json
required
title
string

Optional note title

category
required
string^[a-z]{1}[a-z_0-9]+[a-z0-9]{1}$

Note category

description
required
string

Notes description

object

Responses

Request samples

Content type
application/json
{
  • "title": "string",
  • "category": "string",
  • "description": "string",
  • "extras": {
    }
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "id": "cf2de83b-ac68-441b-bc54-21de60014d57",
  • "note": {
    },
  • "author": {
    },
  • "account": {
    },
  • "links": [
    ],
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z"
}

Create virtual Card

Card balance refund

Authorizations:
apikey
path Parameters
account_id
required
string
wallet_id
required
string
transaction_id
required
string
query Parameters
card_id
required
string
Request Body schema: application/json
required
currency
required
string
amount
required
number <decimal>
description
required
string
dry_run
boolean

Indicates whether there are more data to load

Responses

Request samples

Content type
application/json
Example
{
  • "currency": "usd",
  • "amount": 99.95,
  • "description": "NymcardCmsWalletTransactionCreditDetails",
  • "dry_run": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "friendly_id": "abu3pl",
  • "provider_id": "devtools",
  • "transaction_key": "string",
  • "sender": {
    },
  • "sender_category": "wallet_credit",
  • "sender_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "sender_wallet_id": "string",
  • "receiver": {
    },
  • "receiver_category": "wallet_credit",
  • "receiver_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "receiver_wallet_id": "string",
  • "receiver_card": {
    },
  • "receiver_limit": {
    },
  • "type": "credit",
  • "details": {
    },
  • "wallet_transaction": {
    },
  • "status": "processing",
  • "status_code": 500,
  • "status_desc": "Internal error",
  • "card_product": "virtual",
  • "attempts": 5,
  • "approval_status": "pending",
  • "required_approvals": 1,
  • "created_by": {
    },
  • "approved_by": [
    ],
  • "rejected_by": [
    ],
  • "rejection_note": {
    },
  • "task": {
    },
  • "cancellation_status": "none",
  • "cancellation_note": {
    },
  • "cancellation_created_by": {
    },
  • "cancellation_approved_by": [
    ],
  • "cancellation_rejected_by": [
    ],
  • "cancellation_rejection_note": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "extras": {
    }
}

Create a new card

Authorizations:
apikey
path Parameters
account_id
required
string
wallet_id
required
string
transaction_id
required
string
Request Body schema: application/json
required
currency
required
string
amount
required
number <decimal>
description
required
string
dry_run
boolean

Indicates whether there are more data to load

Responses

Request samples

Content type
application/json
Example
{
  • "currency": "usd",
  • "amount": 99.95,
  • "description": "NymcardCmsWalletTransactionCreditDetails",
  • "dry_run": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "friendly_id": "abu3pl",
  • "provider_id": "devtools",
  • "transaction_key": "string",
  • "sender": {
    },
  • "sender_category": "wallet_credit",
  • "sender_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "sender_wallet_id": "string",
  • "receiver": {
    },
  • "receiver_category": "wallet_credit",
  • "receiver_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "receiver_wallet_id": "string",
  • "receiver_card": {
    },
  • "receiver_limit": {
    },
  • "type": "credit",
  • "details": {
    },
  • "wallet_transaction": {
    },
  • "status": "processing",
  • "status_code": 500,
  • "status_desc": "Internal error",
  • "card_product": "virtual",
  • "attempts": 5,
  • "approval_status": "pending",
  • "required_approvals": 1,
  • "created_by": {
    },
  • "approved_by": [
    ],
  • "rejected_by": [
    ],
  • "rejection_note": {
    },
  • "task": {
    },
  • "cancellation_status": "none",
  • "cancellation_note": {
    },
  • "cancellation_created_by": {
    },
  • "cancellation_approved_by": [
    ],
  • "cancellation_rejected_by": [
    ],
  • "cancellation_rejection_note": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "extras": {
    }
}

Tops up a card (add money)

Authorizations:
apikey
path Parameters
account_id
required
string
wallet_id
required
string
transaction_id
required
string
query Parameters
card_id
required
string
Request Body schema: application/json
required
currency
required
string
amount
required
number <decimal>
description
required
string
dry_run
boolean

Indicates whether there are more data to load

Responses

Request samples

Content type
application/json
Example
{
  • "currency": "usd",
  • "amount": 99.95,
  • "description": "NymcardCmsWalletTransactionCreditDetails",
  • "dry_run": true
}

Response samples

Content type
application/json;charset=UTF-8
{
  • "internal_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "friendly_id": "abu3pl",
  • "provider_id": "devtools",
  • "transaction_key": "string",
  • "sender": {
    },
  • "sender_category": "wallet_credit",
  • "sender_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "sender_wallet_id": "string",
  • "receiver": {
    },
  • "receiver_category": "wallet_credit",
  • "receiver_account_id": "d089a80f-e641-4045-8a80-54841e4a7458",
  • "receiver_wallet_id": "string",
  • "receiver_card": {
    },
  • "receiver_limit": {
    },
  • "type": "credit",
  • "details": {
    },
  • "wallet_transaction": {
    },
  • "status": "processing",
  • "status_code": 500,
  • "status_desc": "Internal error",
  • "card_product": "virtual",
  • "attempts": 5,
  • "approval_status": "pending",
  • "required_approvals": 1,
  • "created_by": {
    },
  • "approved_by": [
    ],
  • "rejected_by": [
    ],
  • "rejection_note": {
    },
  • "task": {
    },
  • "cancellation_status": "none",
  • "cancellation_note": {
    },
  • "cancellation_created_by": {
    },
  • "cancellation_approved_by": [
    ],
  • "cancellation_rejected_by": [
    ],
  • "cancellation_rejection_note": {
    },
  • "created": "2012-05-04T19:42:32.987Z",
  • "modified": "2012-05-04T19:42:32.987Z",
  • "extras": {
    }
}