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

Activate card

post

Request body parameters:

CardsId

Possible validation errors:

Required
Invalid
Card_Active
Card_Provider_Error (500)

Authorizations

Header parameters

otpstringRequired

One time pass for the request

Body

cardsIdinteger · int32 | nullableOptional

Responses

200

application/json

400

Bad Request

application/json

post

POST /api/v1/customer/cards/activate HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
otp: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 13

{
  "cardsId": 1
}

{
  "status": "text",
  "errors": [
    {
      "errorType": "text",
      "fieldName": "text",
      "messageCode": "text"
    }
  ],
  "id": 1,
  "details": {
    "customersId": 1,
    "customerReference": "text",
    "card": {
      "id": 1,
      "cardNumber": "text",
      "currency": "text",
      "totalBalance": 1,
      "availableBalance": 1,
      "pendingBalance": 1,
      "bSuppressed": true
    },
    "notificationDetails": {
      "siteUsersDetails": [
        {
          "siteUsersId": 1,
          "customerAssetAccounts": [
            {
              "customerAssetAccountsId": 1,
              "assetClass": 0,
              "treatAsAccount": true,
              "assetAccountType": 0,
              "elementType": 0,
              "customerAssetAccountsTransactionsId": 1,
              "amount": 1,
              "bPending": true,
              "bReserved": true,
              "bFrozen": true,
              "bVoid": true,
              "guid": "text",
              "topUpCardsId": 1,
              "moneyFlowDirection": 0,
              "bNewTransaction": true,
              "bAmountUpdated": true,
              "bPendingUpdated": true,
              "bPriceUpdated": true,
              "bFrozenUpdated": true,
              "bFeeUpdated": true,
              "bNewAssetAccount": true,
              "bDeposit": true,
              "bNewlyVoided": true,
              "bAccessElementsUpdated": true,
              "bBuyExchangeCompleted": true,
              "bSellExchangeCompleted": true,
              "assetCode": "text",
              "accountName": "text",
              "bExchangeCompleted": true,
              "exchangePrice": 1,
              "exchangeAmount": 1,
              "exchangeAssetCode": "text",
              "exchangePairedAssetCode": "text",
              "exchangeAssetClass": 0,
              "exchangePairedAssetClass": 0
            }
          ],
          "notifications": [
            "text"
          ],
          "firstName": "text",
          "emailAddress": "text",
          "phoneNumber": "text",
          "cultureInfo": "text",
          "domain": "text"
        }
      ]
    },
    "setNotificationDetails": {
      "siteUsersDetails": [
        {
          "siteUsersId": 1,
          "customerAssetAccounts": [
            {
              "customerAssetAccountsId": 1,
              "assetClass": 0,
              "treatAsAccount": true,
              "assetAccountType": 0,
              "elementType": 0,
              "customerAssetAccountsTransactionsId": 1,
              "amount": 1,
              "bPending": true,
              "bReserved": true,
              "bFrozen": true,
              "bVoid": true,
              "guid": "text",
              "topUpCardsId": 1,
              "moneyFlowDirection": 0,
              "bNewTransaction": true,
              "bAmountUpdated": true,
              "bPendingUpdated": true,
              "bPriceUpdated": true,
              "bFrozenUpdated": true,
              "bFeeUpdated": true,
              "bNewAssetAccount": true,
              "bDeposit": true,
              "bNewlyVoided": true,
              "bAccessElementsUpdated": true,
              "bBuyExchangeCompleted": true,
              "bSellExchangeCompleted": true,
              "assetCode": "text",
              "accountName": "text",
              "bExchangeCompleted": true,
              "exchangePrice": 1,
              "exchangeAmount": 1,
              "exchangeAssetCode": "text",
              "exchangePairedAssetCode": "text",
              "exchangeAssetClass": 0,
              "exchangePairedAssetClass": 0
            }
          ],
          "notifications": [
            "text"
          ],
          "firstName": "text",
          "emailAddress": "text",
          "phoneNumber": "text",
          "cultureInfo": "text",
          "domain": "text"
        }
      ]
    }
  }
}

Example JSON Request

{
  "cardsId": 1001
}

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

Deactivate card

post

Request body parameters:

CardsId

Possible validation errors:

