Struct square_api_client::models::CreateGiftCardRequest

pub struct CreateGiftCardRequest {
    pub idempotency_key: String,
    pub location_id: String,
    pub gift_card: GiftCard,
}

This is a model struct for CreateGiftCardRequest type

Fields

idempotency_key: String

A unique identifier for this request, used to ensure idempotency. For more information, see Idempotency.

Min Length: 1, Max Length: 128

location_id: String

The ID of the [Location] where the gift card should be registered for reporting purposes. Gift cards can be redeemed at any of the seller’s locations.

Min Length: 1

gift_card: GiftCard

The gift card to create. The type field is required for this request. The gan_source and gan fields are included as follows:

To direct Square to generate a 16-digit GAN, omit gan_source and gan.

To provide a custom GAN, include gan_source and gan.

• For gan_source, specify OTHER.
• For gan, provide a custom GAN containing 8 to 20 alphanumeric characters. The GAN must be unique for the seller and cannot start with the same bank identification number (BIN) as major credit cards. Do not use GANs that are easy to guess (such as 12345678) because they greatly increase the risk of fraud. It is the responsibility of the developer to ensure the security of their custom GANs. For more information, see Custom GANs.

To register an unused, physical gift card that the seller previously ordered from Square, include gan and provide the GAN that is printed on the gift card.

Trait Implementations

impl Clone for CreateGiftCardRequest

fn clone(&self) -> CreateGiftCardRequest

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateGiftCardRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for CreateGiftCardRequest

fn default() -> CreateGiftCardRequest

Returns the “default value” for a type.

impl PartialEq<CreateGiftCardRequest> for CreateGiftCardRequest

fn eq(&self, other: &CreateGiftCardRequest) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for CreateGiftCardRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where
    __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for CreateGiftCardRequest