jPOS logo
Documentation Powered by ReDoc

jCard's Rest API (1.0.0)

Download OpenAPI specification:Download

Transactility Inc: info@transactility.com URL: https://transactility.com License: Commercial License

Authentication

bearerAuth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

Echo

Endpoint status and system information

Check System Status and Retrieve System Information

This endpoint is used to verify the health of the service. It returns an echo response with security context information, version details, and system information.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "security-context": {
    },
  • "success": true,
  • "version": "2.1.9-SNAPSHOT",
  • "revision": "8febf01",
  • "timestamp": 1692129220917
}

Check System Status

This endpoint echoes the provided request body

Authorizations:
bearerAuth
Request Body schema: application/json
Schema not provided

Responses

Request samples

Content type
application/json
{
  • "key": "value"
}

Response samples

Content type
application/json
{
  • "security-context": {
    },
  • "success": true,
  • "version": "2.1.9-SNAPSHOT",
  • "revision": "8febf01",
  • "timestamp": 1692129220917,
  • "echoed-data": {
    }
}

SysConfig

System configuration management

Get All SysConfigs

Returns all the available SysConfigs

Authorizations:
bearerAuth
query Parameters
prefix
string

Responses

Response samples

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

Create a new sysconfig

Create a new sysconfig entry with the provided data.

Authorizations:
bearerAuth
Request Body schema: application/json
id
required
string
value
required
string
readPerm
string
writePerm
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "value": "string",
  • "readPerm": "string",
  • "writePerm": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string",
  • "readPerm": "string",
  • "writePerm": "string"
}

Get SysConfig by Id

Given an Id, returns the specified SysConfig

Authorizations:
bearerAuth
path Parameters
id
required
string
Example: perm.login

ID of the SysConfig to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": "perm.login",
  • "value": "Login",
  • "readPerm": "sysconfig.read",
  • "writePerm": "sysadmin"
}

Delete SysConfig by Id

Deletes the specified SysConfig

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of the SysConfig to delete

Responses

Response samples

Content type
application/json
{
  • "errors": "invalid.permissions"
}

Update SysConfig

Update an existing sysconfig entry with the provided data.

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of the SysConfig to delete

Request Body schema: application/json
id
required
string
value
required
string
readPerm
string
writePerm
string

Responses

Request samples

Content type
application/json
{
  • "id": "string",
  • "value": "string",
  • "readPerm": "string",
  • "writePerm": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "value": "string",
  • "readPerm": "string",
  • "writePerm": "string"
}

Users

User management

Get All Users

Returns all the available Users

Authorizations:
bearerAuth
query Parameters
limit
integer
offset
integer

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create User

Creates a new user based on the schema

Authorizations:
bearerAuth
Request Body schema: application/json
id
integer
nick
string
name
string
email
string
startDate
string <date>
endDate
string <date>
forcePasswordChange
boolean
deleted
boolean
active
boolean
verified
boolean
passwordChanged
string <date-time>
lastLogin
string <date-time>
loginAttempts
integer
password
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "nick": "string",
  • "name": "string",
  • "email": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "forcePasswordChange": true,
  • "deleted": true,
  • "active": true,
  • "verified": true,
  • "passwordChanged": "2019-08-24T14:15:22Z",
  • "lastLogin": "2019-08-24T14:15:22Z",
  • "loginAttempts": 0,
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "nick": "johndoe",
  • "name": "John Doe",
  • "email": "johndoe@example.com",
  • "startDate": "2023-01-01T00:00:00.000Z",
  • "endDate": "2023-12-31T00:00:00.000Z",
  • "forcePasswordChange": false,
  • "deleted": false,
  • "active": true,
  • "verified": true,
  • "passwordChanged": "2023-01-01T10:00:00.000Z",
  • "lastLogin": "2023-08-15T15:30:00.000Z",
  • "loginAttempts": 0
}

Get User by Id

Retrieves the specified user's information

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the user to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "nick": "johndoe",
  • "name": "John Doe",
  • "email": "johndoe@example.com",
  • "startDate": "2023-01-01T00:00:00.000Z",
  • "endDate": "2023-12-31T00:00:00.000Z",
  • "forcePasswordChange": false,
  • "deleted": false,
  • "active": true,
  • "verified": true,
  • "passwordChanged": "2023-01-01T10:00:00.000Z",
  • "lastLogin": "2023-08-15T15:30:00.000Z",
  • "loginAttempts": 0
}

Update User

Updates the information of the specified user

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the user to update

Request Body schema: application/json
id
integer
nick
string
name
string
email
string
startDate
string <date>
endDate
string <date>
forcePasswordChange
boolean
deleted
boolean
active
boolean
verified
boolean
passwordChanged
string <date-time>
lastLogin
string <date-time>
loginAttempts
integer
password
string

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "nick": "string",
  • "name": "string",
  • "email": "string",
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "forcePasswordChange": true,
  • "deleted": true,
  • "active": true,
  • "verified": true,
  • "passwordChanged": "2019-08-24T14:15:22Z",
  • "lastLogin": "2019-08-24T14:15:22Z",
  • "loginAttempts": 0,
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "id": 1,
  • "nick": "johndoe",
  • "name": "John Doe",
  • "email": "johndoe@example.com",
  • "startDate": "2023-01-01T00:00:00.000Z",
  • "endDate": "2023-12-31T00:00:00.000Z",
  • "forcePasswordChange": false,
  • "deleted": false,
  • "active": true,
  • "verified": true,
  • "passwordChanged": "2023-01-01T10:00:00.000Z",
  • "lastLogin": "2023-08-15T15:30:00.000Z",
  • "loginAttempts": 0
}

Delete User

Deletes the user with the given id

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the user to delete

Responses

Response samples

Content type
application/json
{
  • "errors": "invalid.permissions"
}

Get Current User

Retrieves the logged user info

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "nick": "johndoe",
  • "name": "John Doe",
  • "email": "johndoe@example.com",
  • "startDate": "2023-01-01T00:00:00.000Z",
  • "endDate": "2023-12-31T00:00:00.000Z",
  • "forcePasswordChange": false,
  • "deleted": false,
  • "active": true,
  • "verified": true,
  • "passwordChanged": "2023-01-01T10:00:00.000Z",
  • "lastLogin": "2023-08-15T15:30:00.000Z",
  • "loginAttempts": 0
}

Get Current User's Revision History

Retrieves the logged user revision history

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get All Roles for User

Get all roles associated with the user

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the user to retrieve roles for

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Add Roles to User

Adds specified roles to the user

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the user to add roles to

