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}
|
|
|
|
|
|
|
|
|
|
|
|
The request completed successfully.
{
"issuedCardID": "string",
"brand": "Visa",
"lastFourCardNumber": "string",
"expiration": {
"month": "01",
"year": "21"
},
"authorizedUser": {
"firstName": "string",
"lastName": "string"
},
"memo": "string",
"fundingWalletID": "string",
"state": "active",
"formFactor": "virtual",
"controls": {
"singleUse": true,
"velocityLimits": [
{
"amount": 10000,
"interval": "per-transaction"
}
]
},
"createdOn": "2019-08-24T14:15:22Z"
}Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The request contained missing or expired authentication.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The user is not authorized to make the request.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The requested resource was not found.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
Request was refused due to rate limiting.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The request failed due to an unexpected error.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.
Response headers
x-request-id
string
required
A unique identifier used to trace requests.
Headers
X-Moov-Version
string
Specify an API version.
API versioning follows the format vYYYY.QQ.BB, where
YYYYis the yearQQis the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BBis the build number, starting at.01, for subsequent builds in the same quarter.- For example,
v2024.01.00is the initial release of the first quarter of 2024.
- For example,
The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.
When no version is specified, the API defaults to v2024.01.00.
Path parameters
accountID
string
required
The Moov business account for which the card was issued.
issuedCardID
string
required
Response
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
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<object>
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.