Skip to content
/Cards servicing

Card creation & servicing (1.0)

Download OpenAPI description
cards.json
cards.yaml
Languages
Servers
Mock Server

https://docs.solarisgroup.com/_mock/api-reference/digital-banking/cards/

Cards servicing

Operations

Create a card

Request

Creates a card in the name of the person specified in the request URL and attaches it to the given account.

Please note the following:

  • The cardholder name (i.e., the value of line_1) is not automatically generated. You must enter a value as close to the cardholder's actual name as possible.
  • The value of line_1 and line_2 may not exceed 21 characters.
  • You must enter a / between the cardholder's first and last name(s). Example: ADAM AARON/SCHMIDT
  • You may only use the following characters in the value of line_1 and line_2: ABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789 -/.. Please convert accented characters to their non-accented equivalents (e.g., converting Ö to OE, É to E).
  • Card activation requests are blocked for the first 24 hours after card creation. In order to test on Sandbox with immediate activation, please include the string WITHSTATICTOKEN within the line_1 property. See the request example on the right for information on how to use it.

You can set an encrypted PIN for the card by completing the below steps:

  1. In your backend, retrieve the encryption key in JWK format with the GET Retrieve latest public key method and make it available to the customer's device.
  2. On the customer's device, collect the customer's desired PIN through a text input in your frontend and store it as a string containing a JSON-formatted object {"pin": "<NEW_PIN>"}.
  3. On the customer's device, parse the received encryption key JWK from the first step (you may want to use a suitable library of your choice, e.g., JOSESwift for iOS or Nimbus JOSE for Android).
  4. On the customer's device, encrypt the string containing the new PIN from step 2 into a JWE using the previously received encryption key and the following properties:
    1. Algorithm: RSA-OAEP-256.
    2. Encryption method: A256CBC-HS512.
    3. Key ID: kid property from the encryption key JWK.
  5. On the customer's device, generate the compact serialization of the JWE created in the previous step—this will be used as the encrypted_pin parameter.
  6. The kid property from GET /v1/cards/pin_keys/latest is the kid in the request.
  7. Call this endpoint from your backend.
Path
person_idstringrequired

Solaris UID for person

account_idstringrequired

Solaris UID for account

Bodyapplication/json
line_1stringrequired

The cardholder's name as it should be printed on the card. Please note the guidelines for this field as written in the method description above.

Example: "MICHAEL WITHSTATICTOKEN/MUSTERMANN"
typestring(Solaris-Enums-CardType)required

The type of the card. Note The following enum list is not exhaustive but only indicative of some possible values.

Enum"MASTERCARD_DEBIT""MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_DEBIT""VIRTUAL_MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_FREELANCE_DEBIT""VISA_DEBIT""VISA_BUSINESS_DEBIT""VIRTUAL_VISA_DEBIT""VIRTUAL_VISA_BUSINESS_DEBIT""VIRTUAL_VISA_FREELANCE_DEBIT"
line_2string

An additional field to print another line of text on the card. Can be used for a variety of use cases to fit your business needs. Please note the guidelines for this field as written in the method description above.

Example: "TEST COMPANY GMBH"
business_idstring

(For business cards) ID of the business with which to associate the card.

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
referencestring

A unique reference for the card. This field is mandatory, and the API will check it for uniqueness.

Example: "61a50bf05278217a57e5ad15ed259e44"
shipping_prioritystring

Shipping priority to assign to the card.

Enum"0""1""2""3""4""5""6"
Example: "0"
encrypted_pinstring

The encrypted PIN value (JWE in compact serialization). See the description of this method for instructions on how to produce this value.

Example: "eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoiN2FkOTFjYWQtODU0NC00ZmQyLWJlNDgtNDcyOTU3MGEzOTRhIn0.bDPrZvlJ9slqZ9WDy_PDCZrKCvFyLanAeDItyDFdaiRvQbsTdoDE5Y-etWN--y25HkMKzpbC0CIJHdN7kLa225Ax2O6SPaxDkGGNSQPKzkxXmimpv9zaRYNCVQ67KdVTK6WOVLjOVRBKZDba9zvzfKvXlBYqj51WyQR_yvxrXTPftX3IQkDo8RjdaB6tr9HugdimbqOiMgiNSOHAn0G-Zi6tkwL0TLlA5_8xzUec40vaBvEoTBc_OZjZy7s7ebKzS8Hhg6NF9CemeMIEwes8ZzO1s1385PCxLhce0KEekVUoCjrLP9QhoYSjQUTUNrxkn4h0ZnicF5ycbW36Ivt8mQ.sAtSq_rfcxxlQiQc2qZ0Kg.bW53DScq6C8vnqD620Lnuw.MYGA-87sfGrFupu2FqC3Ick_EvwCA5vO2tPktS1yJPg"
key_idstring

Solaris' public RSA key ID. Returned as the kid property by the GET /v1/cards/pin_keys/latest endpoint.

Example: "7ad91cad-8544-4fd2-be48-4729570a394a"
application/json
{
  "line_1": "MICHAEL WITHSTATICTOKEN/MUSTERMANN",
  "line_2": "TEST COMPANY GMBH",
  "type": "MASTERCARD_BUSINESS_DEBIT",
  "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
  "reference": "61a50bf05278217a57e5ad15ed259e44",
  "shipping_priority": "0",
  "encrypted_pin": "eyJhbGciOiJSU0EtT0FFUC0yNTYiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoiN2FkOTFjYWQtODU0NC00ZmQyLWJlNDgtNDcyOTU3MGEzOTRhIn0.bDPrZvlJ9slqZ9WDy_PDCZrKCvFyLanAeDItyDFdaiRvQbsTdoDE5Y-etWN--y25HkMKzpbC0CIJHdN7kLa225Ax2O6SPaxDkGGNSQPKzkxXmimpv9zaRYNCVQ67KdVTK6WOVLjOVRBKZDba9zvzfKvXlBYqj51WyQR_yvxrXTPftX3IQkDo8RjdaB6tr9HugdimbqOiMgiNSOHAn0G-Zi6tkwL0TLlA5_8xzUec40vaBvEoTBc_OZjZy7s7ebKzS8Hhg6NF9CemeMIEwes8ZzO1s1385PCxLhce0KEekVUoCjrLP9QhoYSjQUTUNrxkn4h0ZnicF5ycbW36Ivt8mQ.sAtSq_rfcxxlQiQc2qZ0Kg.bW53DScq6C8vnqD620Lnuw.MYGA-87sfGrFupu2FqC3Ick_EvwCA5vO2tPktS1yJPg",
  "key_id": "7ad91cad-8544-4fd2-be48-4729570a394a"
}

Responses

Successful creation

Bodyapplication/json
idstring

ID of the card.

Example: "8febdba4912a747808ccc6f95f82bbb4mcrd"
statusstring

Current state of the created card

Example: "PROCESSING"
Response
application/json
{
  "id": "8febdba4912a747808ccc6f95f82bbb4mcrd",
  "status": "PROCESSING"
}

List all cards for a person

Request

Returns all cards associated with the person provided in the request URL

Path
person_idstringrequired
Query
filter[status]string

Filter the results by the card status

page[number]integer

Page number to return

Default 1
page[size]integer

The number of results per page to return

Default 10
No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

ID of the card.

Example: "8febdba4912a747808ccc6f95f82bbb4"
statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "ACTIVE"
referencestring

Unique reference number for the card.

Example: "87285d83-ab15-4906-af87-5763801d9e43"
typestring

The type of the card.

Enum"MASTERCARD_DEBIT""VISA_DEBIT""MASTERCARD_BUSINESS_DEBIT""VISA_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_DEBIT""VIRTUAL_VISA_DEBIT""VIRTUAL_MASTERCARD_BUSINESS_DEBIT""VIRTUAL_VISA_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_FREELANCE_DEBIT""VIRTUAL_VISA_FREELANCE_DEBIT"
Example: "MASTERCARD_DEBIT"
expiration_datestring

The expiration date of the card.

Example: "2020-12-30"
new_card_orderedboolean