Request Body schema: application/json
roles
Array of integers

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Roles

Role management

Get All Roles

Retrieve all roles available in the system

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Create Role

Create a new role in the system

Authorizations:
bearerAuth
Request Body schema: application/json
id
integer
name
string
Array of objects (permission)
realmId
integer

Responses

Request samples

Content type
application/json
{
  • "name": "callcenter",
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 1455,
  • "name": "callcenter",
  • "permissions": [
    ],
  • "realmId": 1
}

Get Role by ID

Retrieve a role by its unique ID

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the role to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 123,
  • "name": "example_role",
  • "permissions": [
    ],
  • "realmId": 1
}

Update Role by ID

Update an existing role by its unique ID

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the role to update

Request Body schema: application/json
id
integer
name
string
Array of objects (permission)
realmId
integer

Responses

Request samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "permissions": [
    ],
  • "realmId": 0
}

Response samples

Content type
application/json
{
  • "id": 123,
  • "name": "updated_role",
  • "permissions": [
    ],
  • "realmId": 1
}

Delete Role by ID

Delete a role by its unique ID

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the role to delete

Responses

Response samples

Content type
application/json
{
  • "errors": "invalid.permissions"
}

Get Permissions for a Role

Retrieve the permissions associated with a role.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the role

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Add permissions to Role

Create new permissions and associate them with a role.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the role

Request Body schema: application/json

List of permissions to create and add to the role.

Array ()
id
string
description
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "errors": "invalid.permissions"
}

Get User Count for Role

Retrieve the count of users associated with a specific role.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the role

Responses

Response samples

Content type
application/json
{
  • "userCount": 2
}

Permissions

Permissions management

Get All Permissions

Retrieve all permissions available in the system

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    },
  • {
    }
]

Revision History

Revision History

MiniGL

MiniGL

Create a GL Transaction

Posts a new MiniGL transaction

Authorizations:
bearerAuth
Request Body schema: application/json
detail
string

The transaction detail.

required
Array of objects

List of transaction entries.

postDate
required
string <date>

The posting date in the format "YYYY-MM-DD".

journalName
required
string

The journal name.

Responses

Request samples

Content type
application/json
{
  • "detail": "string",
  • "entries": [
    ],
  • "postDate": "2019-08-24",
  • "journalName": "string"
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "timestamp": "string",
  • "postDate": "string",
  • "detail": "string",
  • "tags": "string",
  • "journalId": 0,
  • "entries": [
    ]
}

Get GL Transaction by ID

Retrieve a GL transaction by its ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the GL transaction

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "timestamp": "string",
  • "postDate": "string",
  • "detail": "string",
  • "tags": "string",
  • "journalId": 0,
  • "entries": [
    ]
}

Retrieve All Journals

Get a list of all journal entries.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get Account Balance

Retrieve the balance for a specific account.

Authorizations:
bearerAuth
path Parameters
journalCode
required
string

The code of the journal

accountCode
required
string

The code of the account.

query Parameters
layers
string

Comma-separated list of layers.

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "response": {
    }
}

Get Account Statement

Retrieve the account statement for a specific account.

Authorizations:
bearerAuth
path Parameters
journalCode
required
string

The code of the journal

accountCode
required
string

The code of the account.

query Parameters
layers
string

Comma-separated list of layers.

start
string

The start date for the account statement.

end
string

The end date for the account statement.

Responses

Response samples

Content type
application/json
{
  • "accountCode": "11",
  • "description": "Issuers",
  • "journalCode": "jcard",
  • "debits": 1460,
  • "credits": 210,
  • "start": "Sun Feb 01 00:00:00 UTC 1970",
  • "end": "Sun Jan 31 23:59:59 UTC 2100",
  • "initialBalance": 0,
  • "finalBalance": 1250,
  • "layers": [
    ],
  • "entries": [
    ]
}

Get Charts of Accounts

Retrieve all available charts of accounts.

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new account

Create a new GL account with the provided JSON object.

Authorizations:
bearerAuth
path Parameters
chartName
required
string

Name of the chart

Request Body schema: application/json
code
required
string

Account code

description
required
string

Account description

accountType
required
string

Type of account (e.g., debit, credit)

parentCode
required
string

Parent account code

final
required
boolean

Indicates if this is a final account

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "description": "string",
  • "accountType": "string",
  • "parentCode": "string",
  • "final": true
}

Response samples

Content type
application/json
{
  • "success": true
}

Search Accounts

Search for accounts based on various query parameters

Authorizations:
bearerAuth
path Parameters
chartName
required
string

Name of the chart

query Parameters
limit
integer
Default: 20

Limit the number of results

offset
integer
Default: 0

Offset for pagination

pointer
string <base64>

A base64 encoded pointer to the last item shown. When provided, the list will start after this item. Do not use together with 'offset'.

q
string

Query string for filtering results

header Parameters
version
required
string

API version

Authorization
required
string

Authorization token

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "hasNext": true,
  • "data": [
    ]
}

Get Account info

Retrieve account information given account code and chart name.

Authorizations:
bearerAuth
path Parameters
chartName
required
string

Name of the GL chart.

accountCode
required
string

Account code

query Parameters
depth
integer

Depth of hierarchy to retrieve.

limit
integer

Maximum number of accounts to retrieve.

offset
integer

Offset for paginating results.

Responses

Response samples

Content type
application/json
{
  • "id": 7,
  • "root": "jcard",
  • "parent": "1",
  • "code": "11",
  • "description": "Issuers",
  • "created": "2015-09-11",
  • "type": 1,
  • "children": [
    ],
  • "childrenSize": 1
}

Retrieve GL entries for an account

Retrieve GL entries for a specific GL account within the specified date range and layers.

Authorizations:
bearerAuth
path Parameters
chartName
required
string

Name of the chart

accountCode
required
string

Account code

query Parameters
limit
integer

Maximum number of entries to return

offset
integer

Number of entries to skip

layers
Array of integers

Layers to filter entries by

startDate
string <date>

Start date for filtering entries

endDate
string <date>

End date for filtering entries

Responses

Response samples

Content type
application/json
{
  • "total": 10,
  • "limit": 1,
  • "offset": 0,
  • "data": [
    ]
}

Search account's children

Search for accounts with a given parent, based on various query parameters

Authorizations:
bearerAuth
path Parameters
chartName
required
string

Name of the chart

accountCode
required
string

Account code

query Parameters
limit
integer
Default: 20

Limit the number of results

offset
integer
Default: 0

Offset for pagination

pointer
string <base64>

