Skip to main content

Retrieve bulk cards

GET 
/customers/:customerId/prepaid/cards/bulk/:bulkId

The Retrieve bulk cards endpoint can be used to retrieve the list of cards created by the Bulk Card Ordering request. Given the nature of the API, the response from calling the endpoint will contain information about the created cards and the status indicating the status of the bulk operation.

Request​

Path Parameters

    customerId stringrequired

    Unique identifier of the customer.

    bulkId stringrequired

    The bulkId identifier received from the webhook or from the Bulk Card Ordering response.

Query Parameters

    limit integer

    Possible values: >= 1 and <= 50

    Default value: 10

    This is the requested number of records to return. Max = 50. Default = 10.

    offset integer

    Default value: 0

    This is the requested starting position of the response entries, where 0 is the first record. Default = 0.

Responses​

OK

Schema

    id stringrequired

    The ID of the given Bulk Card Ordering request.

    quantity integerrequired

    The number of successfully created cards.

    status stringrequired

    Possible values: [COMPLETED, PROCESSING, FAILED, PENDING]

    COMPLETED - Bulk card creation completed successfully. PROCESSING - Bulk card creation is currently in progress. FAILED - Bulk card creation has failed. PENDING - Bulk card creation is waiting to be completed.

    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

    The first line of the address.

    address2 string

    Possible values: <= 30 characters

    The second line of the address.

    address3 string

    Possible values: <= 30 characters

    The third line of the address.

    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 [

    • cardId uuidrequired

    Card id is a unique identifier for a specific card. It will be used for most operations to the prepaid card.

    externalId string

    Possible values: non-empty and <= 40 characters

    External card identifier in merchant system.

    customerId stringrequired

    If the status is ASSIGNED the customerId will represent the real id of the customer or if the status is NOT_ASSIGNED customerId will contain the merchant id (provided in the request).

    status string

    Possible values: [ASSIGNED, NOT_ASSIGNED]

    ASSIGNED - Bulk card is assigned to a customer. NOT_ASSIGNED - Bulk card is not assigned to a customer.

    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.

    expiry

    object

    Card expiry date.

    month integerrequired

    The month of the card expiry date.

    year integerrequired

    The year of the card expiry date.

    cardType stringrequired

    Possible values: [PHYSICAL, VIRTUAL]

    Supported card types. Currently we support only VIRTUAL and PHYSICAL

    programName stringrequired

    Card program name.

    lastFour string

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

    Card last four digits.

    currency stringrequired

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

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

    scheme stringrequired

    Possible values: [VISA, MC]

    isPinSet booleanrequired

    Indicates that the card PIN has been set or not.

  • ]

    • meta

    object

    Contains paging information regarding the returned records, when response is paginated.

    The input for paginated query contains two parameters:

    • limit - This is the requested number of records to return. Defaults to 10 and maximum is 50.
    • offset - This is the requested starting position of the response, where 0 is the first record. Default = 0.

    Note! The total number of records is not returned, to prevent queries spanning on all records. If numberOfRecords<limit, this means no further pages are available. On request of offset beyond the last record, the returned numberOfRecords is 0.

    The number of previous pages can be calculated by dividing offset to limit.

    numberOfRecords integer

    This is the number of records returned in the lookup. Always numberOfRecords is smaller than or equal to limit.

    limit integer

    This is the requested number of records to be returned per page.

    offset integer

    This is the requested starting position of the response, where 0 is the first record.

    page integer

    This is the page of records on which the lookup starts. The starting page is 1.

Loading...