PApaymentology
Card V2

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.

post/pws/v2/pws_set_card_status/

Request

  • Base URL
    https://api.uat.paymentology.com/ppws/api
  • URL
    https://api.uat.paymentology.com/ppws/api/pws/v2/pws_set_card_status/
  • Auth
    none declared

Request body

api_call_unique_identifierstring required
<p>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.</p>
client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

status_nwkstring required
<p>The requested network status. This field is required and validated for both actions. With <code>action=1</code>, Lume applies the requested value. With <code>action=2</code>, 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 <code>action=1</code>.</p><p>Allowed values:</p> <ul> <li class="docBullet">1000 : Fully operational DE39=00</li> <li class="docBullet">1001 : Refer to issuer DE39=01</li> <li class="docBullet">1004 : Capture card DE39=04</li> <li class="docBullet">1005 : Decline all txns DE39=05</li> <li class="docBullet">1006 : Inactive - pin blocked DE39=75</li> <li class="docBullet">1007 : Decline all txns (Visa: DE39=12) (MC: DE39=14)</li> <li class="docBullet">1008 : Honour with ID DE39=08</li> <li class="docBullet">1009 : Void card (Visa: DE39=46) (MC: DE39=62)</li> <li class="docBullet">1010 : Due Payment Block</li> <li class="docBullet">1011 : KYC/AML/compliance hold</li> <li class="docBullet">1041 : Lost card - capture DE39=41</li> <li class="docBullet">1043 : Stolen card - capture DE39=43</li> <li class="docBullet">1054 : Expired card - report DE39=54</li> <li class="docBullet">1154 : Expire card - don't inform</li> <li class="docBullet">1062 : Restricted card</li> <li class="docBullet">1199 : Void card - report DE39=05</li></ul><p>DE39 is the payment network response-code field; the listed values explain the authorization response associated with each status.</p>
tokeninteger required

Public token for the card

user_idstring

User Id of the Customer who triggered the API request.

remarksstring

Remarks for API request

actioninteger
<p>The status-change operation to perform.</p><ul><li class="docBullet"><code>1</code> — Apply the requested <code>status_nwk</code> 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.</li><li class="docBullet"><code>2</code> — Activate a pending physical-card renewal by applying its stored expiry and network status. While a pending renewal exists, its stored <code>status_nwk</code> overrides the value supplied in this request. You must still supply a valid <code>status_nwk</code> to pass request validation. Activation does not necessarily set the status to <code>1000</code>.</li></ul><p>Default: <code>1</code>. Use <code>1</code> for a normal status change, including a separate status change after renewal activation. For example, if renewal stored <code>1005</code>, first activate it with <code>action=2</code>, then send a separate request with <code>action=1</code> and <code>status_nwk="1000"</code>. Use a new <code>api_call_unique_identifier</code> for each separate operation.</p>
notestring

Short note of card status change

update_digital_tokenboolean

Update all linked digital token. Default value is false.

Example request

{
  "api_call_unique_identifier": "438574845790657485",
  "client_id": 760131,
  "status_nwk": "1000",
  "token": 311012081,
  "action": 1
}

Response

Successful Response

Example response

{
  "header": {
    "error_desc": "success"
  },
  "body": {
    "status_nwk": 1041
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.