Get Individual Card Order

get https://api.dev.givecard.dev/api/v1/business/cardOrders/{cardOrderId}

Gets an individual card order and the cards that are a part of the order.

Responses

Response body

object

cardOrder

object

cardCount

int64

The count of cards that were requested for the order.

cardOrderCardType

string

physical virtual

cardsProcessed

int64

The count of cards that were sent to the manufacturer for shipping (physical cards) or that were virtually delivered (virtual cards). This number should match CardCount.

createdAt

date-time

The time that the card order was made in UTC.

deliveredAt

date-time

The time that the card order was delivered at in UTC.

uuid

The card order's primary identifier.

metadata

array of objects

metadata

object

key

string

value

string

orderStatus

string

created processing shipped cancelled delivered fulfilled failed

shipmentMethod

string

USPS_GROUND USPS_PRIORITY UPS_NEXT_DAY UPS_SECOND_DAY

shippedAt

date-time

The time that the card order was shipped at in UTC.

shippingAddress

object

trackingNumber

string

The tracking number is added to the card order upon shipment.

updatedAt

date-time

The time of the most recent update made to the card order in UTC.

cards

array of objects

cards

object

bin

string

The card's Bank Identification Number.

businessID

uuid

UUID in v4 format

createdAt

date-time

The time that the card was ordered in UTC.

expirationDate

string

The card's expiration date in the format MMYY.

externalId

string

The external ID is a card's unique identifier that begins with the first 4 characters of the business name and is printed on the back of physical cards.

uuid

last4

string

The last 4 digits of the 16-digit card number used to make purchases.

lastLoadedAt

date-time

The time that the card was last loaded in UTC.

merchantRuleId

uuid

Deprecated: please use Spend Rules instead.

metadata

array of objects

metadata

object

key

string

value

string

personalization

object

shippingAddress

object

spendRules

array of objects

Spend Rules are the spend rules applied to a card. Spend rules limit where and how a cardholder spends their funds.

spendRules

object

applyTo

string

business program cards

businessId

uuid

createdAt

date-time

description

string

uuid

metadata

array of objects

metadata

object

key

string

value

string

name

string

restrictions

array of objects

restrictions

object

createdAt

date-time

uuid

override

string

greenlight redlight

spendRuleId

uuid

type

string

merchant_category merchant_name merchant_id velocity

updatedAt

date-time

value

string

velocityCycle

string

all_time monthly weekly daily single_transaction

velocityType

string

currency_amount

velocityValue

string

a decimal representing dollars, for example: 11.23

type

string

velocity merchant_allow merchant_block

updatedAt

date-time

velocityCycle

string

all_time monthly weekly daily single_transaction

velocityType

string

currency_amount

velocityValue

string

a decimal representing dollars, for example: 11.23

status

string

active locked processing closed frozen reassociated

tags

object

colorHex

string

createdAt

date-time

uuid

name

string

updatedAt

date-time

value

string

trackingNumber

string

The tracking number is added to a physical card upon shipment.

type

string

physical virtual both

updatedAt

date-time

The time of the most recent update made to the card in UTC.

virtualCardActivationStatus

string

processing email_sent phone_sms_sent activation_link_created activated

virtualCardEmail

string

The email the virtual card was sent to.

virtualCardPhoneNumber

string

Language

Credentials

Header


xxxxxxxxxx
1
curl --request GET \
2
     --url https://api.dev.givecard.dev/api/v1/business/cardOrders/cardOrderId \
3
     --header 'accept: */*'

Click Try It! to start a request and see the response here! Or choose an example:

*/*

200

400

404

500