Skip to main content

BulkCardsResponse

Contains information provided by the Bulk Card Ordering request, as well as the id field needed for tracking the progress of card creation.

idstring<uuid>required

The ID of the given Bulk Card Ordering request. It is used for fetching the bulk created cards or for checking the request status.

Example: 497f6eca-6276-4993-bfeb-53cbbbba6f08
customerIdstringrequired

Provided customerId in the request.

Example: 1231122232
quantityintegerrequired

The number of cards to be created.

Possible values: >= 1 and <= 50

Default value: 1
Example: 2
programNamestringrequired

Program name provided by Paysafe.

Example: PHYSICAL-MC-EEA
currencystringrequired

Currency code in three-letter format ("Alpha-3").

Possible values: >= 3 characters and <= 3 characters

Example: EUR
mobilestring

If not provided, we will try to use the mobile phone provided during the customer onboarding. Mobile phone number must be in format "+359888333333".

Possible values: Value must match regular expression ^\+\d+\s?\d{1,16}$

Example: +359888333333
deliveryAddress object

The DeliveryAddress object will be used for the PHYSICAL and DIGITAL card delivery. Leave blank for VIRTUAL card.

address1stringrequired

The first line of the address.

Possible values: >= 4 characters and <= 40 characters

Example: Tsarigradsko Shose 73
address2string

The second line of the address.

Possible values: <= 30 characters

Example: floor 3
address3string

The third line of the address.

Possible values: <= 30 characters

Example: apartment 43
citystringrequired

Max 30 characters: letters, spaces, hyphen and period

Possible values: <= 30 characters

Example: Sofia
countryCodestringrequired

Country code in ISO-3166 Alpha 2

Possible values: >= 2 characters and <= 2 characters

Example: BG
statestring

The field is mandatory for US Customers: 2 to 3 characters state or province abbreviation. Example: "UT"

Possible values: <= 3 characters

Example: UT
postalCodestringrequired

For EU customers: maximum length 16

For US customers: Pattern: ^[a-zA-Z0-9-\ ]*$

minimum 4, maximum 10

Possible values: non-empty and <= 16 characters

Example: 1000
BulkCardsResponse
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"customerId": "1231122232",
"quantity": 2,
"programName": "PHYSICAL-MC-EEA",
"currency": "EUR",
"mobile": "+359888333333",
"deliveryAddress": {
"address1": "Tsarigradsko Shose 73",
"address2": "floor 3",
"address3": "apartment 43",
"city": "Sofia",
"countryCode": "BG",
"state": "UT",
"postalCode": "1000"
}
}