Skip to main content

BulkDetails

Contains information about the bulk card creation.

idstringrequired

The ID of the given Bulk Card Ordering request.

quantityintegerrequired

The number of successfully created cards.

statusstringrequired

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.

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

deliveryAddress object

The DeliveryAddress object will be used for the PHYSICAL card delivery. It must be null in case of 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
cards object[]
  • Array [
    • cardIduuidrequired

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

    externalIdstring

    External card identifier in merchant system.

    Possible values: non-empty and <= 40 characters

    Example: B-1111111
    customerIdstringrequired

    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).

    Example: 1231122232
    statusstring

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

    Possible values: [ASSIGNED, NOT_ASSIGNED]

    embossedNamestring

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

    Possible values: non-empty and <= 27 characters

    Example: John Doe
    expiry object

    Card expiry date.

    monthintegerrequired

    The month of the card expiry date.

    Example: 3
    yearintegerrequired

    The year of the card expiry date.

    Example: 2028
    cardTypestringrequired

    Supported card types. Currently we support only VIRTUAL and PHYSICAL

    Possible values: [PHYSICAL, VIRTUAL]

    programNamestringrequired

    Card program name.

    lastFourstring

    Card last four digits.

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

    Example: 3234
    currencystringrequired

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

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

    Example: EUR
    schemestringrequired

    Possible values: [VISA, MC]

    isPinSetbooleanrequired

    Indicates that the card PIN has been set or not.

    Default value: false
  • ]
    • 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.

    numberOfRecordsinteger

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

    Example: 1
    limitinteger

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

    Example: 10
    offsetinteger

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

    Example: 0
    pageinteger

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

    Example: 1
    BulkDetails
    {
      "id": "string",
      "quantity": 0,
      "status": "COMPLETED",
      "deliveryAddress": {
        "address1": "Tsarigradsko Shose 73",
        "address2": "floor 3",
        "address3": "apartment 43",
        "city": "Sofia",
        "countryCode": "BG",
        "state": "UT",
        "postalCode": "1000"
      },
      "cards": [
        {
          "cardId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "externalId": "B-1111111",
          "customerId": "1231122232",
          "status": "ASSIGNED",
          "embossedName": "John Doe",
          "expiry": {
            "month": 3,
            "year": 2028
          },
          "cardType": "PHYSICAL",
          "programName": "string",
          "lastFour": "3234",
          "currency": "EUR",
          "scheme": "VISA",
          "isPinSet": false
        }
      ],
      "meta": {
        "numberOfRecords": 1,
        "limit": 10,
        "offset": 0,
        "page": 1
      }
    }