A base64 encoded pointer to the last item shown. When provided, the list will start after this item. Do not use together with 'offset'.

q
string

Query string for filtering results

header Parameters
version
required
string

API version

Authorization
required
string

Authorization token

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "hasNext": true,
  • "data": [
    ]
}

Wallets

Wallet management

Create Wallet

Create a new wallet based on the provided data.

Authorizations:
bearerAuth
Request Body schema: application/json

Wallet to post

code
required
string^[a-zA-Z0-9][-_a-zA-Z0-9]{0,63}$
cardProduct
number

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "cardProduct": 0
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "active": true,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "cardHolder": {
    },
  • "cardProduct": {
    },
  • "agentId": 0,
  • "kid": "string",
  • "deleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z"
}

Get Wallets

Get all wallets available in the system

Authorizations:
bearerAuth
query Parameters
code
string

Comma-separated list of wallet codes

includeDeleted
boolean

If true include deleted wallets, if false or null deleted wallets are not included in result set.

limit
integer

The maximum number of items to return (pagination).

offset
integer

The number of items to skip for pagination.

Responses

Response samples

Content type
application/json
{
  • "total": 8,
  • "limit": 3,
  • "offset": 1,
  • "data": [
    ]
}

Get wallet by id

Retrieve a wallet by id

Authorizations:
bearerAuth
path Parameters
id
required
number

The unique ID of the wallet

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "code": "string",
  • "active": true,
  • "startDate": "2019-08-24",
  • "endDate": "2019-08-24",
  • "cardHolder": {
    },
  • "cardProduct": {
    },
  • "agentId": 0,
  • "kid": "string",
  • "deleted": true,
  • "deletedAt": "2019-08-24T14:15:22Z"
}

Delete wallet

Remove a wallet from the records

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the wallet

Responses

Response samples

Content type
application/json
{
  • "errors": "invalid.permissions"
}

Get Wallet's balance

Retrieve a wallet's balance by its ID.

Authorizations:
bearerAuth
path Parameters
id
required
number

The ID of the wallet to retrieve.

query Parameters
layers
string

Comma-separated list of layers

date
string

Responses

Response samples

Content type
application/json
{
  • "balance": 10.15
}

Get Wallet's Cashout balance

Retrieve a wallet's cashout balance by its ID.

Authorizations:
bearerAuth
path Parameters
id
required
string

The ID of the wallet to retrieve.

query Parameters
layers
string

Comma-separated list of layers

date
string
type
required
string

Transaction type used to calculate fees

Responses

Response samples

Content type
application/json
{
  • "balance": 9.15
}

Credit a Wallet

Given the wallet ID, add credit to a wallet.

Authorizations:
bearerAuth
path Parameters
id
required
number

The ID of the wallet to retrieve.

Request Body schema: application/json
description
string
amount
required
number
currency
required
string^[0-9]{1,4}$
rrn
required
string^[a-zA-Z0-9]{1,12}$

Alphanumeric string, length 12

object
object
interface
string
address
string
type
required
string
realId
string
birthDate
string
phone
string
posAtmCode
string <= 12 characters
posAtm
string^[a-zA-Z0-9]{1,8}$

Alphanumeric string, length 8

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "amount": 0,
  • "currency": "string",
  • "rrn": "string",
  • "geoLocation": {
    },
  • "financialEntityData": {
    },
  • "interface": "string",
  • "address": "string",
  • "type": "string",
  • "realId": "string",
  • "birthDate": "string",
  • "phone": "string",
  • "posAtmCode": "string",
  • "posAtm": "string"
}

Response samples

Content type
application/json
{
  • "fees": [
    ],
  • "amountWithFees": 0
}

Debit a Wallet

Given the wallet ID, create a debit to the wallet.

Authorizations:
bearerAuth
path Parameters
id
required
number

The ID of the wallet to retrieve.

Request Body schema: application/json
description
string
amount
required
number
currency
required
string

Comma-separated string of layers

rrn
required
string^[a-zA-Z0-9]{1,12}$

Alphanumeric string, length 12

object
object
object
posAtm
string^[a-zA-Z0-9]{1,8}$

Alphanumeric string, length 8

type
required
string
pin
string
posAtmCode
string <= 12 characters
realId
string
birthDate
string
interface
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "amount": 0,
  • "currency": "string",
  • "rrn": "string",
  • "geoLocation": {
    },
  • "financialEntityData": {
    },
  • "operationAdditionalInfo": {
    },
  • "posAtm": "string",
  • "type": "string",
  • "pin": "string",
  • "posAtmCode": "string",
  • "realId": "string",
  • "birthDate": "string",
  • "interface": "string"
}

Response samples

Content type
application/json
{
  • "fees": [
    ],
  • "amountWithFees": 0
}

Transfer from Wallet to Wallet

Create transfer transaction between two wallets.

Authorizations:
bearerAuth
path Parameters
sourceWallet
required
string

The id of the wallet to retrieve.

destinationWallet
required
string

The id of the wallet to retrieve.

Request Body schema: application/json
description
string
amount
required
number
currency
required
string

Comma-separated string of layers

rrn
required
string^[a-zA-Z0-9]{1,12}$

Alphanumeric string, length 12

object
object
agentId
string
realId
string
birthDate
string
phone
string
pin
required
string
interface
string
type
required
string

Responses

Request samples

Content type
application/json
{
  • "amount": 200,
  • "currency": "3600",
  • "description": "test",
  • "rrn": "{{$randomAlphaNumeric}}",
  • "geoLocation": {
    },
  • "type": "test",
  • "realId": "0981383649",
  • "pin": "1234"
}

Response samples

Content type
application/json
{
  • "fees": [
    ],
  • "amountWithFees": 0
}

Get a list of a wallet's tranlog entries

Returns the TranLog entries of a specified wallet.

Authorizations:
bearerAuth
path Parameters
id
required
number

The ID of the wallet to retrieve.

query Parameters
limit
integer

Maximum number of results to return

offset
integer

Number of results to skip