Boolean that indicates if a new physical card was ordered for this card resource (either for the first time or as a replacement).

Example: false
person_idstring

ID of the cardholder person resource.

Example: "5af2ea4271038d5c53e68ccbf4fe43b3cper"
account_idstring

ID of the account to which the card is tied.

Example: "a5844f601567db9b59b3531245a58e96cacc"
business_idstring

(For business cards) ID of the business with which the card is associated.

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
representationobject(Solaris_Decorators_PublicPlasticCard)

Object containing information about the cardholder, the card's masked PAN, and the formatted expiration date.

partner_idstring

ID of the partner with which the card is associated.

Example: "a0461d31b910023de5647306e1e9a62bcpar"
owner_1_idstring

SIA Identifier for a given partner

Example: "00059"
card_account_statusstring
Example: "active"
sia_related_account_idstring

SIA Related Account ID. We generate this ID for the SIA card processor to reference the banking Account of the Card in their system. The referred SIA Account holds money balance, for example. A banking Account can have multiple Cards. For each of such cards, we have their own unique SIA Account Number.

Example: "55874C893FE53ADFE44F01"
created_atstring
Example: "2019-11-13T15:19:21.000Z"
ibanstring

IBAN of the banking Account this Card is connected to

Example: "DE00116474734556211581"
emoney_visa_settlement_ibanstring

IBAN of the banking account used for settling emoney transactions

sia_account_numberstring

SIA account number

Example: "500000001103"
visa_profile_idstring

VISA profile ID

]
Response
application/json
[
  {
    "id": "8febdba4912a747808ccc6f95f82bbb4",
    "status": "ACTIVE",
    "reference": "87285d83-ab15-4906-af87-5763801d9e43",
    "type": "MASTERCARD_DEBIT",
    "expiration_date": "2020-12-30",
    "new_card_ordered": false,
    "person_id": "5af2ea4271038d5c53e68ccbf4fe43b3cper",
    "account_id": "a5844f601567db9b59b3531245a58e96cacc",
    "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
    "representation": { … },
    "partner_id": "a0461d31b910023de5647306e1e9a62bcpar",
    "owner_1_id": "00059",
    "card_account_status": "active",
    "sia_related_account_id": "55874C893FE53ADFE44F01",
    "created_at": "2019-11-13T15:19:21.000Z",
    "iban": "DE00116474734556211581",
    "emoney_visa_settlement_iban": "string",
    "sia_account_number": "500000001103",
    "visa_profile_id": "string"
  }
]

List all cards for a business

Request

Returns all cards associated with the business specified in the request URL.

Path
business_idstringrequired
Query
page[number]integer

The number of results pages to return.

Default 1
page[size]integer

The size of each page in the response.

Default 10
No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

ID of the card.

Example: "8febdba4912a747808ccc6f95f82bbb4"
statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "ACTIVE"
referencestring

Unique reference number for the card.

Example: "87285d83-ab15-4906-af87-5763801d9e43"
typestring(Solaris-Enums-CardType)

The type of the card. Note The following enum list is not exhaustive but only indicative of some possible values.

Enum"MASTERCARD_DEBIT""MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_DEBIT""VIRTUAL_MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_FREELANCE_DEBIT""VISA_DEBIT""VISA_BUSINESS_DEBIT""VIRTUAL_VISA_DEBIT""VIRTUAL_VISA_BUSINESS_DEBIT""VIRTUAL_VISA_FREELANCE_DEBIT"
expiration_datestring

The expiration date of the card.

Example: "2020-12-30"
new_card_orderedboolean

Boolean that indicates if a new physical card was ordered for this card resource (either for the first time or as a replacement).

Example: false
person_idstring

ID of the cardholder person resource.

Example: "5af2ea4271038d5c53e68ccbf4fe43b3cper"
account_idstring

ID of the account to which the card is tied.

Example: "a5844f601567db9b59b3531245a58e96cacc"
business_idstring

(For business cards) ID of the business with which the card is associated.

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
representationobject(Solaris_Decorators_PublicPlasticCard)

Object containing information about the cardholder, the card's masked PAN, and the formatted expiration date.

creation_datestring

Date when the latest plastic card for this card resource was created.

Example: "2022-05-01"
sia_account_numberstring

The SIA account number for the card.

Example: "500001650679"
]
Response
application/json
[
  {
    "id": "8febdba4912a747808ccc6f95f82bbb4",
    "status": "ACTIVE",
    "reference": "87285d83-ab15-4906-af87-5763801d9e43",
    "type": "MASTERCARD_DEBIT",
    "expiration_date": "2020-12-30",
    "new_card_ordered": false,
    "person_id": "5af2ea4271038d5c53e68ccbf4fe43b3cper",
    "account_id": "a5844f601567db9b59b3531245a58e96cacc",
    "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
    "representation": { … },
    "creation_date": "2022-05-01",
    "sia_account_number": "500001650679"
  }
]

List all cards for an account

Request

Returns all cards associated with the cardAccount specified in the request URL.

Path
account_idstringrequired

Solaris UID for account

Query
page[number]integer

The number of results pages to return.

Default 1
page[size]integer

The size of each page in the response.

Default 10
No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

ID of the card.

Example: "8febdba4912a747808ccc6f95f82bbb4"
statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "ACTIVE"
referencestring

Unique reference number for the card.

Example: "87285d83-ab15-4906-af87-5763801d9e43"
typestring(Solaris-Enums-CardType)

The type of the card. Note The following enum list is not exhaustive but only indicative of some possible values.

Enum"MASTERCARD_DEBIT""MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_DEBIT""VIRTUAL_MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_FREELANCE_DEBIT""VISA_DEBIT""VISA_BUSINESS_DEBIT""VIRTUAL_VISA_DEBIT""VIRTUAL_VISA_BUSINESS_DEBIT""VIRTUAL_VISA_FREELANCE_DEBIT"
expiration_datestring

The expiration date of the card.

Example: "2020-12-30"
new_card_orderedboolean

Boolean that indicates if a new physical card was ordered for this card resource (either for the first time or as a replacement).

Example: false
person_idstring

ID of the cardholder person resource.

Example: "5af2ea4271038d5c53e68ccbf4fe43b3cper"
account_idstring

ID of the account to which the card is tied.

Example: "a5844f601567db9b59b3531245a58e96cacc"
business_idstring

(For business cards) ID of the business with which the card is associated.

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
representationobject(Solaris_Decorators_PublicPlasticCard)

Object containing information about the cardholder, the card's masked PAN, and the formatted expiration date.

creation_datestring

Date when the latest plastic card for this card resource was created.

Example: "2022-05-01"
sia_account_numberstring

The SIA account number for the card.

Example: "500001650679"
]
Response
application/json
[
  {
    "id": "8febdba4912a747808ccc6f95f82bbb4",
    "status": "ACTIVE",
    "reference": "87285d83-ab15-4906-af87-5763801d9e43",
    "type": "MASTERCARD_DEBIT",
    "expiration_date": "2020-12-30",
    "new_card_ordered": false,
    "person_id": "5af2ea4271038d5c53e68ccbf4fe43b3cper",
    "account_id": "a5844f601567db9b59b3531245a58e96cacc",
    "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
    "representation": { … },
    "creation_date": "2022-05-01",
    "sia_account_number": "500001650679"
  }
]

Show a card

Request

Returns information about the card specified in the request URL.

Path
idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
idstring

ID of the card.

Example: "8febdba4912a747808ccc6f95f82bbb4"
statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "ACTIVE"
referencestring

Unique reference number for the card.

Example: "87285d83-ab15-4906-af87-5763801d9e43"
typestring(Solaris-Enums-CardType)

The type of the card. Note The following enum list is not exhaustive but only indicative of some possible values.

Enum"MASTERCARD_DEBIT""MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_DEBIT""VIRTUAL_MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_FREELANCE_DEBIT""VISA_DEBIT""VISA_BUSINESS_DEBIT""VIRTUAL_VISA_DEBIT""VIRTUAL_VISA_BUSINESS_DEBIT""VIRTUAL_VISA_FREELANCE_DEBIT"
expiration_datestring

