Card.expiry_reminder

This event dispatched when an expiring balance reminder occurs.

Example payload

{
  "id": 590,
  "object": "event",
  "api_version": "3.2",
  "webhook_version": "1.0",
  "created_at": "2021-04-11T16:51:03.000000Z",
  "type": "card.expiry_reminder",
  "data": {
    "object": {
      "object": "card",
      "id": 331,
      "balance": 1000,
      "card_reference": "6301190045418594090",
      "pin": "198303",
      "expiry_time": "2021-03-27T23:59:59.000000Z",
      "validity_start_time": "2021-03-12T00:00:00.000000Z",
      "personal_message": null,
      "qr_code_url": "https://apimytoggleio-dev.airship.co.uk/qrcodegenerator/6301190045418594090",
      "account_id": 1,
      "purchaser_contact": {
        "object": "contact",
        "id": 655,
        "email": "john@example.co.uk",
        "first_name": "John",
        "last_name": "Smith",
        "phone_number": null,
        "marketing_opt_in_at": null
      },
      "product": {
        "object": "product",
        "id": 4,
        "name": "Gift Card",
        "short_description": "Gift Card",
        "long_description": "Gift Card",
        "image": {
          "object": "image",
          "id": 13,
          "url": "https://apimytoggleio-dev.airship.co.uk//storage/images/1_1616686008.png"
        },
        "product_type": {
          "object": "product_type",
          "id": 1,
          "name": "Gift Card"
        }
      },
      "contact": { // N.B. Could also be null if card not registered to anyone
          "object": "contact",
          "id": 704,
          "email": "john@example.co.uk",
          "first_name": null,
          "last_name": null,
          "phone_number": null,
          "marketing_opt_in_at": null
      },
      "currency": {
        "object": "currency",
        "id": 1,
        "name": "Sterling",
        "denomination": 100,
        "iso_currency_code": "GBP"
      },
      "card_alias": {
        "object": "card_alias",
        "card_alias": "18347923487",
        "card_alias_pin": "1234",
      }
    }
  }
}

On This PageExample payload

Last updated