Sign in
latestOpenAPI 3.0.12026-08-104068226.2 KB

a772504dcc9e

Cards servicing

Replace a card

Issues a replacement for the card specified in the request URL. Specify the appropriate reason in your request to trigger the right replacement process: <ul> <li>Reissue a card expiring soon: EXPIRES_SOON</li> <li>Replace a damaged card (physical card only): DEFECTIVE_CARD, CARDHOLDER_REQUEST (Deprecated) </li> <li>Report a card as lost or stolen and request a replacement (physical cards only): LOST, STOLEN, COUNTERFEIT_PLASTIC, PREVENTIVE_BLOCK, ONLINE_TRANSACTION_FRAUD</li> </ul> Please note the following: <br> For the reissue or replace flows: <ul> <li>The new card will have the same card number, but it will have a new CVV and expiry date.</li> <li>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.</li> <li>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.</li> </ul> For the lost/stolen flow: <ul> <li>The new card will have a different card number.</li> <li>The old card will stop working immediately upon acceptance of the API request. This action cannot be undone.</li> </ul> Accepted card statuses: <ul> <li>Reissue: ACTIVE, INACTIVE</li> <li>Replace and Lost/Stolen: ACTIVE, INACTIVE, BLOCKED, BLOCKED_BY_SOLARIS</li> </ul> Please note that on Sandbox a given card can only be replaced once.

post/v1/cards/{card_account_id}/replace

Path parameters

card_account_idstring required

Request body

line_1string

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

line_2string

Additional optional embossing line. For Replace flow only.

reason'CARDHOLDER_REQUEST' | 'COUNTERFEIT_PLASTIC' | 'DEFECTIVE_CARD' | 'EXPIRES_SOON' | 'LOST' | 'ONLINE_TRANSACTION_FRAUD' | 'PREVENTIVE_BLOCK' | 'STOLEN' | 'SUSPECTED_MERCHANT_FRAUD'

The reason why the customer is requesting a replacement card.

referencestring

Randomly generated UUID that acts as an idempotency key.

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.

reported_atstring date-time

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

Example request

{
  "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"
}

Response

Successful result of the operation

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.

Example response

{
  "id": "2b890724292e287935420a2ca13ae7f9mcrd"
}