The expiration date of the card.

Example: "2020-12-30"
new_card_orderedboolean

Boolean that indicates if a new physical card was ordered for this card resource (either for the first time or as a replacement).

Example: false
person_idstring

ID of the cardholder person resource.

Example: "5af2ea4271038d5c53e68ccbf4fe43b3cper"
account_idstring

ID of the account to which the card is tied.

Example: "a5844f601567db9b59b3531245a58e96cacc"
business_idstring

(For business cards) ID of the business with which the card is associated.

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
representationobject(Solaris_Decorators_PublicPlasticCard)

Object containing information about the cardholder, the card's masked PAN, and the formatted expiration date.

creation_datestring

Date when the latest plastic card for this card resource was created.

Example: "2022-05-01"
sia_account_numberstring

The SIA account number for the card.

Example: "500001650679"
Response
application/json
{
  "id": "8febdba4912a747808ccc6f95f82bbb4",
  "status": "ACTIVE",
  "reference": "87285d83-ab15-4906-af87-5763801d9e43",
  "type": "MASTERCARD_DEBIT",
  "expiration_date": "2020-12-30",
  "new_card_ordered": false,
  "person_id": "5af2ea4271038d5c53e68ccbf4fe43b3cper",
  "account_id": "a5844f601567db9b59b3531245a58e96cacc",
  "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
  "representation": {
    "line_1": "SLY STALLONE",
    "line_2": "BUSINESS NAME",
    "masked_pan": "537458******4567",
    "formatted_expiration_date": "09/22"
  },
  "creation_date": "2022-05-01",
  "sia_account_number": "500001650679"
}

List all cards

Request

Returns all cards associated with partner.

Query
filter[business_id]string

Filter the results by the ID of the business associated with the card.

filter[person_id]string

Filter the results by the ID of the person associated with the card.

filter[account_id]string

Filter on account id

filter[status]string

Filter the results by the card status

filter[type]string

Filter the results by the card type.

filter[masked_pan]string

Filter the results by the card's masked PAN.

filter[line_1]string

Filter the cards by the value of their address line 1.

filter[sia_account_number]string

Filter the results by the SIA account number.

page[number]integer

The number of results pages to return.

Default 1
page[size]integer

The size of each page in the response.

Default 10
filter[person_uid]stringDeprecated

Filter the results by the ID of the person associated with the card.

filter[account_uid]stringDeprecated

Filter on account id

No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

ID of the card.

Example: "8febdba4912a747808ccc6f95f82bbb4"
statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "ACTIVE"
referencestring

Unique reference number for the card.

Example: "87285d83-ab15-4906-af87-5763801d9e43"
typestring(Solaris-Enums-CardType)

The type of the card. Note The following enum list is not exhaustive but only indicative of some possible values.

Enum"MASTERCARD_DEBIT""MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_DEBIT""VIRTUAL_MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_FREELANCE_DEBIT""VISA_DEBIT""VISA_BUSINESS_DEBIT""VIRTUAL_VISA_DEBIT""VIRTUAL_VISA_BUSINESS_DEBIT""VIRTUAL_VISA_FREELANCE_DEBIT"
expiration_datestring

The expiration date of the card.

Example: "2020-12-30"
new_card_orderedboolean

Boolean that indicates if a new physical card was ordered for this card resource (either for the first time or as a replacement).

Example: false
person_idstring

ID of the cardholder person resource.

Example: "5af2ea4271038d5c53e68ccbf4fe43b3cper"
account_idstring

ID of the account to which the card is tied.

Example: "a5844f601567db9b59b3531245a58e96cacc"
business_idstring

(For business cards) ID of the business with which the card is associated.

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
representationobject(Solaris_Decorators_PublicPlasticCard)

Object containing information about the cardholder, the card's masked PAN, and the formatted expiration date.

creation_datestring

Date when the latest plastic card for this card resource was created.

Example: "2022-05-01"
sia_account_numberstring

The SIA account number for the card.

Example: "500001650679"
]
Response
application/json
[
  {
    "id": "8febdba4912a747808ccc6f95f82bbb4",
    "status": "ACTIVE",
    "reference": "87285d83-ab15-4906-af87-5763801d9e43",
    "type": "MASTERCARD_DEBIT",
    "expiration_date": "2020-12-30",
    "new_card_ordered": false,
    "person_id": "5af2ea4271038d5c53e68ccbf4fe43b3cper",
    "account_id": "a5844f601567db9b59b3531245a58e96cacc",
    "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
    "representation": { … },
    "creation_date": "2022-05-01",
    "sia_account_number": "500001650679"
  }
]

Activate a card

Request

Activates the card with the ID specified in the request URL. Please note the following preconditions:

  • The card must have a status value of ACTIVE or INACTIVE (if activating a replacement card).
  • The account to which the card is tied must have a blocking_status value of NO_BLOCK.
You can also include in the request the pan_last_4_digit and expiry_date. These are optional parameters you can collect from the cardholder upon receipt of their card in the mail, to ensure they are activating the right card.

You can then verify both parameters against the card details you have on file for the customer, before sending the activation request to Solaris. Solaris will then perform a validation of both parameters before accepting the request.


Note: Card activation requests are blocked for the first 24 hours after card creation. In order to test on Sandbox with immediate activation, please include the string WITHSTATICTOKEN within the line_1 property when creating a card.

Path
card_account_idstringrequired
Bodyapplication/json
pan_last_4_digitstring

The last 4 digits of the card's PAN.

Example: "2314"
expiry_datestring

The card expiry date. Format should be mm/yy.

Example: "01/23"
application/json
{
  "pan_last_4_digit": "2314",
  "expiry_date": "01/23"
}

Responses

Successful result of the operation

Bodyapplication/jsonArray [
expiration_datestring

The expiration date of the card.

Example: "2020-12-30"
new_card_orderedboolean

Boolean that indicates if a new physical card was ordered for this card resource (either for the first time or as a replacement).

Example: false
person_idstring

ID of the cardholder person resource.

Example: "6dceb838ea04090aaa4277c7ea8a1c78cper"
account_idstring

ID of the account to which the card is tied.

Example: "6cbac416a5d91aaf5e6bc9ee15d58799cacc"
business_idstring

(For business cards) ID of the business with which the card is associated.

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
sia_account_numberstring

SIA account number

Example: "500000001103"
creation_datestring

Date when the latest plastic card for this card resource was created.

Example: "2022-05-01"
idstring

ID of the card.

Example: "2b890724292e287935420a2ca13ae7f9mcrd"
statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "ACTIVE"
referencestring

Unique reference number for the card.

Example: "b92b6840d6345b11f29b598c10bae770"
typestring(Solaris-Enums-CardType)

The type of the card. Note The following enum list is not exhaustive but only indicative of some possible values.

Enum"MASTERCARD_DEBIT""MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_DEBIT""VIRTUAL_MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_FREELANCE_DEBIT""VISA_DEBIT""VISA_BUSINESS_DEBIT""VIRTUAL_VISA_DEBIT""VIRTUAL_VISA_BUSINESS_DEBIT""VIRTUAL_VISA_FREELANCE_DEBIT"
representationobject(Solaris_Decorators_PlasticCard)

Object containing information about the cardholder, the card's masked PAN, and the formatted expiration date.

]
Response
application/json
[
  {
    "expiration_date": "2020-12-30",
    "new_card_ordered": false,
    "person_id": "6dceb838ea04090aaa4277c7ea8a1c78cper",
    "account_id": "6cbac416a5d91aaf5e6bc9ee15d58799cacc",
    "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
    "sia_account_number": "500000001103",
    "creation_date": "2022-05-01",
    "id": "2b890724292e287935420a2ca13ae7f9mcrd",
    "status": "ACTIVE",
    "reference": "b92b6840d6345b11f29b598c10bae770",
    "type": "MASTERCARD_DEBIT",
    "representation": { … }
  }
]

Block a card

Request

