Set Card Status V2

This web service sets the status for a token(card) and verifies the system and network status of a card. This can be used in changing the status of a card while card is still in use or alternatively when the card is renewed.version 2 supports idempotency.

Recipes
💳
Set Card Status
Open Recipe

Change status before or after renewal activation

This flow applies to a physical card renewed through Card Renewal V2 with card_action=2, the same card product, and the same PAN and token.

  • Use action: 1 to change the current card status. Before renewal activation, this keeps the current expiry and does not change the status stored for the pending renewal.
  • Use action: 2 when you are ready to activate the pending renewal. Banking.Live applies the new expiry and the status stored during renewal, even if you supply a different status_nwk in the activation request.

For action: 2, you must still supply a valid status_nwk because the API validates this required field. When activating a pending renewal, the supplied value does not determine the resulting network status; Banking.Live applies the status saved during renewal. The "1000" value in the activation examples satisfies validation and does not override the saved status. To change the status after activation, send a separate request with action: 1.

Activation and setting an operational status are separate behaviors. A successful activation can leave the card at 1005 if that was the status stored during renewal.

Recover from a renewal submitted with status 1005

If you want to restore the current card before activating the renewal:

  1. Call this endpoint with the same token, action: 1, and status_nwk: "1000". This restores the current network status without applying the new expiry. The card remains subject to its current expiry and other authorization checks.
  2. When you are ready to activate the renewal, call this endpoint with action: 2 and status_nwk: "1000". The new expiry is applied, but the status becomes the stored renewal status, 1005.
  3. After activation succeeds, send a separate request with action: 1 and status_nwk: "1000" to make the renewed card operational.

If you are ready to activate immediately, start at step 2. If you have already activated the renewal and its status is still 1005, use step 3. Use a new api_call_unique_identifier for each separate operation.

The request field status_nwk is a string. For action: 2, the response reports the resulting network status as an integer; check this value rather than assuming that the requested status was applied.

Results and retries

Treat header.error_id: 0 as success. HTTP 200 alone does not confirm that the operation succeeded. If header.error_id is nonzero, stop the dependent call sequence and inspect header.error_desc before deciding whether to retry or correct the request.

After a timeout, HTTP 500, or a lost response, retry the same operation at the same endpoint with the same api_call_unique_identifier and unchanged request body. Keep the original request so that optional fields and values remain unchanged. Use delayed, bounded retries; do not start activation or another dependent operation until the previous operation has a confirmed successful result.

If the original status request succeeded, an identical duplicate returns its recorded response without applying the status operation again. That response describes the original operation, not necessarily the card's current state after later changes.

  • 1066: the original request is still processing. Wait and retry the unchanged request with the same identifier. Do not use a new identifier to bypass this response.
  • 993: the identifier has already been used with different request data. Restore the original body if you are retrying it. For a genuinely different operation, use a new identifier after resolving the original outcome.
  • If the recorded operation failed with 987, 988, 989, 1034, or 1066, an identical retry is eligible for reprocessing. Retry with the same identifier and body after a delay; reprocessing does not guarantee success. The processing-pending rule above takes precedence for 1066.
  • Other recorded failures are returned again for an identical duplicate. Do not keep retrying them unchanged. Correct invalid input and use a new identifier for the corrected request only when the original outcome is resolved. If the error is unexplained or persists, stop and contact Paymentology support with the identifier.

After confirmed activation success, check the resulting body.status_nwk. If it differs from the desired status because activation applied the stored renewal status, issue action: 1 as a new operation with a new identifier. Replaying the successful activation with its old identifier does not perform this status change.

Body Params
string
required
length between 1 and 40

The identifier for this operation. Use a new value for each separate renewal, activation, or status change. To retry the same operation after a timeout or lost response, reuse its identifier and send the same request body to the same endpoint. Do not reuse an identifier with changed request data. See the page's retry instructions for duplicate and failed-request behavior.

int32
required
≥ 1

Unique identifier for the client which Paymentology will provide at outset

string
required
length ≥ 1

The requested network status. This field is required and validated for both actions. With action=1, Banking.Live applies the requested value. With action=2, activating a pending renewal applies the status saved during renewal; the supplied value does not override it. To change the status after activation, send a separate request with action=1.

Allowed values:

  • 1000 : Fully operational DE39=00
  • 1001 : Refer to issuer DE39=01
  • 1004 : Capture card DE39=04
  • 1005 : Decline all txns DE39=05
  • 1006 : Inactive - pin blocked DE39=75
  • 1007 : Decline all txns (Visa: DE39=12) (MC: DE39=14)
  • 1008 : Honour with ID DE39=08
  • 1009 : Void card (Visa: DE39=46) (MC: DE39=62)
  • 1010 : Due Payment Block
  • 1011 : KYC/AML/compliance hold
  • 1041 : Lost card - capture DE39=41
  • 1043 : Stolen card - capture DE39=43
  • 1054 : Expired card - report DE39=54
  • 1154 : Expire card - don't inform
  • 1062 : Restricted card
  • 1199 : Void card - report DE39=05

DE39 is the payment network response-code field; the listed values explain the authorization response associated with each status.

int64
required
≥ 1

Public token for the card

string
length between 0 and 50

User Id of the Customer who triggered the API request.

string
length between 0 and 200

Remarks for API request

int32
1 to 2

The status-change operation to perform.

  • 1 — Apply the requested status_nwk to the current card. For a pending physical-card renewal that retains the same token, this does not apply the new expiry or change the status stored for that renewal.
  • 2 — Activate a pending physical-card renewal by applying its stored expiry and network status. While a pending renewal exists, its stored status_nwk overrides the value supplied in this request. You must still supply a valid status_nwk to pass request validation. Activation does not necessarily set the status to 1000.

Default: 1. Use 1 for a normal status change, including a separate status change after renewal activation. For example, if renewal stored 1005, first activate it with action=2, then send a separate request with action=1 and status_nwk="1000". Use a new api_call_unique_identifier for each separate operation.

string
length between 0 and 200

Short note of card status change

boolean

Update all linked digital token. Default value is false.

Responses

404

Webservices does not exist

500

Internal Server error

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json