Skip to main content
API docs by Redocly

CardManagement API (v1)

Download OpenAPI specification:Download

API for manage CardManagement (v1.155.0)

Account

GetAccount

Get a single accounr using its id

path Parameters
id
required
string <uuid>

Identifier of account

Responses

Response samples

Content type
No sample

UpdateAccount

Updates an existing account

path Parameters
id
required
string <uuid>

Identifier of account

Request Body schema:

Request for update account

feeProfile
required
string [ 1 .. 255 ] characters

Profile of applied fees

accountProfile
required
string [ 1 .. 255 ] characters

Profile of account

externalReference
required
string [ 1 .. 255 ] characters

Reference on external system (optional)

productCode
required
string [ 1 .. 255 ] characters

Product Code

Array of objects or null (AccountLimitRequest)

Limits on account (NOT SUPPORTED FOR NOW, must be empty or null!)

Responses

Request samples

Content type
{
  • "feeProfile": "string",
  • "accountProfile": "string",
  • "externalReference": "string",
  • "productCode": "string",
  • "limits": [
    ]
}

Response samples

Content type
No sample

DeleteAccount

Delete an existing account

path Parameters
id
required
string <uuid>

Identifier of account

Responses

Response samples

Content type
No sample

GetAccountCards

Get list of cards available on a single account

path Parameters
id
required
string <uuid>

Id of account

query Parameters
pageSize
integer <int32>
Default: 50

Size of page

pageNumber
integer <int32>
Default: 0

Number of page

Responses

Response samples

Content type
No sample

CreateCard

Create a new card for a specified account

path Parameters
id
required
string <uuid>

Id of customer

Request Body schema:
required

Card details

productCode
required
string [ 1 .. 255 ] characters

Code of card product on Card Processor (ex. "IssuerDebit")

nameOnCard
required
string [ 1 .. 255 ] characters

Name on card (ex. "JOHN DOE")

limitProfile
required
string [ 1 .. 255 ] characters

Profile on limit of card (optional)

barCode
required
string [ 1 .. 255 ] characters

Barcode associated with card (optional)

financialReference
required
string non-empty

Financial reference connected with card (optional, can ben wallet identifier, or an account identifier)

externalReference
required
string [ 1 .. 255 ] characters

Reference on external system (optional)

object or null

Creates a new card ad a replacement of (NOT SUPPORTED FOR NOW, must be empty of null!) an older one

object or null

Defines the address for delivery of the card (NOT SUPPORTED FOR NOW, must be empty of null!)

Array of objects or null (CardLimitRequest)

Limits on card (NOT SUPPORTED FOR NOW, must be empty of null!)

Responses

Request samples

Content type
{
  • "productCode": "string",
  • "nameOnCard": "string",
  • "limitProfile": "string",
  • "barCode": "string",
  • "financialReference": "string",
  • "externalReference": "string",
  • "replacement": {
    },
  • "delivery": {
    },
  • "limits": [
    ]
}

Response samples

Content type
No sample

LockAccount

Lock a specified account

path Parameters
id
required
string <uuid>

Id of account

query Parameters
lockType
required
string

Lock type

level
required
string

Lock level

Responses

Response samples

Content type
No sample

UnlockAccount

Unlock a specified account

path Parameters
id
required
string <uuid>

Id of account

query Parameters
level
required
string

Lock level

Responses

Response samples

Content type
No sample

BlockAccount

Block a specified account

path Parameters
id
required
string <uuid>

Id of account

query Parameters
accountBlockRequestReasonCode
required
string

Reason code

Responses

Response samples

Content type
No sample

GetLockTypes

Get the list of valid lock types

Responses

Response samples

Content type
No sample

GetLevelTypes

Get the list of valid lock level types

Responses

Response samples

Content type
No sample

GetBlockReasonTypes

Get the list of valid block reason types

Responses

Response samples

Content type
No sample

Card

GetCard

Get a single card using its identifier

path Parameters
id
required
string <uuid>

Identifier of card

Responses

Response samples

Content type
No sample

UpdateCard

Updates an existing card

path Parameters
id
required
string <uuid>

Identifier of card

Request Body schema:

Request for update card

productCode
required
string [ 1 .. 255 ] characters

Product code

nameOnCard
required
string [ 1 .. 255 ] characters

Name on the card

limitProfile
required
string [ 1 .. 255 ] characters

Type of profile limit

barCode
required
string [ 1 .. 255 ] characters

Barcode associated with card

financialReference
required
string non-empty

Financial reference connected with card (can ben wallet identifier, or an account identifier)

externalReference
required
string [ 1 .. 255 ] characters

Reference on external system (optional)

Responses

Request samples

