Create a new virtual card

Create a new virtual card beta

Creates a virtual card for a given account. This card can either be for a person or a budget on an account.

Once created, you can convert this virtual card to a physical one.

SecurityCommonAuth

Request

query Parameters

accountId

required

string (accountId)

The ID of the account to work with.

Example: accountId=C5462

Request Body schema: application/json

One of:

cardOwnerType required	string The type of card owner. Value: "BUDGET"
budgetCardPhoneNumber	string The telephone number of the shared card (including area code), prepended by the `+` symbol and the 1- to 3-digit country calling code. Do not include hyphens, spaces, or parentheses.
budgetCardPhoneNumberPersonId	string <uuid> <= 36 characters The ID of the person that should receive shared card notifications.
budgetId required	string <uuid> (budgetId) <= 36 characters The ID of the budget to work with.
name required	string The name of the card. Any diacritics will be converted to the nearest English letter equivalent. Note that any name that is longer than 21 characters will be truncated.

Responses

201

Created

400

Bad request

401

Unauthorised

403

Forbidden

404

Not found

405

Method not allowed

415

Unsupported media type

429

Too many requests

500

Internal server error

post/cards

Request samples

Payload
curl
JavaScript
Node.js

application/json

{"cardOwnerType": "BUDGET",
"budgetCardPhoneNumber": "+447911001762",
"budgetCardPhoneNumberPersonId": "775596ae-2624-40af-a9dc-9756110a4a08",
"budgetId": "775596ae-2624-40af-a9dc-9756110a4a03",
"name": "Team Party"
}

Response samples

application/json

{"id": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
"personId": "f3e5ff26-28ff-4cd6-9b1b-e303a185a13a",
"accountId": "C5462",
"careOfLine": "string",
"cardProductName": "string",
"lastFour": "0056",
"expiration": "0111",
"expirationTime": "2025-01-31T23:59:59Z",
"pinIsSet": true,
"state": "ACTIVE",
"stateReason": "New card",
"fulfillmentStatus": "ISSUED",
"cardType": "PHYSICAL_MSR",
"recipientAddress": {"firstName": "Jane",
"middleName": "Roger",
"lastName": "Doe",
"address1": "123 Henry St",
"address2": "Suite 101",
"city": "Porterville",
"state": "CA",
"postalCode": "93257",
"country": "US",
"phone": "8315555555"
},
"cardOwnerType": "PEOPLE",
"name": "Team Party Card",
"budgetCardPhoneNumber": "+447911001762",
"meta": [{"id": "string",
"cardId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
"CardId": "e9293471-5eb3-4dbc-916c-dbaf9e2deefd",
"metaKey": "expirationTime",
"metaValue": "New card",
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z"
}
],
"budgets": [{"id": "775596ae-2624-40af-a9dc-9756110a4a03",
"name": "Engineering"
}
],
"budget": {"id": "775596ae-2624-40af-a9dc-9756110a4a03",
"name": "Engineering"
},
"spendingLimit": {"id": "775596ae-2624-40af-a9dc-9756110a4a03",
"amount": 100.5,
"currencyCode": "GBP",
"active": false,
"limitTurnedOff": true,
"limitWindow": "DAY",
"available": {"uses": 0,
"amount": 100.5,
"daysRemaining": 1
}
},
"transactionLimit": {"id": "775596ae-2624-40af-a9dc-9756110a4a03",
"amount": 100.5,
"currencyCode": "GBP",
"active": false,
"limitTurnedOff": true,
"limitWindow": "TRANSACTION"
},
"budgetCardPhoneNumberPersonId": "775596ae-2624-40af-a9dc-9756110a4a08",
"previousCards": [null
],
"currencies": [{"numericCode": "840",
"code": "USD"
}
],
"physicalCardState": "ACTIVE",
"physicalCardId": "884496ae-2624-40af-a9dc-9756110a4a18",
"forceChangePin": false,
"createdAt": "2021-01-30T08:30:00Z",
"updatedAt": "2021-01-30T08:30:00Z",
"cardGroupId": "ef3dcbc9-9ad4-44c0-8d75-217d31da37b8",
"cardProductId": "06776ac8-abe1-475b-92ee-72405c7b0e60",
"cardProductToken": "2f224848-4191-4180-a090-3926042e4b39",
"userTokenId": "187f5207-de0b-4f4e-9b90-d50d6a251c6b",
"cardPersonalization": {"text": {"nameLine_1": {"value": "string"
},
"nameLine_2": {"value": "string"
}
}
}
}