Sign in
latestOpenAPI 3.0.12026-08-104068226.2 KB

a772504dcc9e

Cards servicing

Close a card

Closes the card with the ID specified in the request URL.<br> Note: this action cannot be undone.<br> In order to be closed, the card must have one of the following statuses: <ul> <li>ACTIVE</li> <li>BLOCKED</li> <li>COUNTERFEIT_CARD</li> <li>FRAUD</li> <li>INACTIVE</li> <li>LOST</li> <li>NEVER_RECEIVED</li> <li>STOLEN</li> </ul>

post/v1/cards/{card_account_id}/close

Path parameters

card_account_idstring required

Request body

close_reason'EXPIRED' | 'CARDHOLDER_REQUEST' | 'DELIVERY_RETURN' | 'DEFECTIVE_CARD' | 'LOST' | 'LOST_IN_TRANSIT' | 'STOLEN' | 'COUNTERFEIT_PLASTIC' | 'ONLINE_TRANSACTION_FRAUD' | 'PREVENTIVE_BLOCK' | 'SUSPECTED_MERCHANT_FRAUD'

The reason why the customer is requesting to close the card.

close_commentstring

Additional comments provided by the customer when requesting to close the card.

Example request

{
  "close_reason": "CARDHOLDER_REQUEST",
  "close_comment": "Closing the card due to customer request"
}

Response

Successful result of the operation

expiration_datestring

The expiration date of the card.

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).

person_idstring

ID of the cardholder person resource.

account_idstring

ID of the account to which the card is tied.

business_idstring

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

sia_account_numberstring

SIA account number

creation_datestring

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

idstring

ID of the card.

status'ACTIVE' | 'ACTIVATION_BLOCKED_BY_SOLARIS' | 'BLOCKED' | 'BLOCKED_BY_SOLARIS' | 'CLOSED' | 'CLOSED_BY_SOLARIS' | 'COUNTERFEIT_CARD' | 'FRAUD' | 'INACTIVE' | 'LOST' | 'NEVER_RECEIVED' | 'PROCESSING' | 'STOLEN'

The current status of the card.

referencestring

Unique reference number for the card.

type'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' | 'VISA_CREDIT' | 'VIRTUAL_VISA_CREDIT' | 'VISA_BUSINESS_CREDIT' | 'VIRTUAL_VISA_BUSINESS_CREDIT'

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

Example response

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