mobile_consolidate_gift_cards

Consolidate Gift Cards

​

Enables a user to transfer the entire balance of a gift card to another gift card.

Note: After the balance transfer, the system removes the source gift card from the user's timeline and changes its status to 'closed' for the owner. Additionally, access is revoked for all users with whom the gift card was shared. Currently, this is applicable only to Givex and Heartland gift card providers.

Path Parameters
  • uuid
    Type: string
    required

    Unique ID of the destination gift card to which the entire balance will be transferred

Headers
  • x-pch-digest
    Type: string
    required

    The signature for the API call

  • Content-Type
    Type: string
    required

    Set this header to application/json.

  • Accept-Language
    Type: string

    Preferred language

  • User-Agent
    Type: string
    required

    Used to identify the software, device, and application initiating the request, providing information about the client to the server. For details, see User Agent.

  • id-token
    Type: string

    A token that contains identity information about the authenticated user. It is used to verify the user’s identity and is required only when authentication is performed using Advanced Authentication. This token alone does not grant access to Punchh APIs. To access the APIs, you must include the id_token in the id-token header and the access_token in the Authorization header. See Access Punchh APIs Using Access and ID tokens

  • Authorization
    Type: string
    required

    Used to authorize the request with access_token. It should be supplied as Bearer ACCESS_TOKEN_GOES_HERE. Note: When authentication is performed using Advanced Authentication, you must include the id_token in the id-token header and the access_token in the Authorization header. See Access Punchh APIs Using Access and ID tokens

Body
application/json
  • access_token
    Type: string
    required

    Access token of the user

  • client
    Type: string
    required

    OAuth client ID provided by the business

  • source_card
    Type: string
    required

    UUID of the source gift card from which the entire balance will be transferred

Responses
  • 200
    Type: object
    • destination_card
      Type: Gift Card (Object)
    • source_card
      Type: Gift Card (Object)
  • 400
    Type: object
    • errors
      Type: object
patch/api2/mobile/gift_cards/{uuid}/consolidate
{
  "source_card": {
    "card_background_image": "string",
    "card_number": "string",
    "epin": "string",
    "usb_scannable_card_number": "string",
    "created_at": "YYYY-MM-DDThh:mm:ssZ",
    "design_id": 1,
    "preferred": true,
    "name": null,
    "last_fetched_amount": 1,
    "last_fetched_at": "YYYY-MM-DDThh:mm:ssZ",
    "status": "string",
    "updated_at": "YYYY-MM-DDThh:mm:ssZ",
    "users": {
      "address": "string",
      "avatar_remote_url": "string",
      "birthday": "YYYY-MM-DD",
      "communicable_email": "string",
      "city": "string",
      "created_at": "YYYY-MM-DDThh:mm:ssZ",
      "email": "string",
      "email_verified": true,
      "facebook_signup": true,
      "favourite_locations": "string",
      "favourite_store_numbers": "string",
      "fb_uid": "string",
      "first_name": "string",
      "gender": "string",
      "last_name": "string",
      "marketing_email_subscription": true,
      "marketing_pn_subscription": true,
      "migrate_status": true,
      "passcode_configured_for_giftcards": true,
      "phone": "string",
      "profile_field_answers": {
        "upf0": "string",
        "upf1": "string",
        "upf2": "string"
      },
      "referral_code": "string",
      "referral_path": "string",
      "secondary_email": "string",
      "state": "string",
      "superuser": true,
      "terms_and_conditions": true,
      "title": "string",
      "updated_at": "YYYY-MM-DDThh:mm:ssZ",
      "user_as_barcode": "string",
      "user_as_qrcode": "string",
      "user_code": "string",
      "user_id": 1,
      "user_relations": [
        "kid"
      ],
      "zip_code": "string",
      "anniversary": "string",
      "verification_mode": null,
      "apple_signup": true,
      "apple_uid": "string",
      "has_generated_fb_email": true,
      "sms_subscription": true,
      "apple_pass_url": "string",
      "age_verified_status": true,
      "account_created_at": "2025-12-19T16:30:02.130Z",
      "user_joined_at": "2025-12-19T16:30:02.130Z"
    },
    "uuid": "string",
    "gift_card_id": 1,
    "auto_reload_enabled": true,
    "gc_user_auto_reload_threshold_amount": 1,
    "gc_user_auto_reload_default_amount": 1,
    "gc_user_auto_reload_preferred_payment": "string"
  },
  "destination_card": {
    "card_background_image": "string",
    "card_number": "string",
    "epin": "string",
    "usb_scannable_card_number": "string",
    "created_at": "YYYY-MM-DDThh:mm:ssZ",
    "design_id": 1,
    "preferred": true,
    "name": null,
    "last_fetched_amount": 1,
    "last_fetched_at": "YYYY-MM-DDThh:mm:ssZ",
    "status": "string",
    "updated_at": "YYYY-MM-DDThh:mm:ssZ",
    "users": {
      "address": "string",
      "avatar_remote_url": "string",
      "birthday": "YYYY-MM-DD",
      "communicable_email": "string",
      "city": "string",
      "created_at": "YYYY-MM-DDThh:mm:ssZ",
      "email": "string",
      "email_verified": true,
      "facebook_signup": true,
      "favourite_locations": "string",
      "favourite_store_numbers": "string",
      "fb_uid": "string",
      "first_name": "string",
      "gender": "string",
      "last_name": "string",
      "marketing_email_subscription": true,
      "marketing_pn_subscription": true,
      "migrate_status": true,
      "passcode_configured_for_giftcards": true,
      "phone": "string",
      "profile_field_answers": {
        "upf0": "string",
        "upf1": "string",
        "upf2": "string"
      },
      "referral_code": "string",
      "referral_path": "string",
      "secondary_email": "string",
      "state": "string",
      "superuser": true,
      "terms_and_conditions": true,
      "title": "string",
      "updated_at": "YYYY-MM-DDThh:mm:ssZ",
      "user_as_barcode": "string",
      "user_as_qrcode": "string",
      "user_code": "string",
      "user_id": 1,
      "user_relations": [
        "kid"
      ],
      "zip_code": "string",
      "anniversary": "string",
      "verification_mode": null,
      "apple_signup": true,
      "apple_uid": "string",
      "has_generated_fb_email": true,
      "sms_subscription": true,
      "apple_pass_url": "string",
      "age_verified_status": true,
      "account_created_at": "2025-12-19T16:30:02.130Z",
      "user_joined_at": "2025-12-19T16:30:02.130Z"
    },
    "uuid": "string",
    "gift_card_id": 1,
    "auto_reload_enabled": true,
    "gc_user_auto_reload_threshold_amount": 1,
    "gc_user_auto_reload_default_amount": 1,
    "gc_user_auto_reload_preferred_payment": "string"
  }
}