Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Money movement
  3. Card issuing

Retrieve a spending card

Retrieve a single issued card associated with a Moov account.

To access this endpoint using an access token you'll need to specify the /accounts/{accountID}/issued-cards.read scope.

GET
/issuing/{accountID}/issued-cards/{issuedCardID}
cURL Java PHP Python TypeScript 
1
2

curl -X GET "https://api.moov.io/issuing/{accountID}/issued-cards/{issuedCardID}" \
  -H "Authorization: Bearer {token}" \

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.operations.GetIssuedCardResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        GetIssuedCardResponse res = sdk.cardIssuing().get()
                .accountID("b888f774-3e7c-4135-a18c-6b985523c4bc")
                .issuedCardID("e50f7622-81da-484b-9c66-1c8a99c6b71b")
                .call();

        if (res.issuedCard().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();



$response = $sdk->cardIssuing->getIssuedCard(
    accountID: 'c63d9bae-2097-4bfa-8ac7-e9e8dff6e9ae',
    issuedCardID: 'aa0c86df-7f7d-4200-9ee4-24ba8870a7d4',
    xMoovVersion: 'v2024.01.00'

);

if ($response->issuedCard !== null) {
    // handle response
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.card_issuing.get(account_id="b888f774-3e7c-4135-a18c-6b985523c4bc", issued_card_id="e50f7622-81da-484b-9c66-1c8a99c6b71b")

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20

import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.cardIssuing.get({
    accountID: "b888f774-3e7c-4135-a18c-6b985523c4bc",
    issuedCardID: "e50f7622-81da-484b-9c66-1c8a99c6b71b",
  });

  // Handle the result
  console.log(result);
}

run();
200 401 403 404 429 500 504
The request completed successfully.
schema
{
  "properties": {
    "authorizedUser": {
      "description": "Fields for identifying an authorized individual.",
      "properties": {
        "firstName": {
          "type": "string"
        },
        "lastName": {
          "type": "string"
        }
      },
      "required": [
        "firstName",
        "lastName"
      ],
      "type": "object"
    },
    "brand": {
      "description": "The card brand.",
      "enum": [
        "American Express",
        "Discover",
        "Mastercard",
        "Visa",
        "Unknown"
      ],
      "example": "Visa",
      "type": "string"
    },
    "controls": {
      "properties": {
        "singleUse": {
          "description": "Indicates if the card is single-use. If true, the card closes after the first authorization.",
          "type": "boolean"
        },
        "velocityLimits": {
          "description": "Sets the spending limit per time interval. Only one limit per interval is supported.",
          "items": {
            "properties": {
              "amount": {
                "description": "The maximum amount in cents that can be spent in a given interval.",
                "example": 10000,
                "format": "int64",
                "type": "integer"
              },
              "interval": {
                "description": "Specifies the time frame for the velocity limit. Currently supports only per-transaction limits.",
                "enum": [
                  "per-transaction"
                ],
                "type": "string"
              }
            },
            "required": [
              "amount",
              "interval"
            ],
            "type": "object"
          },
          "type": "array"
        }
      },
      "type": "object"
    },
    "createdOn": {
      "format": "date-time",
      "type": "string"
    },
    "expiration": {
      "description": "The expiration date of the card or token.",
      "example": {
        "month": "01",
        "year": "21"
      },
      "properties": {
        "month": {
          "maxLength": 2,
          "minLength": 2,
          "type": "string"
        },
        "year": {
          "maxLength": 2,
          "minLength": 2,
          "type": "string"
        }
      },
      "required": [
        "month",
        "year"
      ],
      "type": "object"
    },
    "formFactor": {
      "description": "Specifies the type of spend card to be issued. Presently supports virtual only, providing a digital number without a physical card.",
      "enum": [
        "virtual"
      ],
      "type": "string"
    },
    "fundingWalletID": {
      "description": "Unique identifier for the wallet funding the card.",
      "type": "string"
    },
    "issuedCardID": {
      "format": "uuid",
      "type": "string"
    },
    "lastFourCardNumber": {
      "type": "string"
    },
    "memo": {
      "description": "Optional descriptor for the card.",
      "type": "string"
    },
    "state": {
      "description": "The `state` represents the operational status of an issued card. A card can only approve incoming authorizations if it is in an active state.\n\n- `active`: The card is operational and approves authorizations. Generally becomes active shortly after card creation.\n- `inactive`: The card cannot approve authorizations. This is currently a temporary state assigned post-creation during the activation process.\n- `closed`: The card is permanently deactivated and cannot approve authorizations. A card can be closed by request or when it expires.\n- `pending-verification`: Awaiting additional authorized user verification before the card can be activated.",
      "enum": [
        "active",
        "inactive",
        "pending-verification",
        "closed"
      ],
      "type": "string"
    }
  },
  "required": [
    "issuedCardID",
    "brand",
    "lastFourCardNumber",
    "expiration",
    "authorizedUser",
    "fundingWalletID",
    "state",
    "formFactor",
    "createdOn"
  ],
  "type": "object"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The requested resource was not found.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Path parameters

accountID

string <uuid> required
The Moov business account for which the card was issued.

issuedCardID

string <uuid> required

Response

application/json

authorizedUser

object required
Fields for identifying an authorized individual.
Show child attributes

firstName

string required

lastName

string required

brand

string<enum> required
The card brand.
Possible values: American Express, Discover, Mastercard, Visa, Unknown

createdOn

string<date-time> required

expiration

object required
The expiration date of the card or token.
Show child attributes

month

string 2 characters required

year

string 2 characters required

formFactor

string<enum> required
Specifies the type of spend card to be issued. Presently supports virtual only, providing a digital number without a physical card.
Possible values: virtual

fundingWalletID

string required
Unique identifier for the wallet funding the card.

issuedCardID

string<uuid> required

lastFourCardNumber

string required

state

string<enum> required

The state represents the operational status of an issued card. A card can only approve incoming authorizations if it is in an active state.

  • active: The card is operational and approves authorizations. Generally becomes active shortly after card creation.
  • inactive: The card cannot approve authorizations. This is currently a temporary state assigned post-creation during the activation process.
  • closed: The card is permanently deactivated and cannot approve authorizations. A card can be closed by request or when it expires.
  • pending-verification: Awaiting additional authorized user verification before the card can be activated.
Possible values: active, inactive, pending-verification, closed

controls

object
Show child attributes

singleUse

boolean
Indicates if the card is single-use. If true, the card closes after the first authorization.

velocityLimits

array
Sets the spending limit per time interval. Only one limit per interval is supported.
Show child attributes

amount

integer<int64>
The maximum amount in cents that can be spent in a given interval.

interval

string<enum>
Specifies the time frame for the velocity limit. Currently supports only per-transaction limits.
Possible values: per-transaction

memo

string
Optional descriptor for the card.