Blocks the card with the ID specified in the request URL. Note that the card must have a status value of ACTIVE in order to be blocked.

Path
card_account_idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
expiration_datestring

The expiration date of the card.

Example: "2020-12-30"
new_card_orderedboolean

Boolean that indicates if a new physical card was ordered for this card resource (either for the first time or as a replacement).

Example: false
person_idstring

ID of the cardholder person resource.

Example: "6dceb838ea04090aaa4277c7ea8a1c78cper"
account_idstring

ID of the account to which the card is tied.

Example: "6cbac416a5d91aaf5e6bc9ee15d58799cacc"
business_idstring

(For business cards) ID of the business with which the card is associated.

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
sia_account_numberstring

SIA account number

Example: "500000001103"
creation_datestring

Date when the latest plastic card for this card resource was created.

Example: "2022-05-01"
idstring

ID of the card.

Example: "2b890724292e287935420a2ca13ae7f9mcrd"
statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "ACTIVE"
referencestring

Unique reference number for the card.

Example: "b92b6840d6345b11f29b598c10bae770"
typestring(Solaris-Enums-CardType)

The type of the card. Note The following enum list is not exhaustive but only indicative of some possible values.

Enum"MASTERCARD_DEBIT""MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_DEBIT""VIRTUAL_MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_FREELANCE_DEBIT""VISA_DEBIT""VISA_BUSINESS_DEBIT""VIRTUAL_VISA_DEBIT""VIRTUAL_VISA_BUSINESS_DEBIT""VIRTUAL_VISA_FREELANCE_DEBIT"
representationobject(Solaris_Decorators_PlasticCard)

Object containing information about the cardholder, the card's masked PAN, and the formatted expiration date.

Response
application/json
{
  "expiration_date": "2020-12-30",
  "new_card_ordered": false,
  "person_id": "6dceb838ea04090aaa4277c7ea8a1c78cper",
  "account_id": "6cbac416a5d91aaf5e6bc9ee15d58799cacc",
  "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
  "sia_account_number": "500000001103",
  "creation_date": "2022-05-01",
  "id": "2b890724292e287935420a2ca13ae7f9mcrd",
  "status": "ACTIVE",
  "reference": "b92b6840d6345b11f29b598c10bae770",
  "type": "MASTERCARD_DEBIT",
  "representation": {
    "line_1": "SLY STALLONE",
    "line_2": "TEST COMPANY GMBH",
    "masked_pan": "537458******4567",
    "formatted_expiration_date": "09/22"
  }
}

Unblock a card

Request

Unblocks the card specified in the request URL. Please note that the card must have the status of BLOCKED in order for you to unblock it with this method. If the card has the status BLOCKED_BY_SOLARIS, then you cannot unblock it with this method.

Path
card_account_idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/json
expiration_datestring

The expiration date of the card.

Example: "2020-12-30"
new_card_orderedboolean

Boolean that indicates if a new physical card was ordered for this card resource (either for the first time or as a replacement).

Example: false
person_idstring

ID of the cardholder person resource.

Example: "6dceb838ea04090aaa4277c7ea8a1c78cper"
account_idstring

ID of the account to which the card is tied.

Example: "6cbac416a5d91aaf5e6bc9ee15d58799cacc"
business_idstring

(For business cards) ID of the business with which the card is associated.

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
sia_account_numberstring

SIA account number

Example: "500000001103"
creation_datestring

Date when the latest plastic card for this card resource was created.

Example: "2022-05-01"
idstring

ID of the card.

Example: "2b890724292e287935420a2ca13ae7f9mcrd"
statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "ACTIVE"
referencestring

Unique reference number for the card.

Example: "b92b6840d6345b11f29b598c10bae770"
typestring(Solaris-Enums-CardType)

The type of the card. Note The following enum list is not exhaustive but only indicative of some possible values.

Enum"MASTERCARD_DEBIT""MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_DEBIT""VIRTUAL_MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_FREELANCE_DEBIT""VISA_DEBIT""VISA_BUSINESS_DEBIT""VIRTUAL_VISA_DEBIT""VIRTUAL_VISA_BUSINESS_DEBIT""VIRTUAL_VISA_FREELANCE_DEBIT"
representationobject(Solaris_Decorators_PlasticCard)

Object containing information about the cardholder, the card's masked PAN, and the formatted expiration date.

Response
application/json
{
  "expiration_date": "2020-12-30",
  "new_card_ordered": false,
  "person_id": "6dceb838ea04090aaa4277c7ea8a1c78cper",
  "account_id": "6cbac416a5d91aaf5e6bc9ee15d58799cacc",
  "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
  "sia_account_number": "500000001103",
  "creation_date": "2022-05-01",
  "id": "2b890724292e287935420a2ca13ae7f9mcrd",
  "status": "ACTIVE",
  "reference": "b92b6840d6345b11f29b598c10bae770",
  "type": "MASTERCARD_DEBIT",
  "representation": {
    "line_1": "SLY STALLONE",
    "line_2": "TEST COMPANY GMBH",
    "masked_pan": "537458******4567",
    "formatted_expiration_date": "09/22"
  }
}

Replace a card

Request

Issues a replacement for the card specified in the request URL. Specify the appropriate reason in your request to trigger the right replacement process:

  • Reissue a card expiring soon: EXPIRES_SOON
  • Replace a damaged card (physical card only): DEFECTIVE_CARD, CARDHOLDER_REQUEST (Deprecated)
  • Report a card as lost or stolen and request a replacement (physical cards only): LOST, STOLEN, COUNTERFEIT_PLASTIC, PREVENTIVE_BLOCK, ONLINE_TRANSACTION_FRAUD
Please note the following:
For the reissue or replace flows:
  • The new card will have the same card number, but it will have a new CVV and expiry date.
  • Once you make this request, the card's status will change to PROCESSING, then ACTIVE or BLOCKED depending on the card's status prior to ordering. The value of the new_card_ordered property on the card resource will change to true.
  • The customer can still use the old card until they activate the new one. Once they do so, the old one will no longer be authorized and the value of new_card_ordered will change to false.
For the lost/stolen flow:
  • The new card will have a different card number.
  • The old card will stop working immediately upon acceptance of the API request. This action cannot be undone.
Accepted card statuses:
  • Reissue: ACTIVE, INACTIVE
  • Replace and Lost/Stolen: ACTIVE, INACTIVE, BLOCKED, BLOCKED_BY_SOLARIS
Please note that on Sandbox a given card can only be replaced once.

Path
card_account_idstringrequired
Bodyapplication/json
line_1string

The name to print on the new card. For Replace flow only.

Example: "JOHN/DOE"
line_2string

Additional optional embossing line. For Replace flow only.

Example: "TEST GMBH"
reasonstring

The reason why the customer is requesting a replacement card.

Default "CARDHOLDER_REQUEST"
Enum"CARDHOLDER_REQUEST""COUNTERFEIT_PLASTIC""DEFECTIVE_CARD""EXPIRES_SOON""LOST""ONLINE_TRANSACTION_FRAUD""PREVENTIVE_BLOCK""STOLEN""SUSPECTED_MERCHANT_FRAUD"
Example: "DEFECTIVE_CARD"
referencestring

Randomly generated UUID that acts as an idempotency key.

Default "718578ca-fb20-4c3e-9f07-c86b21711b2f"
Example: "7dc5377e-b90b-3401-b9a5-5dd094893e28"
retain_pinboolean

Indicates whether or not the new card should use the same PIN as the old one. For Replace and Reissue flows, default is true. For Lost/Stolen, default is false.

Example: true
reported_atstring(date-time)

For Lost/Stolen flow only. Timestamp from when the card was reported (ISO 8601 format).

Example: "2020-01-13T09:56:24.000Z"
application/json
{
  "line_1": "JOHN/DOE",
  "line_2": "TEST GMBH",
  "reason": "DEFECTIVE_CARD",
  "reference": "7dc5377e-b90b-3401-b9a5-5dd094893e28",
  "retain_pin": true,
  "reported_at": "2020-01-13T09:56:24.000Z"
}

