Skip to main content

Create a prepaid card

POST 
/profile/prepaid/cards

Create a new Physical or Virtual prepaid card for a customer, based on the provided programName.

Request​

Body

    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 "+11234567899".

    cardPin string

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

    For EU Customers: The Card pin should be 4 digits. US customers must set their card PIN via a separate REST HTTP call.

    externalId string

    Possible values: non-empty and <= 40 characters

    External card identifier in merchant system.

    userAgent stringrequired

    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

    termsAndConditionsAccepted boolean

    The field must be present for US customers.

    eDisclosureAccepted boolean

    The field must be present for US customers.

Responses​

Created

Schema

    cardId uuidrequired

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

    status CardStatus (string)required

    Possible values: [ACTIVE, PENDING, CANCELLED, SUSPENDED, APPLIED, DIGITAL, REJECTED, LOCKED, EXPIRED, ISSUED]

    Contain information about the different card statuses.

    • ACTIVE - Card can be used for payments.
    • PENDING - Intermediate status before issuing a card, while performing additional validations.
    • CANCELLED - The card is canceled and can't be used for any kind of operation. The status is (IRREVERSIBLE).
    • SUSPENDED - The status is changed from CS (Customer Service) representative or due to customer actions like (wrong activation info).
    • APPLIED - Intermediate status for a card that is stuck due to technical reasons.
    • DIGITAL - PHYSICAL card that is active and can be used for online payments only, but it is not yet delivered to the client, and it is not activated.
    • REJECTED - Card is rejected due to technical / validation reasons.
    • LOCKED - Card is locked by the customer and can't be used for payments.
    • EXPIRED - Card is expired.
    • ISSUED - The status indicates that the customer has successfully applied for a PHYSICAL card, but the card is not yet activated and can't be used for payments.

    expiry

    object

    Card expiry date.

    month integerrequired
    year integerrequired
    bin string

    Card bin.

    lastFour string

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

    Card last four digits.

    customerId stringrequired

    Wallet customer ID.

    cardType CardType (string)required

    Possible values: [PHYSICAL, VIRTUAL]

    Supported card types. Currently we support only VIRTUAL and PHYSICAL

    programName stringrequired

    Card program name.

    currency stringrequired

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

    Card currency code.

    mobile string

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

    Mobile phone number used during card creation.

    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

    createdDate date-timerequired

    Card created date in ISO 8601 format. Example: 2022-10-04T11:14:47.596Z

    accountId stringrequired

    accountId is used for Multi-Currency Accounts.

    scheme CardScheme (string)required

    Possible values: [VISA, MC]

    Card scheme information.

    • VISA - VISA
    • MC - Mastercard The scheme is derived from the card PAN.
    activationDate date-time

    When PHYSICAL card has been activated. ISO 8601 format.

    isPinSet booleanrequired

    Indicates that the card PIN has been set or not.

    externalId string

    External identifier in merchant system.

    tokenizations

    object

    Contains a list of Mobile Wallet Tokenizations

    mobileWalletTokenizations

    object[]

    Contains information about card enrolments for specific Mobile Wallet

  • Array [

    • dpanRef stringrequired

    dpan (Device Pan) reference.

    walletId string

    Wallet Id used only with Google Pay.

    walletType MobileWalletType (string)required

    Possible values: [GOOGLE_PAY, APPLE_PAY, SAMSUNG_PAY]

    Contains supported wallet types.

    status MobileWalletStatus (string)required

    Possible values: [COMPLETED, INITIATED]

    Mobile wallet status type.

  • ]

Loading...