Content type
{
  • "productCode": "string",
  • "nameOnCard": "string",
  • "limitProfile": "string",
  • "barCode": "string",
  • "financialReference": "string",
  • "externalReference": "string"
}

Response samples

Content type
No sample

DeleteCard

Delete an existing card

path Parameters
id
required
string <uuid>

Identifier of card

Responses

Response samples

Content type
No sample

Customers

GetCustomers

Get list of customers available in scope

query Parameters
pageSize
integer <int32>
Default: 50

Size of page

pageNumber
integer <int32>
Default: 0

Number of page

Responses

Response samples

Content type
No sample

CreateCustomer

Creates a new customer

Request Body schema:

Request for create customer

type
required
string non-empty

Type of customer ("Citizen" or "LegalEntity")

code
required
string [ 1 .. 15 ] characters

Unique code of customer

taxNumber
string or null

Tax number (optional)

firstName
string or null

First name (required only for "Citizen")

lastName
string or null

Last name (required only for "Citizen")

shortName
string or null

Short name (required only for "LegalEntity")

longName
string or null

Long name (required only for "LegalEntity")

externalReference
string or null <= 255 characters

External reference

Responses

Request samples

Content type
{
  • "type": "string",
  • "code": "string",
  • "taxNumber": "string",
  • "firstName": "string",
  • "lastName": "string",
  • "shortName": "string",
  • "longName": "string",
  • "externalReference": "string"
}

Response samples

Content type
No sample

GetCustomer

Get a single customers using its id

path Parameters
id
required
string <uuid>

Identifier of customer

Responses

Response samples

Content type
No sample

UpdateCustomer

Updates an existing customer

path Parameters
id
required
string <uuid>

Identifier of customer

Request Body schema:

Request for update customer

customerId
string <uuid>

Unique identifier

firstName
string or null

First name (required only for "Citizen")

lastName
string or null

Last name (required only for "Citizen")

shortName
string or null

Short name (required only for "LegalEntity")

longName
string or null

Long name (required only for "LegalEntity")

externalReference
string or null

External reference

Responses

Request samples

Content type
{
  • "customerId": "87d8e330-2878-4742-a86f-dbbb3bf522ac",
  • "firstName": "string",
  • "lastName": "string",
  • "shortName": "string",
  • "longName": "string",
  • "externalReference": "string"
}

Response samples

Content type
No sample

GetCustomerAccounts

Get list of accounts available on a single customer

path Parameters
id
required
string <uuid>

Id of customer

query Parameters
pageSize
integer <int32>
Default: 50

Size of page

pageNumber
integer <int32>
Default: 0

Number of page

Responses

Response samples

Content type
No sample

CreateCustomerAccounts

Create a new account for a specified customer

path Parameters
id
required
string <uuid>

Id of customer

Request Body schema:
required

Account details

type
required
string non-empty

Type of account (ex. "Charge", "Loan", "Debit", "Prepaid")

productCode
required
string [ 1 .. 255 ] characters

Code of account product on Card Processor side (ex. "PKPK_CHRG_001")

accountNumber
required
string [ 1 .. 255 ] characters \d{1,10}$

Number of account (ex. "74050173") with maximum lenght of 10 numeric chars

feeProfile
required
string [ 1 .. 255 ] characters

Profile of applied fees

accountProfile
required
string [ 1 .. 255 ] characters

Profile of account

currency
required
string [ 1 .. 255 ] characters

Currency of account (ex. "EUR") in ISO 4217-Alpha 3 format

externalReference
required
string [ 1 .. 255 ] characters

Reference on external system (optional)

Array of objects or null (AccountLimitRequest)

Limits on account (NOT SUPPORTED FOR NOW, must be empty or null!)

Responses

Request samples

Content type
{
  • "type": "string",
  • "productCode": "string",
  • "accountNumber": "string",
  • "feeProfile": "string",
  • "accountProfile": "string",
  • "currency": "string",
  • "externalReference": "string",
  • "limits": [
    ]
}

Response samples

Content type
No sample

Diagnostics

GetDiagnosticsInfo

Get current platform diagnostics data

Responses

Response samples

Content type
No sample

Simulations

SimulateOnlineToIssuer

Simulate an incoming request (received by Card Processor) during O2I process

path Parameters
type
required
string

Type of online to issuer action

Request Body schema:

Request with details

transactionId
required
string [ 1 .. 255 ] characters

Unique transaction id provided by Card Processor

refTransactionId
string or null

Reference to a transaction previously processed (provided only if available)

transactionDateTime
string or null <date-time>

Date/time when transaction is performed

processDateTime
string or null <date-time>

Date/time when transaction is processed by Card Processor

