Skip to main content

CardRequest

Information required for prepaid card creation. deliveryAddress is necessary only for physical card requests.

termsAndConditionsAccepted and eDisclosureAccepted - when the fields are being sent with true, this means that the customer has accepted the Terms and Conditioins and E-disclosure. They are required part of the request when the customer is from US. They are not required for customers from another countries.

    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

    The card PIN. For EU customers, the Card pin should be 4 digits. For US customers, they 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

    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

    termsAndConditionsAccepted boolean

    The field must be present for US customers.

    eDisclosureAccepted boolean

    The field must be present for US customers.