Responses

Successful result of the operation

Bodyapplication/json
idstring

ID of the card.

Example: "2b890724292e287935420a2ca13ae7f9mcrd"
statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "PROCESSING"
Response
application/json
{
  "id": "2b890724292e287935420a2ca13ae7f9mcrd",
  "status": "PROCESSING"
}

Close a card

Request

Closes the card with the ID specified in the request URL.
Note: this action cannot be undone.
In order to be closed, the card must have one of the following statuses:

  • ACTIVE
  • BLOCKED
  • COUNTERFEIT_CARD
  • FRAUD
  • INACTIVE
  • LOST
  • NEVER_RECEIVED
  • STOLEN

Path
card_account_idstringrequired
No request payload

Responses

Successful result of the operation

Bodyapplication/jsonArray [
expiration_datestring

The expiration date of the card.

Example: "2020-12-30"
new_card_orderedboolean

Boolean that indicates if a new physical card was ordered for this card resource (either for the first time or as a replacement).

Example: false
person_idstring

ID of the cardholder person resource.

Example: "6dceb838ea04090aaa4277c7ea8a1c78cper"
account_idstring

ID of the account to which the card is tied.

Example: "6cbac416a5d91aaf5e6bc9ee15d58799cacc"
business_idstring

(For business cards) ID of the business with which the card is associated.

Example: "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz"
sia_account_numberstring

SIA account number

Example: "500000001103"
creation_datestring

Date when the latest plastic card for this card resource was created.

Example: "2022-05-01"
idstring

ID of the card.

Example: "2b890724292e287935420a2ca13ae7f9mcrd"
statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "ACTIVE"
referencestring

Unique reference number for the card.

Example: "b92b6840d6345b11f29b598c10bae770"
typestring(Solaris-Enums-CardType)

The type of the card. Note The following enum list is not exhaustive but only indicative of some possible values.

Enum"MASTERCARD_DEBIT""MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_DEBIT""VIRTUAL_MASTERCARD_BUSINESS_DEBIT""VIRTUAL_MASTERCARD_FREELANCE_DEBIT""VISA_DEBIT""VISA_BUSINESS_DEBIT""VIRTUAL_VISA_DEBIT""VIRTUAL_VISA_BUSINESS_DEBIT""VIRTUAL_VISA_FREELANCE_DEBIT"
representationobject(Solaris_Decorators_PlasticCard)

Object containing information about the cardholder, the card's masked PAN, and the formatted expiration date.

]
Response
application/json
[
  {
    "expiration_date": "2020-12-30",
    "new_card_ordered": false,
    "person_id": "6dceb838ea04090aaa4277c7ea8a1c78cper",
    "account_id": "6cbac416a5d91aaf5e6bc9ee15d58799cacc",
    "business_id": "52e6a9b8a559d842ed7d8901b0e1bf4bcbiz",
    "sia_account_number": "500000001103",
    "creation_date": "2022-05-01",
    "id": "2b890724292e287935420a2ca13ae7f9mcrd",
    "status": "ACTIVE",
    "reference": "b92b6840d6345b11f29b598c10bae770",
    "type": "MASTERCARD_DEBIT",
    "representation": { … }
  }
]

Create a secure view for card details

Request

Retrieves the card number, expiry date, and CVV for the card specified in the request URL. The response is encrypted; your customer must decrypt it using a bound device.

Please note the following prerequisites:

  • Your customer's device must have a supported operating system (Android: 4.3 or higher; iOS: iPhone 5 or newer, not jailbroken or rooted).
  • The customer must have already verified their device using the device binding process. You will need to supply the device_id in this request.

Warning

Never store or log decrypted card details on a customer's device. This information may never leave the device. You may only make clean PAN details available in the device's temporary memory.

Path
idstringrequired
Bodyapplication/json

The content of the request

device_idstringrequired

ID of the customer's bound device.

Example: "ZtzhX7M96stcA2LzDpX1Lg8dev"
signaturestringrequired

The device signature obtained during the device binding process. The signature must be generated using the device's unrestricted key.

Follow these steps to generate the key:

  1. Generate the RSA key pair. This results in an rsa_key.
  2. Create a JWK JSON representation of the public part of the rsa_key. This results in a jwk_key.
  3. Generate a single string from the jwk_key representation of the public part of the rsa_key using the following steps:
    1. Sort every key/value pair alphabetically by the key.
    2. Combine the key and value of every key/value pair using : as the delimiter, e.g., alg:RS256.
    3. Join every key/value pair to a single string using ; as the delimiter, e.g., alg:RS256;...;e:AQAB.
    4. This results in a key_string, whose format resembles this: alg:RS256;e:AQAB;kid:0016E6D1...35E6;kty:RSA;n:qp7...Q;use:enc.
  4. Sign the key_string using the device's unrestricted key. This results in the signed_key. Read more about how to create an unrestricted key for use in device binding here.
  5. Hex-encode the signed_key to get the signature.
Example: "556F4558783743346570744B674D3838454E3444334F627141394E696735726B3946593739356B413353337359767A34756F387977754D2F4658536134327A41394454716D3337616570764335346A477276744579376246514B546C79465A6A7A532F577545722B4946644A4A2F674953784E7A715451765A3077432B39486E6F4B7A36447050725537695657476A626B3057366549746363312F577654742F39594D4B726B7541506E49426B4A74426B737254687867562B3169636155582B432B426F41696A64544A314D773774624F70556F4C686257392F496936773235744472494E33564A6166446E6F634E523438335469595568382B70343946703473395971434872503270395959616B513155795673444635504B45596B75784A2F7A797933334779686732744D5473435238476B7959657648372F31733532472B6C73573048754F597A4C364E324954426B6C666D413D3D0D0A"
jwkobjectrequired

JSON Web Key (JWK) data that will be used to encrypt the card details. Click here to learn more about this algorithm.

Example: {"kty":"RSA","use":"enc","alg":"RS256","kid":"cf8e03cd-0292-47e2-8e26-c167293b9187","n":"ZtzhX7M96stcA2LzDpX1Lmr0Y7tH1JnHvK5BmRQsy5hm1vAneRgictJB7yfW9JcZSpHeDspVkXVXuL3ddO1tVWOs4pln65Iklz5EtYKgoKaVBkUFNP1wDgEDTPhX6dS46/Ua1Z39RPAl21s2gQkzAL8UjC67kwH+FJnzLqBEE57L0eJNOU2VnBVwVob8GM8B6/KTblhr5wUw/o1K2qFXhjpkopz+SV1mqd61I/9H8gvb/clKuwpI+c/jyV0O55Y7vQDBdL37MReuSgHJvYtOnjLSHTNrB+lhNt6kg/MEtfs/e6iX+MV9d4Is5AvkDSXcMg+Im4aiKK4UeKcrSOtTcw==","e":"AQAB"}
jwk.​ktystringrequired

The key type. The only possible value is RSA.

Value"RSA"
Example: "RSA"
jwk.​nstringrequired

Modulus (for RSA keys)

Example: "ZtzhX7M96stcA2LzDpX1Lmr0Y7tH1JnHvK5BmRQsy5hm1vAneRgictJB7yfW9JcZSpHeDspVkXVXuL3ddO1tVWOs4pln65Iklz5EtYKgoKaVBkUFNP1wDgEDTPhX6dS46/Ua1Z39RPAl21s2gQkzAL8UjC67kwH+FJnzLqBEE57L0eJNOU2VnBVwVob8GM8B6/KTblhr5wUw/o1K2qFXhjpkopz+SV1mqd61I/9H8gvb/clKuwpI+c/jyV0O55Y7vQDBdL37MReuSgHJvYtOnjLSHTNrB+lhNt6kg/MEtfs/e6iX+MV9d4Is5AvkDSXcMg+Im4aiKK4UeKcrSOtTcw=="
jwk.​estringrequired

Exponent (for RSA keys)

Example: "AQAB"
jwk.​usestring

(Optional) The public key use. The only possible value is enc.

Value"enc"
Example: "enc"
jwk.​algstring