startDate
string (dateFormat) ^((19|20)\d\d)-(0[1-9]|1[012])-(0[1-9]|[12][0...

Start date for filtering tranlogs

endDate
string (dateFormat) ^((19|20)\d\d)-(0[1-9]|1[012])-(0[1-9]|[12][0...

End date for filtering tranlogs

itcs
string

Comma-separated list of itcs for filtering tranlogs

ircs
string

Comma-separated list of ircs for filtering tranlogs

tags
string

Comma-separated list of tags for filtering tranlogs

Responses

Response samples

Content type
application/json
{
  • "total": 2,
  • "limit": 10,
  • "offset": 0,
  • "data": [
    ]
}

Get a wallet's full statement

Returns the entries between start and end date chronologically ordered.

Authorizations:
bearerAuth
path Parameters
id
required
number

The ID of the wallet to retrieve.

query Parameters
itc
string

Comma-separated string of ITCs that should be included

length
number

Amount of entries wanted (default: 5)

start
string

Start date (yyyy-MM-dd)

end
string

End date (yyyy-MM-dd)

asc
boolean

True if entries should be ordered by ID ascending (default: false)

layers
required
string

Comma-separated string of layers.

order
string

asc/desc. Ascending or descending order by id.

Responses

Response samples

Content type
application/json
{
  • "accountCode": "23.0981188126",
  • "description": "Customer: 0981188126 (test test) Wallet: 0981188126",
  • "journalCode": "jcard",
  • "debits": 0,
  • "credits": 200,
  • "initialBalance": 0,
  • "finalBalance": 200,
  • "start": "Sun Feb 01 00:00:00 UYT 1970",
  • "end": "Sun Jan 31 23:59:59 UYT 2100",
  • "layers": [
    ],
  • "entries": [
    ]
}

Link Wallet to Customer

Given the wallet's ID and customer's realId, link the wallet to the customer

Authorizations:
bearerAuth
path Parameters
id
required
number

The ID of the wallet to retrieve.

Request Body schema: application/json
realId
required
string

Responses

Request samples

Content type
application/json
{
  • "realId": "099111222"
}

Response samples

Content type
application/json
{
  • "error": "wallet.not.found",
  • "success": false
}

Change Wallet's PIN

Given the wallet ID, change the PIN

Authorizations:
bearerAuth
path Parameters
id
required
number

The ID of the wallet to retrieve.

Request Body schema: application/json
pin
required
string

Responses

Request samples

Content type
application/json
{
  • "pin": "1234"
}

Response samples

Content type
application/json
{
  • "error": "wallet.not.found",
  • "success": false
}

Block Wallet

Block the wallet with the given ID

Authorizations:
bearerAuth
path Parameters
id
required
number

The ID of the wallet to retrieve.

Responses

Response samples

Content type
application/json
{
  • "error": "wallet.not.found",
  • "success": false
}

Unblock Wallet

Unblock the wallet with the given ID

Authorizations:
bearerAuth
path Parameters
id
required
number

The ID of the wallet to retrieve.

Responses

Response samples

Content type
application/json
{
  • "error": "wallet.not.found",
  • "success": false
}

TranLog

Transaction log management

Get all tranlogs

Retrieve all TranLog based on the filters

Authorizations:
bearerAuth
query Parameters
startDate
string

Start date for filtering tranlogs

endDate
string

End date for filtering tranlogs

itcs
string

Comma-separated list of itcs for filtering tranlogs

ircs
string

Comma-separated list of ircs for filtering tranlogs

rrn
string

Comma-separated list of rrn values for filtering tranlogs

cards
string

Comma-separated list of cards for filtering tranlogs

limit
integer

Maximum number of results to return

offset
integer

Number of results to skip

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "hasNext": true,
  • "data": [
    ]
}

Get Transaction Log by ID

Retrieves the specified transaction by its unique ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the tranLog entry

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "node": "string",
  • "rrn": "string",
  • "amount": 0,
  • "fees": 0,
  • "reversalCount": 0,
  • "responseCode": "string",
  • "captureDate": "string",
  • "itc": "string",
  • "ssData": { },
  • "returnedBalances": 0,
  • "currencyCode": "string",
  • "wallet": "string",
  • "customer": "string",
  • "agent": "string",
  • "wallet2": "string",
  • "customer2": "string",
  • "agent2": "string",
  • "additionalData": { },
  • "geoLocation": { },
  • "transaction": {
    }
}

Get Transaction Log by RRN

Retrieves the specified transaction

Authorizations:
bearerAuth
path Parameters
rrn
required
string

RRN of the tranlog to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "node": "string",
  • "rrn": "string",
  • "amount": 0,
  • "fees": 0,
  • "reversalCount": 0,
  • "responseCode": "string",
  • "captureDate": "string",
  • "itc": "string",
  • "ssData": { },
  • "returnedBalances": 0,
  • "currencyCode": "string",
  • "wallet": "string",
  • "customer": "string",
  • "agent": "string",
  • "wallet2": "string",
  • "customer2": "string",
  • "agent2": "string",
  • "additionalData": { },
  • "geoLocation": { },
  • "transaction": {
    }
}

Post transaction reversal

Posts a reversal for the given transaction

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of the tranlog to reverse

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "node": "string",
  • "rrn": "string",
  • "amount": 0,
  • "fees": 0,
  • "reversalCount": 0,
  • "responseCode": "string",
  • "captureDate": "string",
  • "itc": "string",
  • "ssData": { },
  • "returnedBalances": 0,
  • "currencyCode": "string",
  • "wallet": "string",
  • "customer": "string",
  • "agent": "string",
  • "wallet2": "string",
  • "customer2": "string",
  • "agent2": "string",
  • "additionalData": { },
  • "geoLocation": { },
  • "transaction": {
    }
}

Claim a transaction

Reverses transaction from pending layer and applies it on real layer

Authorizations:
bearerAuth
path Parameters
id
required
string

ID of the tranlog to claim

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "localId": 0,
  • "node": "string",
  • "acquirer": "string",
  • "mid": "string",
  • "tid": "string",
  • "stan": "string",
  • "rrn": "string",
  • "lifecycleIndicator": "string",
  • "lifecycleTrace": "string",
  • "lifecycleSequence": "string",
  • "lifecycleAuthToken": "string",
  • "responseCode": "string",
  • "approvalNumber": "string",
  • "displayMessage": "string",
  • "currencyCode": "string",
  • "functionCode": "string",
  • "reasonCode": "string",
  • "fileName": "string",
  • "reversalId": 0,
  • "reversalCount": 0,
  • "completionId": 0,
  • "completionCount": 0,
  • "voidId": 0,
  • "voidCount": 0,
  • "date": "string",
  • "transmissionDate": "string",
  • "localTransactionDate": "string",
  • "captureDate": "string",
  • "settlementDate": "string",
  • "batchNumber": 0,
  • "itc": "string",
  • "originalItc": "string",
  • "irc": "string",
  • "amount": 0,
  • "additionalAmount": 0,
  • "replacementAmount": 0,
  • "acquirerFee": 0,
  • "issuerFee": 0,
  • "returnedBalances": "string",
  • "rc": "string",
  • "extrc": "string",
  • "ss": "string",
  • "ssData": "string",
  • "mcc": "string",
  • "duration": 0,
  • "outstanding": 0,
  • "refId": 0,
  • "cardHolder": {
    },
  • "card": {
    },
  • "card2": {
    },
  • "account": {
    },
  • "account2": {
    },
  • "wallet": {
    },
  • "wallet2": {
    },
  • "glTransaction": {
    },
  • "cardAcceptor": {
    },
  • "geoLocation": "string",
  • "followUps": [
    ],
  • "additionalData": { },
  • "tags": "string",
  • "deleted": true,
  • "atc": 0,
  • "presentmentId": 0,
  • "presentmentCount": 0
}

