Create a Card

post

https://sandbox.globalprocessing.com/sandbox/api/v1/cards

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

👍
Documentation
For more information on how to create a card, see Creating a Card.

Getting your Product ID

One of the mandatory fields when creating a card is the CardProduct. This field contains a customer specific value which must be included in the body of the Create Card API. If you do not know your Product ID, you can use the Get Products endpoint to retrieve this information.

A successful response for the Get Products endpoint will display a list of product IDs you can use. The ProductID value, shown below, is the value needed for the CardProduct field in the Create Card endpoint.

👍
Activate your Card
A card is created in an inactive state and must be made active before you can perform transactions. See the Update Card Status endpoint to update the status of a card.

Body Params

Request object from body GPS.API.Core.Models.Request.V1.Cards.CreateCardRequest

Request class for the Create Card REST endpoint

cardType

string

enum

required

The form factor of the card.

Allowed:

cardProduct

int32

required

The unique ID of the card product linked to the card.

designId

string | null

^[\w]+[\w-\s]*$

The name of the card visual design.

customerReference

string | null

An external customer reference provided in the request.

parentCard

string | null

^[0-9]+$

Where the card is a secondary card, the public token of the primary card.

cardHolder

object

required

Cardholder details.

address

object

required

Address details.

fulfilment

object

Address details.

nameOnCard

string | null

Name embossed on card.

expiryDate

date-time | null

Optional Expiry Date. It will be embossed on the card. Format YYYY-MM.

freetext1

string | null

Fulfilment additional text field

freetext2

string | null

Fulfilment additional text field

virtualCardImageDetails

object

Image details required for a virtual card.

manufacturingDetails

object

Manufacturing details optional for physical card

Note: Field cannot be a null value in the API Explorer

activateNow

boolean

If true, activates the card during card creation. Defaults to false.

isSingleUse

boolean | null

Flag to check whether the card is for single use or not

isNonReloadable

boolean | null

Flag to check whether the card is a reloadable one or not

Headers

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

Create a Card

Documentation

Getting your Product ID

Activate your Card

What’s Next

What’s Next

Documentation

Getting your Product ID

Activate your Card

200Success

400Bad Request

401Unauthorized

404Not Found

422Client Error

What’s Next

What’s Next