(Optional) The algorithm to use for encryption. The only possible value is RS256.

Value"RS256"
Example: "RS256"
jwk.​kidstring

(Optional) The key ID. Use any unique identifier, such as a UUID.

Example: "cf8e03cd-0292-47e2-8e26-c167293b9187"
jweobjectrequired

JSON Web Encryption attributes.

Example: {"alg":"RSA1_5","enc":"A256GCM"}
jwe.​algstringrequired

Algorithm used for CEK encryption. Possible values:

  • RSA_OAEP_256 (recommended): Uses SHA-256 for both the main digest and the mask generation function (mgf1).
  • RSA_OAEP_256_ANDROID: Android-specific version of the above, which uses SHA-256 for the main digest and SHA-1 for the mask generation function (mgf1).

Enum"RSA1_5""RSA_OAEP_256""RSA_OAEP_256_ANDROID"
Example: "RSA1_5"
jwe.​encstringrequired

Encryption algorithm.

Enum"A256GCM""A256CBC_HS512"
Example: "A256GCM"
device_datastring

Encoded device fingerprint generated using the Seon SDK. See the device monitoring guide for more information about generating this value.

Example: "Web;179ac83968ab42f79e960c1753a4078fdcon;jVl14emA+OcyALb9F+CMFg==;NU7aFh0jdzM15wj8hQtqbA5LbzEFWDI1bUwZf/zbau0P2MIEUE+LsifBKvxjCYNUyz647bpSjnQ6Tu8IK22sxFlTGEFaHKBigzmP8Nc8FvVSWKzslmSWTFJM5AYc+EGTZLprlcdrLldsZLS5PpHfPMmvtqCXVTnGhYV7GvutI1w5/67yK7pCQDxDicKjqlMg1naMiwCuqP1U1lUtf+lTdmJ1T1lXMPARffTn4XAr66vUxN++sy7qytkdcOeCsaxZnLspUEvqu+2ILHF8pOJFG7gYC11rqWOyHG3Ns1E1dZ57ybrgGTKfctFOdx2IMXnz1/i/pDC5QokRr2BTIZZ/9Tj+xXzWpzNwHtRWWK5VEufyVRPyMXQdmry7UYKrouAzlLCYSMv7GcPwOZz+gDjCkrNia7/DGBBFLOvtlufDztPpvkH2jmN32/oJHl1Qu6zpxG3Lyl8RNdyukuNYfiPw0ECoXsXObwQc7Ja8R+V5S7QZeV1VV9aavlH1+Xl9v0OlOJ1XujO7izWESMIfzAuaL6ACYhdkmkC3kicjOWUjaY3OJYrrXxQ+MScnJOQ9neMRWij7YqNxP8F259zVjqqyaL6hN8EZU/pi+cZUVkfFvMYT5ugE9JXjkFfyy4UQeSmNRjDXRzu40LyweqUns8u3GOIFzfZ9eVOv+q7OV+RpVLOJLz1Za8RPIh3UKltCzOTmO8OpDz2aGoqNdL4zAaLl4EKRoarEiSG9K2/GoyHchi6xdHYA6DqQg5xQM4s50RUySGwWLxBB3ZlMpZpdZAVBrLSyl1SWqYTosdyURtiiX0So+kdik5XJ5Vsh0v75rNP5Yrv3t5/u94wx51zKlpDH8Uiap7kP0eibRmmN196kxMcOf8Q50JM1Yt8cJiawTWdGHzGRcNtEkpon5VLp/kwDU+4IPwlW976hKsom0PTB/EVxo5CWuL6kPiaEWUrWOL7BZ2jkuebHT2jBAJuFBaeac7IYnrAMoLgfY33Vs3EtVk8H12iDX3O9JmGsDGXP0/vBx0uFEgrTt6HjwabWGRHpPPPCorSrjfuySwKlnZtp1KkeNrOso8K8DBW6e+6j1YYaxTjBUZSLl1qgzd1dpz85vB/trWdyS3i+APHw/AsP/Y4cmu/CFZqpe1Sgye1+YNP3Hs3LpxJKM3prnAoaCmrHp5aUKo5KdicAnilBTzBAV2zGBWHrBwWLWHl+RDQpncyWD2/ZCswxtXbQAhlmVD7FvBXnT0Yyg5gaFo5GVBcURzBYtwbdl3+6sqKtR3XC22GBw0OOqZ9/QvMHmCO/K89rEjfLEaVX4eKhrdzjxOwOxmE5lXrLqfscV90Yo9Uj1awvpF5TL5vW85asT2iVHYjZ1JsQ5oLp3VUfIAqTNmpcjRk763hMsTUIrn3VfpLkGajZbtxD2FuNNMoRZQBfiOAxPUDFmspxWagNSbmUZ8FqPX/6asQIJIyvAk4cvzgV9OjzdkoEcFP2OGjFnddZtLmBh9BZDWtS3VOL98lp+cH/JAn8pDab2l6zIwHRccePbuBcGZZgU39FOVpI+sbHZJ6QEhiUA8SdT7SLcTf4P1tBbdN5+dpjaWfTph1cgZyW8EsAIFc81vR6tBqSSpxmS164ADWZW+PYz4b4SRVklT3Cs2tJ/TTMM240pnkNJUd3G/0PbBGVPea5+XUs1bF5cT0fiHWA032Dm87biMEU89fdPkvnSlIsN/MbLT2kj2tPZqhOrqTxCg26jimd+2kNdZ2fwvT8JQfO0hVidnPDPLXH5aA6T6+bKqfpvJE6USAif8fPQ0rW4+315LKH5wG8Qj0omO2Ynii0IE6cR0lAGrtoLsXMf3kDqFms+Z2h79pYQrnhUSntZ3tjt3pwgejJ8ZKXdN7kYWT8UiQnLnkfLJnh1e8a4UURe7GU9UwnqqFXeHrstb8XXxiIX7syFG5iLdN9IExi5BefYnAikCTU+ssMWnnhppX6jFV43u+KEaa1/7AqibMc3Kt+kUxHlQsAo2TCg+u/39rsgNs5eWym7YptvBCN6L4Q4QRoKNFo8CJerS4dTxksD2zeGL4BLIsvMbcm6rlHrKCR5PeWRiFpK8QwwaOyiTGL5NN2Xl6F0M4vf5gnWikZTrppv7bLUYZhrU1uGiv968ZGEq+A7w2oLvbZS7l+DZuN4rPF5SzPWq94jC1NiYjaPrGyTQIISRiBLXil5puqCobYHAIeVQzHBgki3/N+Pwk4iCrxf3pqnUSNmtrmvphmo9Vp3xAaPSFsUYfIyOPiO5gcNUoGQ1kHZ3Yoksqh6U1hRCzlkMSbX6kzDYUNEgc47t2AKxLM5IpYCWAv+uefNAAb/4+f7Qh4sMqtXHc5lGK3GN8ABTIVeFphtJg36Y6xg8OTrBR5ItS/tdy6zyfTLfZFocRbfjsLfoiCeHJO0sEZIWgHsu80FVZmo4G84N6zNZkdjnFDZkgRYP9OSqMbPCXyb5Xj1H6g67rNjtY67B3613uGJ0pHCQpl0Lmz2apUMq9EVRz5tZT+RA8sCRcK4mkBEWzdC7ngI5+dfX2dEqu157rsc0yU4OWNElLWC3F1TXOsB2/n1+LBHpjKLIMok2afui1H9+eof1zLAba4hrnYEFI4WjvEAvcsyPI/eONNdxk7liVNNaD7j6vvwYKOxTZoriKwvGxeNApC+Z8xQ8HpnEaRIUqb2Eh1SfpyDta8J1dXnRF1HTq2pOvfitomb701g0diB7+StEpCxiRLCx3TEJcroqBiCE3szXdc9VSVyfklkHmbJE33CY8tGm1YEvaXAY7a5yWLHWHzqQvNuZkQ1DNbJAkP9dt1t8Fv3njG2lXFmAOJkZwpvm9qEHZTmuUmflIMhu9nMsgZd5VMjalTmHqZdy7zmnAz8LhYiUDMbPDNOd4UTehvTanDEBBYTJB6CYv6QnBYwuAPsZwRnZdHbpl6lIXStmgsxV3DLtKAUy8eoqCdDOMyep9L4ArSWEJstEBNkZ5zgk7bOspvF1V8HrhFzJCiwR7WC+GHJTHLH1S8FfmHFTXJHecvq6tpMncaJFbo4jSfm9ozBAVAAN2mCn/yBbmX9tPmXdGEsTSpdp6vVWKEdHZ1rjCqmgDENxh75H5uT9DeZ0mAKwkP5Ai+bN3hT0y1XGE44b/aJ7PEObogYAioej/Z690zKx+fHxP50juTgt+UIQ+l/mpcYnbcYe4lkXrqGpwxFU8OrRzzfJX/s90VVlzrQVAPNW/mvYkt+MqSVwI1EP62faXlXnDqbmVFUmMGeoquP58cwqSBaNL/oi2Rg7GVvdvus+i2Qpm1SHtnPVUhTwWFigiWw/T2ZZeUs4nk+Q/xOFa/"
application/json
{
  "device_id": "ZtzhX7M96stcA2LzDpX1Lg8dev",
  "device_data": "Web;179ac83968ab42f79e960c1753a4078fdcon;jVl14emA+OcyALb9F+CMFg==;NU7aFh0jdzM15wj8hQtqbA5LbzEFWDI1bUwZf/zbau0P2MIEUE+LsifBKvxjCYNUyz647bpSjnQ6Tu8IK22sxFlTGEFaHKBigzmP8Nc8FvVSWKzslmSWTFJM5AYc+EGTZLprlcdrLldsZLS5PpHfPMmvtqCXVTnGhYV7GvutI1w5/67yK7pCQDxDicKjqlMg1naMiwCuqP1U1lUtf+lTdmJ1T1lXMPARffTn4XAr66vUxN++sy7qytkdcOeCsaxZnLspUEvqu+2ILHF8pOJFG7gYC11rqWOyHG3Ns1E1dZ57ybrgGTKfctFOdx2IMXnz1/i/pDC5QokRr2BTIZZ/9Tj+xXzWpzNwHtRWWK5VEufyVRPyMXQdmry7UYKrouAzlLCYSMv7GcPwOZz+gDjCkrNia7/DGBBFLOvtlufDztPpvkH2jmN32/oJHl1Qu6zpxG3Lyl8RNdyukuNYfiPw0ECoXsXObwQc7Ja8R+V5S7QZeV1VV9aavlH1+Xl9v0OlOJ1XujO7izWESMIfzAuaL6ACYhdkmkC3kicjOWUjaY3OJYrrXxQ+MScnJOQ9neMRWij7YqNxP8F259zVjqqyaL6hN8EZU/pi+cZUVkfFvMYT5ugE9JXjkFfyy4UQeSmNRjDXRzu40LyweqUns8u3GOIFzfZ9eVOv+q7OV+RpVLOJLz1Za8RPIh3UKltCzOTmO8OpDz2aGoqNdL4zAaLl4EKRoarEiSG9K2/GoyHchi6xdHYA6DqQg5xQM4s50RUySGwWLxBB3ZlMpZpdZAVBrLSyl1SWqYTosdyURtiiX0So+kdik5XJ5Vsh0v75rNP5Yrv3t5/u94wx51zKlpDH8Uiap7kP0eibRmmN196kxMcOf8Q50JM1Yt8cJiawTWdGHzGRcNtEkpon5VLp/kwDU+4IPwlW976hKsom0PTB/EVxo5CWuL6kPiaEWUrWOL7BZ2jkuebHT2jBAJuFBaeac7IYnrAMoLgfY33Vs3EtVk8H12iDX3O9JmGsDGXP0/vBx0uFEgrTt6HjwabWGRHpPPPCorSrjfuySwKlnZtp1KkeNrOso8K8DBW6e+6j1YYaxTjBUZSLl1qgzd1dpz85vB/trWdyS3i+APHw/AsP/Y4cmu/CFZqpe1Sgye1+YNP3Hs3LpxJKM3prnAoaCmrHp5aUKo5KdicAnilBTzBAV2zGBWHrBwWLWHl+RDQpncyWD2/ZCswxtXbQAhlmVD7FvBXnT0Yyg5gaFo5GVBcURzBYtwbdl3+6sqKtR3XC22GBw0OOqZ9/QvMHmCO/K89rEjfLEaVX4eKhrdzjxOwOxmE5lXrLqfscV90Yo9Uj1awvpF5TL5vW85asT2iVHYjZ1JsQ5oLp3VUfIAqTNmpcjRk763hMsTUIrn3VfpLkGajZbtxD2FuNNMoRZQBfiOAxPUDFmspxWagNSbmUZ8FqPX/6asQIJIyvAk4cvzgV9OjzdkoEcFP2OGjFnddZtLmBh9BZDWtS3VOL98lp+cH/JAn8pDab2l6zIwHRccePbuBcGZZgU39FOVpI+sbHZJ6QEhiUA8SdT7SLcTf4P1tBbdN5+dpjaWfTph1cgZyW8EsAIFc81vR6tBqSSpxmS164ADWZW+PYz4b4SRVklT3Cs2tJ/TTMM240pnkNJUd3G/0PbBGVPea5+XUs1bF5cT0fiHWA032Dm87biMEU89fdPkvnSlIsN/MbLT2kj2tPZqhOrqTxCg26jimd+2kNdZ2fwvT8JQfO0hVidnPDPLXH5aA6T6+bKqfpvJE6USAif8fPQ0rW4+315LKH5wG8Qj0omO2Ynii0IE6cR0lAGrtoLsXMf3kDqFms+Z2h79pYQrnhUSntZ3tjt3pwgejJ8ZKXdN7kYWT8UiQnLnkfLJnh1e8a4UURe7GU9UwnqqFXeHrstb8XXxiIX7syFG5iLdN9IExi5BefYnAikCTU+ssMWnnhppX6jFV43u+KEaa1/7AqibMc3Kt+kUxHlQsAo2TCg+u/39rsgNs5eWym7YptvBCN6L4Q4QRoKNFo8CJerS4dTxksD2zeGL4BLIsvMbcm6rlHrKCR5PeWRiFpK8QwwaOyiTGL5NN2Xl6F0M4vf5gnWikZTrppv7bLUYZhrU1uGiv968ZGEq+A7w2oLvbZS7l+DZuN4rPF5SzPWq94jC1NiYjaPrGyTQIISRiBLXil5puqCobYHAIeVQzHBgki3/N+Pwk4iCrxf3pqnUSNmtrmvphmo9Vp3xAaPSFsUYfIyOPiO5gcNUoGQ1kHZ3Yoksqh6U1hRCzlkMSbX6kzDYUNEgc47t2AKxLM5IpYCWAv+uefNAAb/4+f7Qh4sMqtXHc5lGK3GN8ABTIVeFphtJg36Y6xg8OTrBR5ItS/tdy6zyfTLfZFocRbfjsLfoiCeHJO0sEZIWgHsu80FVZmo4G84N6zNZkdjnFDZkgRYP9OSqMbPCXyb5Xj1H6g67rNjtY67B3613uGJ0pHCQpl0Lmz2apUMq9EVRz5tZT+RA8sCRcK4mkBEWzdC7ngI5+dfX2dEqu157rsc0yU4OWNElLWC3F1TXOsB2/n1+LBHpjKLIMok2afui1H9+eof1zLAba4hrnYEFI4WjvEAvcsyPI/eONNdxk7liVNNaD7j6vvwYKOxTZoriKwvGxeNApC+Z8xQ8HpnEaRIUqb2Eh1SfpyDta8J1dXnRF1HTq2pOvfitomb701g0diB7+StEpCxiRLCx3TEJcroqBiCE3szXdc9VSVyfklkHmbJE33CY8tGm1YEvaXAY7a5yWLHWHzqQvNuZkQ1DNbJAkP9dt1t8Fv3njG2lXFmAOJkZwpvm9qEHZTmuUmflIMhu9nMsgZd5VMjalTmHqZdy7zmnAz8LhYiUDMbPDNOd4UTehvTanDEBBYTJB6CYv6QnBYwuAPsZwRnZdHbpl6lIXStmgsxV3DLtKAUy8eoqCdDOMyep9L4ArSWEJstEBNkZ5zgk7bOspvF1V8HrhFzJCiwR7WC+GHJTHLH1S8FfmHFTXJHecvq6tpMncaJFbo4jSfm9ozBAVAAN2mCn/yBbmX9tPmXdGEsTSpdp6vVWKEdHZ1rjCqmgDENxh75H5uT9DeZ0mAKwkP5Ai+bN3hT0y1XGE44b/aJ7PEObogYAioej/Z690zKx+fHxP50juTgt+UIQ+l/mpcYnbcYe4lkXrqGpwxFU8OrRzzfJX/s90VVlzrQVAPNW/mvYkt+MqSVwI1EP62faXlXnDqbmVFUmMGeoquP58cwqSBaNL/oi2Rg7GVvdvus+i2Qpm1SHtnPVUhTwWFigiWw/T2ZZeUs4nk+Q/xOFa/",
  "signature": "556F4558783743346570744B674D3838454E3444334F627141394E696735726B3946593739356B413353337359767A34756F387977754D2F4658536134327A41394454716D3337616570764335346A477276744579376246514B546C79465A6A7A532F577545722B4946644A4A2F674953784E7A715451765A3077432B39486E6F4B7A36447050725537695657476A626B3057366549746363312F577654742F39594D4B726B7541506E49426B4A74426B737254687867562B3169636155582B432B426F41696A64544A314D773774624F70556F4C686257392F496936773235744472494E33564A6166446E6F634E523438335469595568382B70343946703473395971434872503270395959616B513155795673444635504B45596B75784A2F7A797933334779686732744D5473435238476B7959657648372F31733532472B6C73573048754F597A4C364E324954426B6C666D413D3D0D0A",
  "jwk": {
    "kty": "RSA",
    "use": "enc",
    "alg": "RS256",
    "kid": "cf8e03cd-0292-47e2-8e26-c167293b9187",
    "n": "ZtzhX7M96stcA2LzDpX1Lmr0Y7tH1JnHvK5BmRQsy5hm1vAneRgictJB7yfW9JcZSpHeDspVkXVXuL3ddO1tVWOs4pln65Iklz5EtYKgoKaVBkUFNP1wDgEDTPhX6dS46/Ua1Z39RPAl21s2gQkzAL8UjC67kwH+FJnzLqBEE57L0eJNOU2VnBVwVob8GM8B6/KTblhr5wUw/o1K2qFXhjpkopz+SV1mqd61I/9H8gvb/clKuwpI+c/jyV0O55Y7vQDBdL37MReuSgHJvYtOnjLSHTNrB+lhNt6kg/MEtfs/e6iX+MV9d4Is5AvkDSXcMg+Im4aiKK4UeKcrSOtTcw==",
    "e": "AQAB"
  },
  "jwe": {
    "alg": "RSA1_5",
    "enc": "A256GCM"
  }
}

