Interface 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 when the customer is from US. They are not required for customers from other countries.
interface CardRequest {
    cardPin?: string;
    currency: string;
    deliveryAddress?: DeliveryAddress;
    eDisclosureAccepted?: boolean;
    externalId?: string;
    mobile?: string;
    programName: string;
    termsAndConditionsAccepted?: boolean;
}

Properties

cardPin? currency deliveryAddress? eDisclosureAccepted? externalId? mobile? programName termsAndConditionsAccepted?

Properties

Optional cardPin

cardPin?: string

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.

currency

currency: string

Currency alphabetic code as specified by ISO 4217.

Example

"EUR"

Optional deliveryAddress

deliveryAddress?: DeliveryAddress

Delivery address for the card request.

Optional eDisclosureAccepted

eDisclosureAccepted?: boolean

The field must be present for US customers.

Optional externalId

externalId?: string

External card identifier in merchant system.

Optional mobile

mobile?: string

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

programName

programName: string

Program name provided by Paysafe.

Optional termsAndConditionsAccepted

termsAndConditionsAccepted?: boolean

The field must be present for US customers.

Settings

Member Visibility

Theme

On This Page

cardPincurrencydeliveryAddresseDisclosureAcceptedexternalIdmobileprogramNametermsAndConditionsAccepted