Required
Invalid
Card_Inactive
Card_Provider_Error (500)

Authorizations

Header parameters

otpstringRequired

One time pass for the request

Body

cardsIdinteger · int32 | nullableOptional

Responses

200

application/json

400

Bad Request

application/json

post

POST /api/v1/customer/cards/deactivate HTTP/1.1
Host: 
Authorization: YOUR_API_KEY
otp: text
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 13

{
  "cardsId": 1
}

{
  "status": "text",
  "errors": [
    {
      "errorType": "text",
      "fieldName": "text",
      "messageCode": "text"
    }
  ],
  "id": 1,
  "details": {
    "customersId": 1,
    "customerReference": "text",
    "card": {
      "id": 1,
      "cardNumber": "text",
      "currency": "text",
      "totalBalance": 1,
      "availableBalance": 1,
      "pendingBalance": 1,
      "bSuppressed": true
    },
    "notificationDetails": {
      "siteUsersDetails": [
        {
          "siteUsersId": 1,
          "customerAssetAccounts": [
            {
              "customerAssetAccountsId": 1,
              "assetClass": 0,
              "treatAsAccount": true,
              "assetAccountType": 0,
              "elementType": 0,
              "customerAssetAccountsTransactionsId": 1,
              "amount": 1,
              "bPending": true,
              "bReserved": true,
              "bFrozen": true,
              "bVoid": true,
              "guid": "text",
              "topUpCardsId": 1,
              "moneyFlowDirection": 0,
              "bNewTransaction": true,
              "bAmountUpdated": true,
              "bPendingUpdated": true,
              "bPriceUpdated": true,
              "bFrozenUpdated": true,
              "bFeeUpdated": true,
              "bNewAssetAccount": true,
              "bDeposit": true,
              "bNewlyVoided": true,
              "bAccessElementsUpdated": true,
              "bBuyExchangeCompleted": true,
              "bSellExchangeCompleted": true,
              "assetCode": "text",
              "accountName": "text",
              "bExchangeCompleted": true,
              "exchangePrice": 1,
              "exchangeAmount": 1,
              "exchangeAssetCode": "text",
              "exchangePairedAssetCode": "text",
              "exchangeAssetClass": 0,
              "exchangePairedAssetClass": 0
            }
          ],
          "notifications": [
            "text"
          ],
          "firstName": "text",
          "emailAddress": "text",
          "phoneNumber": "text",
          "cultureInfo": "text",
          "domain": "text"
        }
      ]
    },
    "setNotificationDetails": {
      "siteUsersDetails": [
        {
          "siteUsersId": 1,
          "customerAssetAccounts": [
            {
              "customerAssetAccountsId": 1,
              "assetClass": 0,
              "treatAsAccount": true,
              "assetAccountType": 0,
              "elementType": 0,
              "customerAssetAccountsTransactionsId": 1,
              "amount": 1,
              "bPending": true,
              "bReserved": true,
              "bFrozen": true,
              "bVoid": true,
              "guid": "text",
              "topUpCardsId": 1,
              "moneyFlowDirection": 0,
              "bNewTransaction": true,
              "bAmountUpdated": true,
              "bPendingUpdated": true,
              "bPriceUpdated": true,
              "bFrozenUpdated": true,
              "bFeeUpdated": true,
              "bNewAssetAccount": true,
              "bDeposit": true,
              "bNewlyVoided": true,
              "bAccessElementsUpdated": true,
              "bBuyExchangeCompleted": true,
              "bSellExchangeCompleted": true,
              "assetCode": "text",
              "accountName": "text",
              "bExchangeCompleted": true,
              "exchangePrice": 1,
              "exchangeAmount": 1,
              "exchangeAssetCode": "text",
              "exchangePairedAssetCode": "text",
              "exchangeAssetClass": 0,
              "exchangePairedAssetClass": 0
            }
          ],
          "notifications": [
            "text"
          ],
          "firstName": "text",
          "emailAddress": "text",
          "phoneNumber": "text",
          "cultureInfo": "text",
          "domain": "text"
        }
      ]
    }
  }
}

Example JSON Request

{
  "cardsId": 1001
}

PreviousCreate Card NextChange Card PIN

Last updated 1 day ago