Card.balance_adjusted

This event is dispatched when a card balance changes, for example during initial top-up/creation, redemption or reversal.

We include the latest balance adjustment change in this payload.

Example payload

{
  "id": 567,
  "object": "event",
  "api_version": "3.2",
  "webhook_version": "1.0",
  "created_at": "2021-04-11T16:01:22.000000Z",
  "type": "card.balance_adjusted",
  "data": {
    "object": {
      "object": "card",
      "id": 355,
      "balance": 1000,
      "card_reference": "6301190045888067809",
      "pin": 134702,
      "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/6301190045888067809",
      "account_id": 1,
      "purchaser_contact": {
        "object": "contact",
        "id": 703,
        "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": null,
      "currency": {
        "object": "currency",
        "id": 1,
        "name": "Sterling",
        "denomination": 100,
        "iso_currency_code": "GBP"
      },
      "latest_balance_adjustment": {
        "object": "balance_adjustment",
        "id": 623,
        "created_at": "2021-04-11T16:01:22.000000Z",
        "value": 1000,
        "line_item": {
          "object": "line_item",
          "id": 623,
          "personalised_message": null,
          "value": 1000,
          "line_item_type": {
            "object": "line_item_type",
            "id": 1,
            "name": "Sale"
          },
          "transaction": {
            "object": "transaction",
            "id": 617,
            "value": 0,
            "transaction_discount_value": 0,
            "account_id": 1,
            "currency": {
              "object": "currency",
              "id": 1,
              "name": "Sterling",
              "denomination": 100,
              "iso_currency_code": "GBP"
            },
            "unit": null
          }
        }
      },
      "card_alias": {
        "object": "card_alias",
        "card_alias": "18347923487",
        "card_alias_pin": "1234",
      }
    }
  }
}

Last updated