Get statistics

Retrieve various metrics and statistics based on the provided parameters and metrics list

Authorizations:
bearerAuth
query Parameters
startDate
string <date>

Start date for the statistics period

endDate
string <date>

End date for the statistics period

cards
string

Comma-separated list of card tokens

Request Body schema: application/json
metrics
required
Array of strings
Items Enum: "group_by_<field>" "total_amount" "transactions_count" "approved_transactions[_with_sum]" "reversed_transactions[_with_sum]" "voided_transactions[_with_sum]" "pending_transactions[_with_sum]" "transactions_by_<range>"

List of metrics to retrieve. Supported patterns:

  • group_by_: Group results by a specific field
  • total_amount: Sum of the amounts of the transactions
  • transactions_count: Total number of transactions
  • approved_transactions[_with_sum]: Approved transactions (optionally with sum)
  • reversed_transactions[_with_sum]: Reversed transactions (optionally with sum)
  • voided_transactions[_with_sum]: Voided transactions (optionally with sum)
  • pending_transactions[_with_sum]: Pending transactions (optionally with sum)
  • transactions_by_: Transactions grouped by a specific range (e.g., day, week, month)

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "total": 0,
  • "hasNext": true,
  • "data": [
    ]
}

Customers

Customers/Cardholders management

Create a Customer

Creates a new customer based on the body

Authorizations:
bearerAuth
query Parameters
wallet
required
string
Value: "no"

Specify 'no' to create a customer without associating with a wallet.

Request Body schema: application/json
Any of
realId
required
string
active
boolean
startDate
string
endDate
string
honorific
string
gender
any
Enum: "f" "m"
firstName
required
string
middleName
string
lastName
required
string
lastName2
string
email
string
address1
string
address2
string
city
string
state
string
zip
string
country
string
birthDate
string
notes
string
phone
required
string
walletCode
string^[a-zA-Z0-9][-_a-zA-Z0-9]{0,63}$
institutionId
required
string
currencyCodes
Array of integers

Responses

Request samples

Content type
application/json
{
  • "realId": "string",
  • "active": true,
  • "startDate": "string",
  • "endDate": "string",
  • "honorific": "string",
  • "gender": "f",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "lastName2": "string",
  • "email": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string",
  • "birthDate": "string",
  • "notes": "string",
  • "phone": "string",
  • "walletCode": "string",
  • "institutionId": "string",
  • "currencyCodes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 2623
}

Retrieve all customers

Get a list of all customers with detailed information.

Authorizations:
bearerAuth
query Parameters
limit
integer

The maximum number of items to return (pagination).

offset
integer

The number of items to skip for pagination.

pointer
string <base64>

A base64 encoded pointer to the last item shown. When provided, the list will start after this item. Do not use together with 'offset'.

q
string
Example: q=John* OR Smith

The search query string. Use '*' as a wildcard. The query syntax supports basic search operations.

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "hasNext": true,
  • "data": [
    ]
}

Retrieve a customer by ID

Get a customer by their unique ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

ID of the customer to retrieve

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "realId": "string",
  • "active": true,
  • "startDate": "string",
  • "endDate": "string",
  • "honorific": "string",
  • "gender": "string",
  • "firstName": "string",
  • "middleName": "string",
  • "lastName": "string",
  • "lastName2": "string",
  • "email": "string",
  • "address1": "string",
  • "address2": "string",
  • "city": "string",
  • "state": "string",
  • "zip": "string",
  • "country": "string",
  • "birthDate": "string",
  • "notes": "string",
  • "phone": "string",
  • "searchPath": "string",
  • "issuerId": 0
}

Get customer's balance

Get the balance of all of the customer accounts.

Authorizations:
bearerAuth
path Parameters
id
required
string

the customer's id

Responses

Response samples

Content type
application/json
[
  • {
    },
  • {
    }
]

Get customer's cards

Retrieve a list of customer's cards.

Authorizations:
bearerAuth
path Parameters
id
required
string

the customer's id

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "hasNext": true,
  • "data": [
    ]
}

Create CardHolder Prepaid Card

Create a prepaid card for cardholder

Authorizations:
bearerAuth
path Parameters
id
required
string

the customer's realId

Request Body schema: application/json
cardProduct
required
string
expiration
string^[0-9]{6}$

Expiration in yyyyMM format

Responses

Request samples

Content type
application/json
{
  • "cardProduct": "string",
  • "expiration": "string"
}

Response samples

Content type
application/json
{
  • "id": 2697
}

Agents

Agents management

Create new Agent

Creates a new Agent based on the schema

Authorizations:
bearerAuth
query Parameters
wallet
boolean

Boolean indicating whether to create a wallet or not. Accepts true/false (default: false)

Request Body schema: application/json
id
integer
name
required
string
parentId
number
phone
required
string
type
string
fundingAccountId
string
active
boolean
mcc
string

Responses

Request samples

Content type
application/json
{
  • "name": "TestAgent",
  • "phone": "2232323232",
  • "type": "PDV",
  • "account": "11.11111"
}

Response samples

Content type
application/json
{
  • "walletId": "string",
  • "agentId": "string",
  • "pin": "string"
}

Get all agents

Retrieve all agents in the system

Authorizations:
bearerAuth
query Parameters
limit
integer
offset
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update Agent

Updates data of existing Agent

Authorizations:
bearerAuth
path Parameters
id
required
string

the agent's id

Request Body schema: application/json
name
string
parentId
number
type
string
account
string
active
boolean
mcc
string
phone
string

Responses

Request samples

Content type
application/json
{
  • "name": "Agent 1",
  • "type": "PDV",
  • "account": "11.11111"
}

Response samples

Content type
application/json
{
  • "errors": "invalid.permissions"
}

Get agent by id

Retrieve an agent by id

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the agent

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Card Products

