Skip to main content

Bulk Card Ordering

POST 
/customers/:customerId/prepaid/cards/bulk

The Bulk Card Ordering endpoint enables you to create in bulk a number of cards (VIRTUAL or PHYSICAL) in a single request. Given the nature of the API, the response from calling the endpoint will contain information about the id regarding the card bulk issuance request.

Request​

Path Parameters

    customerId stringrequired

    Unique identifier of the customer.

Body

    quantity integerrequired

    Possible values: >= 1 and <= 50

    Default value: 1

    The number of cards to be created.

    programName stringrequired

    Program name provided by Paysafe.

    currency stringrequired

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

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

    mobile string

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

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

    userAgent stringrequired

    Possible values: <= 200 characters

    The User Agent used for the request. The field should follow the official specification - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/User-Agent#syntax

    deliveryAddress

    object

    The DeliveryAddress object will be used for the PHYSICAL card delivery. It must be null in case of VIRTUAL card

    address1 stringrequired

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

    address2 string

    Possible values: <= 30 characters

    address3 string

    Possible values: <= 30 characters

    city stringrequired

    Possible values: <= 30 characters

    Max 30 characters: letters, spaces, hyphen and period

    countryCode stringrequired

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

    Country code in ISO-3166 Alpha 2

    state string

    Possible values: <= 3 characters

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

    postalCode stringrequired

    Possible values: non-empty and <= 16 characters

    For EU customers: maximum length 16

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

    minimum 4, maximum 10

    cards

    object[]

  • Array [

    • externalId string

    Possible values: non-empty and <= 40 characters

    External card identifier in merchant system.

    embossedName string

    Possible values: non-empty and <= 27 characters

    The name that appears on the card. If not provided, firstName lastName from the customer will be used. Only ASCII characters are allowed.

  • ]

Responses​

Accepted

Schema

    id uuidrequired

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

    customerId stringrequired

    Provided customerId in the request.

    quantity integerrequired

    Possible values: >= 1 and <= 50

    Default value: 1

    The number of cards to be created.

    programName stringrequired

    Program name provided by Paysafe.

    currency stringrequired

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

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

    mobile string

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

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

    deliveryAddress

    object

    The DeliveryAddress object will be used for the PHYSICAL card delivery. It must be null in case of VIRTUAL card

    address1 stringrequired

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

    address2 string

    Possible values: <= 30 characters

    address3 string

    Possible values: <= 30 characters

    city stringrequired

    Possible values: <= 30 characters

    Max 30 characters: letters, spaces, hyphen and period

    countryCode stringrequired

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

    Country code in ISO-3166 Alpha 2

    state string

    Possible values: <= 3 characters

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

    postalCode stringrequired

    Possible values: non-empty and <= 16 characters

    For EU customers: maximum length 16

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

    minimum 4, maximum 10

Loading...