POST - Activate Card (Physical)

Activates the physical card identified by the cardId path parameter.

Activate card


End point

https://api.up.money/cards/activate/{cardid}

Headers

Security

REQUEST BODY SCHEMA: application/json

πŸ” API SECRET: x-secret

Add YWJjMTIzIQ== in x-secret in headers.

Header parameter name: x-secret


πŸ” HTTP: Authorization-key

The authentication token representing the user. This will be included in the login response object as token.

Header parameter name: Authorization-key


Path Parameters


cardId (required)

string ^[0-9]+$

Body Parameters


activationCode (required)

string <= 6 characters ^[0-9]+$ The code, set up when upgrading the card, that allows the physical card to be activated.


Sample Request


curl --location 'https://api.up2.money/cards/activate/{cardId}' \
--header 'x-secret: YWJjMTIzIQ==' \
--header 'Authorization-key: YOUR_AUTHORIZATION_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "activationCode":123 // your activation code
}'

Sample Response


{
  "id": "string",
  "profileId": "string",
  "externalHandle": "string",
  "tag": "string",
  "friendlyName": "string",
  "currency": "str",
  "state": {
    "state": "ACTIVE",
    "blockedReason": "USER",
    "destroyedReason": "SYSTEM"
  },
  "type": "VIRTUAL",
  "cardBrand": "MASTERCARD",
  "cardNumber": {
    "value": "string"
  },
  "cvv": {
    "value": "str"
  },
  "cardNumberFirstSix": "string",
  "cardNumberLastFour": "stri",
  "nameOnCard": "string",
  "nameOnCardLine2": "string",
  "startMmyy": "stri",
  "expiryMmyy": "stri",
  "cardLevelClassification": "CONSUMER",
  "expiryPeriodMonths": 1,
  "renewalType": "AUTO_RENEW",
  "creationTimestamp": 0,
  "cardholderMobileNumber": "string",
  "billingAddress": {
    "addressLine1": "string",
    "addressLine2": "string",
    "city": "string",
    "postCode": "string",
    "state": "string",
    "country": "st"
  },
  "physicalCardDetails": {
    "bulkDelivery": true,
    "productReference": "string",
    "carrierType": "string",
    "pendingActivation": true,
    "pinBlocked": true,
    "manufacturingState": "REQUESTED",
    "replacement": {
      "replacementReason": "DAMAGED",
      "replacementId": "string"
    },
    "deliveryAddress": {
      "name": "string",
      "surname": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "postCode": "string",
      "state": "string",
      "country": "st",
      "contactNumber": "string"
    },
    "deliveryMethod": "STANDARD_DELIVERY",
    "deliveryTrackingCode": "string",
    "deliveryTrackingMethod": "string",
    "nameOnCardLine2": "string"
  },
  "digitalWallets": {
    "pushProvisioningEnabled": true,
    "walletsEnabled": true,
    "artworkReference": "string"
  },
  "authForwardingDefaultTimeoutDecision": "APPROVE",
  "threeDSecureAuthConfig": {
    "linkedUserId": "string",
    "primaryChannel": "OTP_SMS",
    "fallbackChannel": "OTP_SMS"
  },
  "mode": "PREPAID_MODE",
  "externalData": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "balances": {
    "availableBalance": 0,
    "actualBalance": 0
  }
}

Response Status


200 Success

400 Bad Request Error - Your request is invalid.

errorCode: Enum: "REQUIRED" "HAS_TEXT" "REQUIRES" "SIZE" "RANGE" "IN" "NOT_IN" "REGEX" "EXACTLY" "AT_LEAST" "AT_MOST" "ALL_OR_NONE"

401 Unauthorized - Your credentials or access token are invalid.

403 Forbidden - Access to the requested resource or action is forbidden.

errorCode: Enum: STEP_UP_REQUIRED ACCESS_TOKEN_REQUIRED

404 Not found - The requested resource couldn't be found.

409 Conflict

errorCode: Enum: "INSTRUMENT_NOT_PHYSICAL" "INSTRUMENT_ALREADY_ACTIVATED" "ACTIVATION_CODE_INVALID" "INSTRUMENT_BLOCKED" "INSTRUMENT_DESTROYED"

429 Too many requests.

500 Internal Server Error - There is a problem with the server. Please try again later.

503 Service Unavailable - We're temporarily offline for maintenance. Please try again later.


E-nums


STEP_UP_REQUIRED

Current session is expired, Call stepup api to create new session

ACCESS_TOKEN_REQUIRED

Issue with your token (Invalid or expired)

Last updated