Card Product management

Create Card Product

Create a new card product with the provided information.

Authorizations:
bearerAuth
Request Body schema: application/json
name
required
string <= 40 characters
code
required
string
endDate
string <date>

Date in yyyy-MM-dd

startDate
string <date>

Date in yyyy-MM-dd

active
required
boolean
atm
required
boolean
pos
required
boolean
moto
required
boolean
ecommerce
required
boolean
tips
required
boolean
anonymous
required
boolean
issuerId
required
integer
issuedAccountCode
string
feeAccountCode
string
lossesAccountCode
string
externalAccount
string
bin
string
smart
boolean
randomCardNumber
boolean
scheme
string
cardType
string
renewable
boolean
expAfterMonth
integer
panLength
integer
panStart
string
panEnd
string
transactionTypes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "Demo Card",
  • "code": "12345AB12C",
  • "issuerId": 67,
  • "active": true,
  • "anonymous": false,
  • "bin": "123456",
  • "randomCardNumber": false,
  • "atm": true,
  • "ecommerce": true,
  • "moto": false,
  • "pos": true,
  • "tips": true,
  • "smart": true,
  • "startDate": "2023-08-01",
  • "endDate": "2023-12-31",
  • "panLength": 16
}

Response samples

Content type
application/json
{
  • "id": 2773,
  • "name": "Olive Card",
  • "code": "123454",
  • "active": true,
  • "anonymous": false,
  • "bin": "123456",
  • "randomCardNumber": false,
  • "allowAtm": true,
  • "allowEcommerce": true,
  • "allowMoto": false,
  • "allowPos": true,
  • "allowTips": true,
  • "smart": true,
  • "startDate": "2023-08-01T00:00:00.000Z",
  • "endDate": "2023-12-31T00:00:00.000Z",
  • "issuer": 67,
  • "institutionId": "00000000001",
  • "issuedAccount": "11.001.123454",
  • "feeAccount": "31.001.123454",
  • "lossesAccount": "41.001.123454",
  • "panLength": 16
}

Get all card products

Retrieve a list of card products based on various filters.

Authorizations:
bearerAuth
query Parameters
cardType
string

Filter by card types

scheme
string

Filter by schemes

atm
boolean

Filter by ATM

pos
boolean

Filter by POS

moto
boolean

Filter by Moto

tips
boolean

Filter by tips

ecommerce
boolean

Filter by E-commerce

anonymous
boolean

Filter by anonymity

smart
boolean

Filter by smart cards

limit
integer

Number of results to return

offset
integer

Number of results to skip

pointer
string <base64>

A base64 encoded pointer to the last item shown. When provided, the list will start after this item. Do not use together with 'offset'.

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "hasNext": true,
  • "data": [
    ]
}

Get card product by ID

Retrieve a card product by its unique ID.

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the card product

Responses

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "endDate": "2019-08-24",
  • "startDate": "2019-08-24",
  • "active": true,
  • "atm": true,
  • "pos": true,
  • "moto": true,
  • "ecommerce": true,
  • "tips": true,
  • "anonymous": true,
  • "issuerId": 0,
  • "issuedAccountCode": "string",
  • "feeAccountCode": "string",
  • "lossesAccountCode": "string",
  • "externalAccount": "string",
  • "bin": "string",
  • "smart": true,
  • "randomCardNumber": true,
  • "scheme": "string",
  • "cardType": "string",
  • "renewable": true,
  • "expAfterMonth": 0,
  • "panLength": 0,
  • "panStart": "string",
  • "panEnd": "string",
  • "transactionTypes": [
    ]
}

Update Card Product

Update card product's information

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the card product

Request Body schema: application/json
name
string <= 40 characters
code
string
endDate
string\\d{4}-\\d{2}-\\d{2}

Date in yyyy-MM-dd format

startDate
string\\d{4}-\\d{2}-\\d{2}

Date in yyyy-MM-dd format

active
boolean
atm
boolean
pos
boolean
moto
boolean
ecommerce
boolean
tips
boolean
anonymous
boolean
issuedAccountCode
string
feeAccountCode
string
lossesAccountCode
string
externalAccount
string
bin
string
smart
boolean
randomCardNumber
boolean
scheme
string
cardType
string
renewable
boolean
expAfterMonth
integer
panLength
integer
panStart
string
panEnd
string
transactionTypes
Array of strings

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "code": "string",
  • "endDate": "string",
  • "startDate": "string",
  • "active": true,
  • "atm": true,
  • "pos": true,
  • "moto": true,
  • "ecommerce": true,
  • "tips": true,
  • "anonymous": true,
  • "issuedAccountCode": "string",
  • "feeAccountCode": "string",
  • "lossesAccountCode": "string",
  • "externalAccount": "string",
  • "bin": "string",
  • "smart": true,
  • "randomCardNumber": true,
  • "scheme": "string",
  • "cardType": "string",
  • "renewable": true,
  • "expAfterMonth": 0,
  • "panLength": 0,
  • "panStart": "string",
  • "panEnd": "string",
  • "transactionTypes": [
    ]
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "code": "string",
  • "endDate": "2019-08-24",
  • "startDate": "2019-08-24",
  • "active": true,
  • "atm": true,
  • "pos": true,
  • "moto": true,
  • "ecommerce": true,
  • "tips": true,
  • "anonymous": true,
  • "issuerId": 0,
  • "issuedAccountCode": "string",
  • "feeAccountCode": "string",
  • "lossesAccountCode": "string",
  • "externalAccount": "string",
  • "bin": "string",
  • "smart": true,
  • "randomCardNumber": true,
  • "scheme": "string",
  • "cardType": "string",
  • "renewable": true,
  • "expAfterMonth": 0,
  • "panLength": 0,
  • "panStart": "string",
  • "panEnd": "string",
  • "transactionTypes": [
    ]
}

Get card product's velocity profiles

Retrieve all the velocity profiles associated to the card product

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the card product

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add or remove card product's velocity profiles

Update which velocity profiles are associated to the card product

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the card product

Request Body schema: application/json
velocityProfiles
Array of integers

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Get card product's fees

Retrieve all the fees associated to the card product

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the card product

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add or remove card product's fees

Update which fees are associated to the card product

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the card product

Request Body schema: application/json
fees
Array of integers

Responses

Request samples

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

Response samples

Content type
application/json
[
  • {
    }
]

Cards

Card management

Create a new card

Create a new card with the provided information.

Authorizations:
bearerAuth
Request Body schema: application/json
One of
cardHolder
string

CardHolder's id.

