GET - All Cards

Retrieves all cards associated with your account.

Get All cards

End point

https://api.up.money/cards

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

Payload Details

{
    "type": "consumer" // required
}

Sample Request

curl --location --request GET 'https://api.up2.money/cards' \
--header 'x-secret: YWJjMTIzIQ==' \
--header 'Authorization-key: YOUR_AUTHORIZATION_KEY' \
--header 'Content-Type: application/json' \
--data '{
    "type": "consumer" 
}'

Sample Responses

{
  "cards": [
    {
      "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": "string",
      "externalData": [
        {
          "name": "string",
          "value": "string"
        }
      ]
    }
  ],
  "count": 0,
  "responseCount": 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"

400 Bad Request Error - Your request is invalid.

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

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