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.

programNamestringrequired

Program name provided by Paysafe.

currencystringrequired

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

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

mobilestring

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

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

cardPinstring

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.

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

externalIdstring

External card identifier in merchant system.

Possible values: non-empty and <= 40 characters

Example: a2322550-af91-417f-867e-681efad44b9d
userAgentstringrequired

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

Example: Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0
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
termsAndConditionsAcceptedboolean

The field must be present for US customers.

Default value: false
eDisclosureAcceptedboolean

The field must be present for US customers.

Default value: false
CardRequest
{
  "programName": "string",
  "currency": "string",
  "mobile": "string",
  "cardPin": "string",
  "externalId": "a2322550-af91-417f-867e-681efad44b9d",
  "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X x.y; rv:42.0) Gecko/20100101 Firefox/42.0",
  "deliveryAddress": {
    "address1": "Tsarigradsko Shose 73",
    "address2": "floor 3",
    "address3": "apartment 43",
    "city": "Sofia",
    "countryCode": "BG",
    "state": "UT",
    "postalCode": "1000"
  },
  "termsAndConditionsAccepted": false,
  "eDisclosureAccepted": false
}