Schemas Postman

Card. Create POST

Create a Card

# ENDPOINT
/api/card/createCard/cardCreateRequest
# REQUEST arguments
Variable Value Example Usage Description
X-App-Sig
header
0 		DEV-SKIP DEV-SKIP M
# REQUEST BODY
# RESPONSE
# REQUEST arguments
Variable Name Type Format Usage Description
X-App-Sig X-App-Sig header string M
Example DEV-SKIP
# REQUEST BODY
Schema: cardCreateRequest
Type: object
Variable Name Type Format Usage Description
cardData cardData object
deliveryAddress deliveryAddress object
rules rules object
attribute: cardData
Variable Name Type Format Usage Description
account account string account
action Action string
activation_date Activation Date string DATE Activation date in the system
card_code card_code string Card code
card_programme Card programme string
card_scheme card_scheme string card scheme
card_status Card Status string Card Status
List of allowed values in field (value=>name):
  • 0
    CREATING
  • 1
    PENDING
card_type card_type string Type of card
List of allowed values in field (value=>name):
  • 0
    physical
  • 1
    virtual
carrier_type carrier_type string Type of carrier
List of allowed values in field (value=>name):
  • 0
    renewal
  • 1
    replacement
  • 2
    standard
client_code Client code string Unique client identifier. Issued automatically by the System upon new Customer registration.
close_date Close Date string DATE Client close date in the system
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
delivery_method delivery_method string Type of delivery method
List of allowed values in field (value=>name):
  • 0
    courier
  • 1
    dhl
  • 2
    international_mail
  • 3
    standard_first_class
delivery_name delivery_name string Delivery name
design_code design_code string Design code
email email string Email address of a given user
error_description Error Description string Description of error
expiry_date Expiry date string
external_id_in_scheme External id in scheme string
form_title form_title string Service field
full_delivery_address full_delivery_address string Full delivery address
full_name full_name string Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
holder_counterparty_code Holder counterparty code STRING
holder_counterparty_id Holder counterparty id INTEGER
holder_full_name Holder full name STRING
id id integer INT64 Record's sequence number generated in the system.
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
name_on_card name_on_card string Name on card
pan Pan string
state state integer INT64 Record state for replication
telephone Telephone STRING
token Token string
truncated_pan Truncated pan string
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
attribute: deliveryAddress
Variable Name Type Format Usage Description
action Action string
activation_date Activation Date string DATE Activation date in the system
address_type address_type string M The addresses section provides the list of all available addresses a contact has as follows
List of allowed values in field (value=>name):
  • 0
    DELIVERY
  • 1
    LEGAL
  • 2
    OTHER
  • 3
    PHYSICAL
  • 4
    STATEMENT
address_type_description address_type_description string M Address type description
apartment apartment string Residence/correspondence number of house
card_code card_code string M Card code
city city string Residence/ correspondence address city/town
client_code Client code string M Unique client identifier. Issued automatically by the System upon new Customer registration.
client_full_name client_full_name string Customer full name [first_name] and [last_name] for PERSON and [first_name] only for BUSINESS customer types respectively
counterparty_id counterparty_id integer INT64 M Counterparty id
country_code country_code string M Two-letter ISO 3166-2 code of a given country
country_description country_description string Country of residence or incorporation
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
expiration_date Expiration Date string DATE Expiration date in the system
form_title form_title string Service field
full_address full_address string Customer full address aggregates [Address Line 1], [Address Line 2], [City], [County], [Post Code] and [Country] fields
house house string Residence/correspondence number of house
house_name house_name string Residence/correspondence name of house
id id integer INT64 Record's sequence number generated in the system.
language language string The language user has specified as the language of service
latitude latitude number decimal A geographic coordinate that specifies the north–south position of a point on the Earth is surface
longitude longitude number decimal A geographic coordinate that specifies the east–west position of a point on the Earth is surface
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
place_code place_code string Residence/correspondence place code
post_code post_code string Shows the value of address postal code, zip code or post code, like CR2 9ER
region region string Residence/ correspondence region
region_code region_code string Region code
state state integer INT64 Record state for replication
street street string Residence/ correspondence name of street
sub_street sub_street string Residence/ correspondence name of substreet
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
attribute: rules
Variable Name Type Format Usage Description
action Action string
assigned_rule_id Assigned rule id INTEGER
body body string Body
card_code card_code string Card code
card_scheme card_scheme string card scheme
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
description description string Description of a given record
external_id External id STRING
form_title form_title string Service field
id id integer INT64 Record's sequence number generated in the system.
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
name name string Description of a given user
state state integer INT64 Record state for replication
type type string
List of allowed values in field (value=>name):
  • 0
    card-max-count-per-day
  • 1
    card-max-count-per-month
  • 2
    card-max-count-per-week
  • 3
    card-max-spend-per-day
  • 4
    card-max-spend-per-month
  • 5
    card-max-spend-per-transaction
  • 6
    card-max-spend-per-week
  • 7
    card-mcc-blacklist
  • 8
    card-mcc-whitelist
  • 9
    card-mid-blacklist
  • 10
    card-mid-whitelist
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# REQUEST BODY EXAMPLE
							{
  "cardData": {
    "account": "60003GF4030EURP",
    "name_on_card": "OLEGS SMIRNOVS",
    "card_type": "physical",
    "carrier_type": "standard",
    "delivery_method": "dhl",
    "delivery_name": "",
    "design_code": "DESIGN1"
  },
  "deliveryAddress": {
    "language": "EN",
    "city": "RIGA",
    "street": "PERNAVAS",
    "house": "44",
    "post_code": "LV-1054",
    "country_code": "LV"
  }
}
# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: cardRequest
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object data of Response
attribute: data
Variable Name Type Format Description
card_code card_code string Card code
# RESPONSE POSITIVE EXAMPLE
							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "system.api.card.cardSensitiveDataModel",
    "total_records": 1,
    "data": {
        "pan": "4847650007334700",
        "cvv": "232",
        "expiry_date": "2023-03-31",
        "emboss_name": "MEA TATE"
    }
}
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError
Type: application/json
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object Empty object
# RESPONSE NEGATIVE EXAMPLE
							{
    "status": "error",
    "error_description": "[ERROR : IN-CARD-DATA-SAVE] [ERROR-PUTDB : Object cardModel cannot create record in table card] [ERROR-CARD-SCHEME : Check card scheme!]",
    "error": {},
    "data_type": "",
    "total_records": -2,
    "data": {}
}
# Other endpoints
Name Endpoint
Card. Activate /api/card/activateCard/cardRequest
Card. Suspend /api/card/suspendCard/cardActionRequest
Card. Close /api/card/closeCard/cardActionRequest
Card. Get PIN /api/card/getCardPin/cardRequest
Card. Reset PIN /api/card/resetCardPin/cardRequest
Card. Fetch temporary Image URL by card code /api/card/getCardTempImageUrl/cardRequest
Card. Fetch data by request /api/card/getData/cardSearchRequest
Card. Fetch card delivery address by card code /api/card/getCardDeliveryAddress/cardRequest
Card. Fetch data by card code /api/card/getCard/cardRequest
Card. Description fields request /api/card/getItemData/cardSearchRequest
Card. Fetch sensitive data /api/card/getCardSensitiveData/cardRequest
Card. Fetch encrypted sensitive data /api/card/getCardEncryptedSensitiveData/cardEncryptionRequest