Responses

Successful result of the operation

Bodyapplication/json
datastring

The JWE-encrypted card details. Use one of the following libraries for decryption:

Example: "W2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awaW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awaW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awaW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awaW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awaW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awa"
Response
application/json
{
  "data": "W2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awaW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awaW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awaW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awaW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awaW2QvzqY368QQMicAtaSqzs8KJZgnYb9c7d0zgdAZHzu6qMQvRL5hajrn1n91CbOpbISD08qNLyrdkt-bFTWhAI4vMQFh6WeZu0fM4lFd2NcRwr3XPksINHaQ-G_xBniIqbw0Ls1jF44-csFCur-kEgU8awa"
}

(Deprecated) Report a card as lost or stolenDeprecated

Request

Note: This endpoint is deprecated. Please use the POST Replace a card endpoint instead. Read the endpoint summary to learn how to use the endpoint for the lost/stolen use case.

Reports the card specified in the request URL as lost or stolen. The card will be immediately blacklisted. Please note the following:

  • Please note that virtual cards can only be reported lost or stolen without requesting a replacement.
  • The status of the card must only be one of the following values: ACTIVE, INACTIVE, BLOCKED, or BLOCKED_BY_SOLARIS.
  • Only use this endpoint in the event that the card is lost or stolen or if the card details have been compromised. If a physical card is damaged, please use the POST Replace a card endpoint.
  • You can order a replacement card in the same API call by setting the value of order_replacement to true.
  • When a card has been reported as lost or stolen, it immediately stops working. This action cannot be undone.
  • If the customer has added their card to Google Pay or Apple Pay, reports it lost or stolen, and requests a replacement at the same time, then the lost/stolen card will continue to work. If the cardholder believes that their card and phone were both compromised, then you should not order them a replacement card in the same API call. Instead, use the POST Create a card endpoint to order them a new one.
  • For sandbox testing, you must set the value of lost_at to 2021-06-03T18:31:09+00:00.

