Card status notification

When the WorldCard status is changed, WorldFirst sends you a notification of the status update.

Structure

A message consists of a header and body. The following sections are focused on the body structure. For the header structure, see:

Request parameters

requestId String  REQUIRED

The unique ID assigned by the partner to identify the status change request.

More information:

  • Maximum length: 32 characters

assetId String  REQUIRED

The unique identifier of a card.

cardStatus String  REQUIRED

The card status. Valid values are:

  • ACTIVE
  • FROZEN
  • CALCEL

lastUpdate String  REQUIRED

The last time when the card status was updated.

This parameter uses a timestamp such as 1722308496237.

Response parameters

result Result  REQUIRED

The result of the API call.

Respond to WorldFirst with this parameter to acknowledge the reception of the status change notification.

Show child parameters
API Explorer

Request

Request Body

Response

Response Body

Result processing logic

After receiving the result notification, you must send a response to acknowledge receipt.

Note: You must sign the message before making the response. For more information, see Sign a request and validate the signature and the Response header.

If you do not acknowledge receipt, WorldFirst will retry sending the result according to the following rules:

  • WorldFirst retries sending the notification up to 7 times.
  • Intervals between notifications: 2m, 10m, 10m, 1h, 2h, 6h, and 15h.

result.resultCode

CodeValueMessageFurther action
SUCCESSSSuccess
PROCESS_FAILFA general business failure occurred. Do not retry.

Human intervention is usually needed. Contact our Technical Support Team to resolve the issue.

UNKNOWN_EXCEPTIONUAPI failed due to unknown reason.

The service might be down, please retry later. If the issue persists, contact our Technical Support Team.

@2024 WorldFirst