v1

latestOpenAPI 3.0.02026-07-242035712.0 MB
Card

Set Card Status

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.

post/pws/pws_set_card_status/

Request body

api_call_unique_identifierstring required

Unique number that must be passed at each API request. Identifier to make each API request unique

client_idinteger required

Unique identifier for the client which Paymentology will provide at outset

status_nwkstring required
<p>Status network :</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>
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
<ul> <li class="docBullet">1 ==&gt; Normal card status change.</li> <li class="docBullet">2 ==&gt; card status change once any card is renewed.The incoming `status_nwk` is overridden by the `status_nwk` passed during renewal.</li> </ul> <p><br />If not provided then default action = 1.<br />If renewed card not found and we send action = 2 , then it will act as normal card status change</p>
notestring

Short note of card status change

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