Path
card_account_idstringrequired
Bodyapplication/json
loss_reasonstringrequired

The customer's reason for reporting the card as lost or stolen.

Enum"COUNTERFEIT_PLASTIC""HOME_INVASION""LEFT_AT_MERCHANT""LOST""MAIL_ORDER""MAILBOX_THEFT""MISSING_AT_HOME""PICK_POCKET""PREVENTIVE_BLOCK""SUSPECTED_MERCHANT_FRAUD"
Example: "HOME_INVASION"
lost_atstring(date-time)required

Timestamp from when the card was lost (ISO 8601 format).

Example: "2020-01-13T09:56:24.000Z"
order_replacementboolean

Boolean to indicate whether or not to order the customer a replacement card in the same API request. Note that you can set this to false and order the customer a new card in a separate API call, e.g., if they lost a tokenized card.

retain_pinboolean

(If ordering a replacement card right away) Boolean to indicate whether the new card should retain the same PIN.

application/json
{
  "loss_reason": "HOME_INVASION",
  "lost_at": "2020-01-13T09:56:24.000Z",
  "order_replacement": false,
  "retain_pin": false
}

Responses

Successful result of the operation

Bodyapplication/jsonArray [
idstring

ID of the lost/stolen card incident.

Example: "a2f0129cb1194a688dace3b678a85268"
card_idstring

ID of the card that was lost or stolen.

Example: "8febdba4912a747808ccc6f95f82aaa4"
loss_reasonstring

The customer's reason for reporting the card as lost or stolen.

Enum"COUNTERFEIT_PLASTIC""HOME_INVASION""LEFT_AT_MERCHANT""LOST""MAIL_ORDER""MAILBOX_THEFT""MISSING_AT_HOME""PICK_POCKET""PREVENTIVE_BLOCK""SUSPECTED_MERCHANT_FRAUD"
Example: "MAILBOX_THEFT"
lost_atstring

UTC timestamp from when the customer reported the card as lost or stolen.

Example: "2023-05-23T12:56:45+00:00"
card_statusstring

The current status of the card.

Enum"ACTIVE""ACTIVATION_BLOCKED_BY_SOLARIS""BLOCKED""BLOCKED_BY_SOLARIS""CLOSED""CLOSED_BY_SOLARIS""COUNTERFEIT_CARD""FRAUD""INACTIVE""LOST"
Example: "STOLEN"
]
Response
application/json
[
  {
    "id": "a2f0129cb1194a688dace3b678a85268",
    "card_id": "8febdba4912a747808ccc6f95f82aaa4",
    "loss_reason": "MAILBOX_THEFT",
    "lost_at": "2023-05-23T12:56:45+00:00",
    "card_status": "STOLEN"
  }
]

Encrypted PIN Change

Operations

Card spending controls

Operations

Card transactions

Operations

Card transactions simulation

Operations

Card Delivery Tracking API

Operations