transactionAmount
number or null <double>

Original transaction amount

transactionCurrency
integer or null <int32>

Original transaction currency (ISO 4217)

billingAmount
number or null <double>

Converted amount beeing charged

billingCurrency
integer or null <int32>

Converted currency being charged (ISO 4217)

terminalId
string or null

Terminal identifier (when available)

mcc
integer or null <int32>

Merchant Category Code

merchantId
string or null

Merchant identifier

merchantName
string or null

Merchant name

merchantStreet
string or null

Merchant street (when available)

merchantCity
string or null

Merchant city (when available)

merchantZip
string or null

Merchant ZIP (when available)

merchantCountry
integer or null <int32>

Merchant county (ISO 3166-1, when available)

cardToken
string or null

Unique card identifier. Will be generated by CMS through card creation API. The structure is as follows: 6 numbers BIN + token number + last 4 PAN digits

authorizationCode
string or null

6-digit authorization code, set by Card Processor when transaction passed all required checks. Included only with successful transactions

cardScheme
integer or null <int32>

Scheme for Card: 1 - Diners 2 - Discover 3 - Mastercard 4 - Visa

type
integer or null <int32>

Type of transaction 0 - Purchase 1 - ATM Withdrawal 6 - Card verification - inquiry 17 - Cash advance 20 - Refund/Credit/Payment 30 - Balance Inquiry on ATM 91 - PIN Unblock - info 92 - PIN Change - info 101 - Preauthorization (Mastercard only) 102 - Preauthorization Incremental (Mastercard only) 103 - Preauthorization Completion (Mastercard only) 107 - Transfer to Account (MoneySend) (Mastercard only) 108 - Transfer from Account (MoneySend) (Mastercard only)

stan
string or null

Transaction incremental number, provided by Mastercard, Diners International or Visa network. Provides an additional reference to original transaction

source
string or null

Transaction source M - Manual P - POS A - ATM I - E-commerce (Internet)

entryMode
integer or null <int32>

Entry mode, method used to enter card number 0 - Unknown or unspecified 1 - Manual 2 - Magstripe 3 - Barcode 5 - Chip 6 - Key entry 7 - Contactless Chip 9 - Chip fallback 10 - Credentials on file

authentication
integer or null <int32>

Authentication 0 - Transaction has not been authenticated 1 - Transaction has been authenticated 2 - Transaction authentication has been attempted. Attempt can be made by the card network or merchant

authenticationProtocol
integer or null <int32>

Authentication protocol 0 - Not applicable 1 - 3DS Version 1 2 - 3DS Version 2 or higher

scaExemption
integer or null <int32>

SCA Exemption 0 - Not requestes 1 - Merchant Initiated Transaction 2 - Acquirer Low-Fraud and Transaction Risk Analysis 3 - Low-Value Payment 4 - Strong Customer Authentication (SCA) Delegation 5 - Secure Corporate Payment 6 - Trusted Merchant Exemption

virtualCardNumberId
string or null

Virtual Card Number ID, provided by Card Processor "Card Virtualization System" (CVS). Provided only for card virtualized by CVS

wallet
integer or null <int32>

Wallet Provider 0 - None 1 - Apple Pay 2 - Google Pay 3 - Samsung Pay 4 - Garmin Pay 5 - FitBit Pay 10 - M4M (Merchant for Merchant)

pin
integer or null <int32>

PIN: Card present transaction authentication indicator 1 - Not performed 2 - Passed 3 - Failed

responseCode
string or null

Response code set by Card Processor. If success Issuer can change the authorization using response status

Responses

Request samples

Content type
{
  • "transactionId": "string",
  • "refTransactionId": "string",
  • "transactionDateTime": "2019-08-24T14:15:22Z",
  • "processDateTime": "2019-08-24T14:15:22Z",
  • "transactionAmount": 0.1,
  • "transactionCurrency": 0,
  • "billingAmount": 0.1,
  • "billingCurrency": 0,
  • "terminalId": "string",
  • "mcc": 0,
  • "merchantId": "string",
  • "merchantName": "string",
  • "merchantStreet": "string",
  • "merchantCity": "string",
  • "merchantZip": "string",
  • "merchantCountry": 0,
  • "cardToken": "string",
  • "authorizationCode": "string",
  • "cardScheme": 0,
  • "type": 0,
  • "stan": "string",
  • "source": "string",
  • "entryMode": 0,
  • "authentication": 0,
  • "authenticationProtocol": 0,
  • "scaExemption": 0,
  • "virtualCardNumberId": "string",
  • "wallet": 0,
  • "pin": 0,
  • "responseCode": "string"
}

Response samples

Content type
No sample