Reissue Card

post/api/cards/{cardId}/reissue

Reissues a card, creating a new replacement card linked to the original. Returns the ID of the new card.

Request

Path Parameters

cardIdstringrequired
ID of card

Body application/json

reissuanceTypestringrequired
Allowed values:standard-renewal
The reason for reissuance.
languagestring
Carrier language for a physical card, in ISO 639-1 Alpha-2 format. Required if card program supports physical cards. The carrier is the physical packaging to which the card is attached for delivery.
shippingMethodstring
Allowed values:standard-courierpremium-courier
Shipping method for a physical card. Required if card program supports physical cards.
shippingAddressobject
Shipping address for a physical card. Required if card program supports physical cards. Only one of the optional fields companyName or addressLine2 can be provided. Each field must be less than 35 characters.
- companyNamestring
  (Optional) Company name.
- countrystring
  The ISO 3166-2 Country code of the country the address is in.
- statestring
  (Optional) State, province, prefecture, canton, region. Use local abbreviations such as VIC (Victoria) or TX (Texas).
- townstring
  City, town, village, ward, municipality
- postalCodestring
  Postal code
- addressLine1string
  First line of an address. Can represent street number and name or a PO Box. Max 35 characters.
- addressLine2string
  (Optional) Second line of an address. Max 35 characters.

Response

Successful operation.

Body application/json

cardIdstring
The ID of the reissued (replacement) card

Request fields are invalid, or the request could not be processed for the reason stated in the message.

SHIPPING_ADDRESS_REQUIRED Card program is configured for physical cards but no shipping address was provided.

SHIPPING_METHOD_REQUIRED Card program is configured for physical cards but no shipping method was provided.

LANGUAGE_REQUIRED Card program is configured for physical cards but no carrier language was provided.

PHYSICAL_CARD_CONFIGURATION_INVALID The combination of card program, region, shipping method, and carrier language is invalid.

SHIPPING_ADDRESS_LINE_TOO_LONG A formatted shipping address line exceeds the maximum line length allowed for the card carrier.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
errorsobject[]
Items
- messagestring
- pathstring
  The location of the invalid path param, query param or payload attribute.

User is not allowed to perform the action with the reason stated in the message.

FORBIDDEN Insufficient permissions to perform the action, or a business rule violation has occurred.

CARD_NOT_FOUND Card ID not found.

SHIPPING_COUNTRY_UNSUPPORTED The shipping country is not supported for physical card reissuance.

CARD_REISSUE_NOT_ALLOWED The card cannot be reissued. The card has already been reissued and a replacement card exists, the maximum number of reissues for this card has been exceeded, the card is not in an active (reissuable) state, the cardholder or card is blocked from card creation, or a reissue is already in progress for this card.

KYC_REQUIRED Cardholder has no KYC profile, or KYC profile has not passed.

CONTACT_EMAIL_REQUIRED Cardholder does not have a contact email.

CONTACT_PHONE_REQUIRED Cardholder does not have a contact phone.

Body application/json

statusCodeintegerrequired
statusNamestringrequired
errorCodestringrequired
reasonstring

Example

Example Request

ServerAuthentication

curl 'https://api.immersve.com/api/cards/{cardId}/reissue' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reissuanceType": "standard-renewal",
  "language": "en",
  "shippingMethod": "standard-courier",
  "shippingAddress": {
    "companyName": "Immersve",
    "country": "NZ",
    "state": "AKL",
    "town": "Auckland",
    "postalCode": "1050",
    "addressLine1": "3A Victoria Avenue",
    "addressLine2": "Floor 1"
  }
}'

curl 'https://api.immersve.com/api/cards/{cardId}/reissue' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reissuanceType": "standard-renewal",
  "language": "en",
  "shippingMethod": "standard-courier",
  "shippingAddress": {
    "companyName": "Immersve",
    "country": "NZ",
    "state": "AKL",
    "town": "Auckland",
    "postalCode": "1050",
    "addressLine1": "3A Victoria Avenue",
    "addressLine2": "Floor 1"
  }
}'

curl 'https://api.immersve.com/api/cards/{cardId}/reissue' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reissuanceType": "standard-renewal",
  "language": "en",
  "shippingMethod": "standard-courier",
  "shippingAddress": {
    "companyName": "Immersve",
    "country": "NZ",
    "state": "AKL",
    "town": "Auckland",
    "postalCode": "1050",
    "addressLine1": "3A Victoria Avenue",
    "addressLine2": "Floor 1"
  }
}'

curl 'https://api.immersve.com/api/cards/{cardId}/reissue' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reissuanceType": "standard-renewal",
  "language": "en",
  "shippingMethod": "standard-courier",
  "shippingAddress": {
    "companyName": "Immersve",
    "country": "NZ",
    "state": "AKL",
    "town": "Auckland",
    "postalCode": "1050",
    "addressLine1": "3A Victoria Avenue",
    "addressLine2": "Floor 1"
  }
}'

curl 'https://test.immersve.com/api/cards/{cardId}/reissue' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reissuanceType": "standard-renewal",
  "language": "en",
  "shippingMethod": "standard-courier",
  "shippingAddress": {
    "companyName": "Immersve",
    "country": "NZ",
    "state": "AKL",
    "town": "Auckland",
    "postalCode": "1050",
    "addressLine1": "3A Victoria Avenue",
    "addressLine2": "Floor 1"
  }
}'

curl 'https://test.immersve.com/api/cards/{cardId}/reissue' \
  --request POST \
  --header 'Authorization: Bearer <access-token>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reissuanceType": "standard-renewal",
  "language": "en",
  "shippingMethod": "standard-courier",
  "shippingAddress": {
    "companyName": "Immersve",
    "country": "NZ",
    "state": "AKL",
    "town": "Auckland",
    "postalCode": "1050",
    "addressLine1": "3A Victoria Avenue",
    "addressLine2": "Floor 1"
  }
}'

curl 'https://test.immersve.com/api/cards/{cardId}/reissue' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reissuanceType": "standard-renewal",
  "language": "en",
  "shippingMethod": "standard-courier",
  "shippingAddress": {
    "companyName": "Immersve",
    "country": "NZ",
    "state": "AKL",
    "town": "Auckland",
    "postalCode": "1050",
    "addressLine1": "3A Victoria Avenue",
    "addressLine2": "Floor 1"
  }
}'

curl 'https://test.immersve.com/api/cards/{cardId}/reissue' \
  --request POST \
  --header 'X-Api-Key: <api-key>' \
  --header 'X-Api-Secret: <api-secret>' \
  --header 'X-Account-Id: <target-account>' \
  --header 'Content-Type: application/json' \
  --data '{
  "reissuanceType": "standard-renewal",
  "language": "en",
  "shippingMethod": "standard-courier",
  "shippingAddress": {
    "companyName": "Immersve",
    "country": "NZ",
    "state": "AKL",
    "town": "Auckland",
    "postalCode": "1050",
    "addressLine1": "3A Victoria Avenue",
    "addressLine2": "Floor 1"
  }
}'

Example Response

{
  "cardId": "string"
}

{
  "statusCode": 400,
  "statusName": "Bad Request",
  "errorCode": "INVALID_REQUEST_INPUT",
  "errors": [
    {
      "message": "Invalid type",
      "path": "items[1].attributes.invalidField"
    }
  ]
}

{
  "statusCode": 403,
  "statusName": "Forbidden",
  "errorCode": "FORBIDDEN",
  "reason": "Unauthorized"
}