cardProduct
required
string

CardProduct's id.

bin
required
string^[0-9]{6}$|^[0-9]{8}$

Numeric string, length 6 or 8

pan
string^[0-9]{13,19}$

Numeric string, lengths 13-19

track1
string^[%]?[A-Z]+([0-9]{1,19})\\^([^\\^]{2,26})\\^(...

Credit/Debit card Track 1 pattern

track2
string^([0-9]{1,19})[=D]([0-9]{4})([0-9]{3})?([0-9]...

Credit/Debit card Track 2 pattern

expiration
required
string^([0-9]{4}(0[0-9]|1[0-2]))$

Expiration date numeric

serviceCode
required
string^[0-9]{3}$

Service code three digit numeric

embossingName
string
virtual
boolean
smart
boolean
accountCode
string

Responses

Request samples

Content type
application/json
{
  • "cardHolder": 32,
  • "cardProduct": 134,
  • "bin": "455566",
  • "expiration": "201805",
  • "serviceCode": "220",
  • "embossingName": "John",
  • "virtual": true,
  • "smart": true
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "lastFour": "string",
  • "pinEnabled": true,
  • "status": "string"
}

Get cards

Get all cards available in the system

Authorizations:
bearerAuth
query Parameters
limit
integer

The maximum number of items to return (pagination).

offset
integer

The number of items to skip for pagination.

pointer
string <base64>

A base64 encoded pointer to the last item shown. When provided, the list will start after this item. Do not use together with 'offset'.

startExpirationDate
string

Start date for filtering cards by expiration date.

endExpirationDate
string

End date for filtering cards by expiration date.

cardHolders
string

Comma-separated list of card holder IDs for filtering.

cardProducts
string

Comma-separated list of card product IDs for filtering.

states
string

Comma-separated list of card states for filtering.

lastFour
string

Comma-separated list of cards' last four for filtering.

Responses

Response samples

Content type
application/json
{
  • "total": 2,
  • "limit": 10,
  • "offset": 0,
  • "data": [
    ]
}

Get card

Get card information based on the token

Authorizations:
bearerAuth
path Parameters
token
required
string

The unique token for the card

Responses

Response samples

Content type
application/json
{
  • "id": 2700,
  • "bin": "455566",
  • "lastFour": "9790",
  • "token": "98435bf9-a1ee-467d-89af-e802a4da2188",
  • "state": "ACTIVE",
  • "startDate": "2023-10-25",
  • "endDate": "2018-05-31",
  • "cardHolder": {
    },
  • "cardProduct": {
    },
  • "smart": false,
  • "virtual": true,
  • "embossingName": "John"
}

Update card

Update card information based on input

Authorizations:
bearerAuth
path Parameters
token
required
string

The unique token for the card

Request Body schema: application/json
cardProduct
number
expiration
string^[0-9]{4}(0[0-9]|1[0-2])$

Expiration date numeric

virtual
boolean
smart
boolean

Responses

Request samples

Content type
application/json
{
  • "virtual": true
}

Response samples

Content type
application/json
{
  • "errors": "invalid.token"
}

Credit a card

Post a credit transaction to the given card

Authorizations:
bearerAuth
path Parameters
token
required
string

The unique token for the card

Request Body schema: application/json
currency
required
number
amount
required
number >= 0
rrn
required
string^[a-zA-Z0-9]{1,12}$

Alphanumeric string, length 12

description
string
channel
string
invoice
string
reason
string

Responses

Request samples

Content type
application/json
{
  • "currency": 840,
  • "amount": 100.5,
  • "description": "Payment for services",
  • "channel": "Online",
  • "invoice": "INV12345",
  • "reason": "Monhtly subscription",
  • "rrn": "AB12XYZ"
}

Response samples

Content type
application/json
{
  • "APPROVAL_NUMBER": "720351",
  • "ITC": "cardrest::credit",
  • "RESULT_CODE": "0000"
}

Transfer from card to card

Post a transfer transaction between two cards

Authorizations:
bearerAuth
Request Body schema: application/json
recipient
required
string non-empty
sender
required
string non-empty
currency
required
number
amount
required
number >= 0
reference
string [ 1 .. 250 ] characters
rrn
required
string^[a-zA-Z0-9]{1,12}$

Alphanumeric string, length 12

reason
string [ 1 .. 250 ] characters
channel
string non-empty
description
string

Responses

Request samples

Content type
application/json
{
  • "recipient": "cb29ad3f",
  • "sender": "98435bf9",
  • "currency": 3600,
  • "amount": 10.5,
  • "reference": "Payment for services",
  • "rrn": "AB12XYZ",
  • "reason": "Monthly subscription",
  • "channel": "Online",
  • "description": "Transfer from sender to recipient"
}

Response samples

Content type
application/json
{
  • "APPROVAL_NUMBER": "720351",
  • "ITC": "cardrest::transf",
  • "RESULT_CODE": "0000"
}

Debit a card

Post a debit transaction to the given card

Authorizations:
bearerAuth
path Parameters
token
required
string

The unique token for the card

Request Body schema: application/json
currency
required
number
amount
required
number >= 0
rrn
required
string^[a-zA-Z0-9]{1,12}$

Alphanumeric string, length 12

description
string
channel
string
invoice
string
reason
string

Responses

Request samples

Content type
application/json
{
  • "currency": 840,
  • "amount": 100.5,
  • "description": "Payment for services",
  • "channel": "Online",
  • "invoice": "INV12345",
  • "reason": "Monhtly subscription",
  • "rrn": "AB12XYZ"
}

Response samples

Content type
application/json
{
  • "APPROVAL_NUMBER": "720351",
  • "ITC": "cardrest::debit",
  • "RESULT_CODE": "0000"
}

Update card state

Change card's state to given one

Authorizations:
bearerAuth
path Parameters
token
required
string

The unique token for the card

Request Body schema: application/json
cardState
required
string
Enum: "nonactivated" "active" "suspended" "lost" "stolen" "fraud" "compliance" "debt" "created" "issued" "deleted" "expired" "cancelled"

Responses

Request samples

Content type
application/json
{
  • "cardState": "lost"
}

Response samples

Content type
application/json
{
  • "errors": "invalid.change"
}

Activate card

Change the given card's state to active

Authorizations:
bearerAuth
path Parameters
token
required
string

The unique token for the card

Responses

Response samples

Content type
application/json
{
  • "errors": "invalid.change"
}

Change card's PIN

Change the given card's pin to new one

Authorizations:
bearerAuth
path Parameters
token
required
string

The unique token for the card

Request Body schema: application/json
newPIN
required
string >= 16 characters ^[A-Z0-9]*$
oldPIN
required
string >= 16 characters ^[A-Z0-9]*$

Responses

Request samples

Content type
application/json
{
  • "newPIN": "stringstringstri",
  • "oldPIN": "stringstringstri"
}

Response samples

Content type
application/json
{
  • "errors": "invalid.change"
}

Assing account

Assign an account to the given card

Authorizations:
bearerAuth
path Parameters
token
required
string

The unique token for the card

Request Body schema: application/json
accountCode
required
string

Responses

Request samples

Content type
application/json
{
  • "accountCode": "23.001.00"
}

Response samples

Content type
application/json
{
  • "errors": "invalid.change"
}

Assign cardholder

Assign a cardholder to the given card

Authorizations:
bearerAuth
path Parameters
token
required
string

The unique token for the card

Request Body schema: application/json
cardholderRealId
required
string

Responses

Request samples

Content type
application/json
{
  • "cardholderRealId": "23.001.00"
}

Response samples

Content type
application/json
{
  • "errors": "invalid.change"
}

Get card's balance

Given the card's token, get the balance

Authorizations:
bearerAuth
path Parameters
token
required
string

The unique token for the card

Responses

Response samples

Content type
application/json
{
  • "date": "2023-11-06",
  • "layers": "840",
  • "balance": 1000.5,
  • "journalCode": "jcard",
  • "accountCode": "23.000.01"
}

Velocity Profiles

Velocity profile management

Get all velocity profiles

Retrieve all velocity profiles in the system

Authorizations:
bearerAuth
query Parameters
scopeCard
boolean
scopeAccount
boolean
scopeMonthly
boolean
scopeDaily
boolean
numberOfDays
integer
currencyCode
string
cardProducts
string
limit
integer
offset
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new velocity profile

Create a new velocity profile with the provided information

Authorizations:
bearerAuth
Request Body schema: application/json
name
required
string
usageLimit
integer
active
boolean
approvalsOnly
boolean
scopeCard
boolean
scopeAccount
boolean
validOnPurchase
boolean
validOnWithdrawal
boolean
validOnTransfer
boolean
validOnCredit
boolean
currencyCode
required
string
amountLimit
required
number
numberOfDays
integer
scopeMonthly
boolean
scopeDaily
boolean

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "usageLimit": 0,
  • "active": true,
  • "approvalsOnly": true,
  • "scopeCard": true,
  • "scopeAccount": true,
  • "validOnPurchase": true,
  • "validOnWithdrawal": true,
  • "validOnTransfer": true,
  • "validOnCredit": true,
  • "currencyCode": "string",
  • "amountLimit": 0,
  • "numberOfDays": 0,
  • "scopeMonthly": true,
  • "scopeDaily": true
}

Response samples

Content type
application/json
{
  • "id": 0,
  • "name": "string",
  • "usageLimit": 0,
  • "active": true,
  • "approvalsOnly": true,
  • "scopeCard": true,
  • "scopeAccount": true,
  • "validOnPurchase": true,
  • "validOnWithdrawal": true,
  • "validOnTransfer": true,
  • "validOnCredit": true,
  • "currencyCode": "string",
  • "amountLimit": 0,
  • "numberOfDays": 0,
  • "scopeMonthly": true,
  • "scopeDaily": true,
  • "cardProducts": [
    ]
}

Get velocity profile by id

Retrieve a velocity profile by id

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the velocity profile

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update velocity profile

Update a velocity profile's information

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the velocity profile

Request Body schema: application/json
id
integer
name
string
usageLimit
integer
active
boolean
approvalsOnly
boolean
scopeCard
boolean
scopeAccount
boolean
validOnPurchase
boolean
validOnWithdrawal
boolean
validOnTransfer
boolean
validOnCredit
boolean
currencyCode
string
amountLimit
number
numberOfDays
integer
scopeMonthly
boolean
scopeDaily
boolean

Responses

Request samples

Content type
application/json
{
  • "validOnWithdrawal": false
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete velocity profile

Remove a velocity profile from the records

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the velocity profile

Responses

Response samples

Content type
application/json
{
  • "errors": "invalid.permissions"
}

Fees

Fee management

Get all fees

Retrieve all fees in the system

Authorizations:
bearerAuth
query Parameters
cardProducts
string
limit
integer
offset
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create new fee

Create a new fee with the provided information

Authorizations:
bearerAuth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get fee by id

Retrieve a fee by id

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the fee

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update fee

Update a fee's information

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the fee

Request Body schema: application/json
id
integer
name
string
type
string
amount
number
startDate
string <date>
endDate
string <date>
startAmount
number
endAmount
number

Responses

Request samples

Content type
application/json
{
  • "validOnWithdrawal": false
}

Response samples

Content type
application/json
[
  • {
    }
]

Delete fee

Remove a fee from the records

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the fee

Responses

Response samples

Content type
application/json
{
  • "errors": "invalid.permissions"
}

Search

Search endpoint

Search for items

Given a query string, returns items containing it.

Authorizations:
bearerAuth
query Parameters
limit
integer

The maximum number of items to return (pagination).

offset
integer

The number of items to skip for pagination.

pointer
string <base64>

A base64 encoded pointer to the last item shown. When provided, the list will start after this item. Do not use together with 'offset'.

entities
string
Example: entities=cardholder,card_products

Specifies which entities to query. Multiple entities can be provided as a comma-separated list.

q
string
Example: q=John* OR Smith

The search query string. Use '*' as a wildcard. The query syntax supports basic search operations.

Responses

Response samples

Content type
application/json
{
  • "total": 0,
  • "limit": 0,
  • "offset": 0,
  • "hasNext": true,
  • "data": [
    ]
}

Issuer

Issuer Data

Get Issuer

Get all issuer available in the system

Authorizations:
bearerAuth
query Parameters
limit
integer

The maximum number of items to return (pagination).

offset
integer

The number of items to skip for pagination.

Responses

Response samples

Content type
application/json
{
  • "total": 1,
  • "limit": 10,
  • "offset": 0,
  • "data": {
    }
}

Revision

Get all revision history

Retrieve all revision history in the system

Authorizations:
bearerAuth
query Parameters
author
string

comma separated string of user ids

ref
string

comma separated string of entity_name.id

limit
integer
offset
integer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get revision by id

Retrieve a revision by id

Authorizations:
bearerAuth
path Parameters
id
required
integer

The unique ID of the revision history

Responses

Response samples

Content type
application/json
[
  • {
    }
]