Activate and Deactivate cards
PUT /api/Card
Use this call to activate and deactivate cards.
After you add the requestId
and the cardToken
to the call, in the field isActive
, add true to activate the card or false to deactivate the card.
Body parameters
Parameter | Description |
---|---|
requestId string | Unique customer generated request ID. This parameter corresponds to the requestId in the response.Required |
cardToken string | Card token that the merchant stores. Required |
isActive boolean | True if the card is active, otherwise false. Required |
sourceSenderId string | Merchant ID. Required |
Sample request PUT /api/Card
{
"requestId": "00000000-0000-00ds04-0000-000000000000",
"cardToken": "Bearer token {xxx}",
"sourceSenderId": "2345"
"isActive": true
}
Response attributes
Attribute | Description |
---|---|
requestId** GUID* | This attribute corresponds to the requestId in the request. |
cardToken string | Card token for the signed-up debit card. |
firstName string | Cardholder first name. |
lastName string | Cardholder last name. |
ownerExternalId string | 4-digit code the merchant assigns. |
address1 string | Address line 1. |
address2 string | Address line 2. |
city string | City. |
zipCode string | Zip code. |
isAuthorizationSucceeded boolean | True if card was authorized successfully, otherwise false. |
state string | 2-digit State. |
countryCode string | 2 letter country code. |
phoneNumber string | Phone number. |
email string | Email address. |
expirationYear string | 2-digit year. Must be a future date. |
expirationMonth string | 2-digit month. |
last4Digits string | Last 4-digits of the credit card number. |
cardCompany string | Card network. - Visa - Mastercard - ET - PULSE - STAR - NYCE - Accel - RPPS - MoneySend |
isActive boolean | True if the card is active, otherwise false. |
deactivatedAt string | Date and time the card was deactivated or null. |
addedOn string | Date and time the card was added. |
rail string | The processor used to perform the transaction - RS2 - McSend - TabaPay |
authorizationJson string | The JSON authorization response received for this card. |
Sample response PUT /api/Card
{
{
"requestId":"75390185-f4c4-4220-817a-2095fb3b2be5",
"cardToken":"GXA2L4WIQOCIQMGFFLWMQRC02SZI7WO06JQKU6",
"firstName":"Corey",
"lastName":"Hendly",
"ownerExternalId":7624,
"address1":"912 Joshua Estates",
"address2":null,
"city":"Patrick Springs",
"isAuthorizationSucceeded":true,
"state":"VA",
"zipcode": "24133",
"countryCode":"US",
"phoneNumber":"5553455679",
"email":"[email protected]",
"expirationYear":"28",
"expirationMonth":"05",
"last4Digits":"1111",
"cardCompany":"Visa",
"isActive":false,
"deactivatedAt":null,
"addedOn":"2019-09-01T13:18:10.913",
"rail":"RS2",
"authorizationJson":"{\r\n \"PushCardID\": \"b2eee733-80c4-4507-acd5-
c2826c8e4135\",\r\n \"Authorized\": false,\r\n \"ResponseReceived\": true,\r\n
\"ResponseCode\": \"15\",\r\n \"ResponseDescription\": null,\r\n \"Error\": null,\r\n
\"AddressVerified\": false,\r\n \"Rail\": \"rS2\",\r\n \"CardType\":
\"unknown\"\r\n}"
},
}
Updated 19 days ago