Activation / Deactivation

Activate Card

Activate a card to enable it for transactions. This endpoint can be called at any time but for physical cards is intended to be called after receipt of the physical card. A card can subsequently be deactivated, but must be active to participate in transactions.

• Endpoint: /api/v1/customer/cards/activate

• Method: POST

Request Body Example

{
    "cardsId": 1877,
    "pin": "1234"
}

Success Response Example

{
    "id": 1877,
    "details": {
        "customersId": 14257,
        "customerReference": "112233",
        "card": {
            "id": 1877,
            "cardNumber": "XXXX XXXX XXXX 3632",
            "currency": "USD",
            "totalBalance": 0.00,
            "availableBalance": 0.00,
            "pendingBalance": 0.00,
            "bSuppressed": false,
            "bDeactivated": false
        }
    },
    "status": "1",
    "errors": []
}

---

Deactivate Card

Deactivate a card that was previously activated. A deactivated card can no longer participate in transactions. Deactivating a card will void pending transactions against it. The card may subsequently be activated.

• Endpoint: /api/v1/customer/cards/deactivate

• Method: POST

Request Body Example

{
  "cardsId": 1877
}

Success Response Example

{
    "id": 1877,
    "details": {
        "customersId": 14257,
        "customerReference": "112233",
        "card": {
            "id": 1877,
            "cardNumber": "XXXX XXXX XXXX 3632",
            "currency": "USD",
            "totalBalance": 9.00,
            "availableBalance": 9.00,
            "pendingBalance": 0.00,
            "bSuppressed": false,
            "bDeactivated": true
        }
    },
    "status": "1",
    "errors": []
}