Available Events

Event NameTriggerContentSample Payload
transactionmessage.createdWhenever a new Transaction Message is registered in the Astrada systemA complete understanding of the created Transaction Message objectSee here
transaction.createdWhenever a new Transaction is created in the Astrada systemReferences to the transaction object and its related entitiesSee here
transaction.updatedWhenever a Transaction is updated in the Astrada systemReferences to the updated transaction object and its related entitiesSee here
cardsubscription.createdWhenever a Card Subscription is created in the Astrada systemReference to the created card subscriptionSee here
cardsubscription.updatedWhenever a Card Subscription is updated in the Astrada systemReference to the updated card subscriptionSee here

Sample Payloads

Alongside the payload that is sent in HTTP request body (in JSON format), an HTTP header (webhook-event-type) is also present that allows to infer the event type.

transactionmessage.created

Payload is identical to the GET Transaction Message endpoint

transaction.created

Payload consists of links to the created transaction and its related entities.

{
  "_links": {
    "self": {
      "href": "/transactions/884820d4-1b11-4dfd-ab83-988f754712da"
    },
    "subaccount": {
      "href": "/subaccounts/c6d5e036-361e-4773-a514-b9496cf2d2b5"
    },
    "card": {
      "href": "/cards/4d1ff59f-4286-4209-9662-92e174193562"
    },
    "messages": [
      {
        "href": "/transaction-messages/f4b24a0a-6a37-4ce3-8845-ddf0b604a9b4"
      }
    ]
  },
  "cardId": "4d1ff59f-4286-4209-9662-92e174193562",
  "cardholderBillingCurrency": "GBP",
  "cardholderBillingHoldAmount": 0,
  "cardholderBillingSettledAmount": 0.81,
  "createdAt": "2024-05-01T06:41:43.810Z",
  "descriptor": "Uber",
  "id": "884820d4-1b11-4dfd-ab83-988f754712da",
  "network": "MASTERCARD",
  "status": "SETTLED",
  "subaccountId": "c6d5e036-361e-4773-a514-b9496cf2d2b5",
  "transactionCurrency": "USD",
  "transactionHoldAmount": 0,
  "transactionSettledAmount": 1,
  "transactionType": "DEBIT_01",
  "updatedAt": "2024-05-02T08:41:43.810Z"
}

Augmenting transaction.created with a projection of transaction messages data

It is possible to receive transaction message data as part of the transaction.created webhook. Upon request, an array containing all correlated messages will be included on the transaction aggregate payload inside the_embedded field. Example:

{
  "_embedded": {
    "messages": [
      {
        "_links": {
          "self": {
            "href": "/transaction-messages/f4b24a0a-6a37-4ce3-8845-ddf0b604a9b4"
          }
        },
        "approvalCode": "537254",
        "transactionReference": "IWVQ22_2024-04-24",
        "dateTime": "2024-04-24T13:39:45",
        "id": "f4b24a0a-6a37-4ce3-8845-ddf0b604a9b4",
        "messageType": "FINL_ADVC",
        "network": "MASTERCARD",
        "result": "APPROVED"
      }
    ]
  }
}

To opt in to this feature, please reach out to your Astrada Account Manager or [email protected]

transaction.updated

Payload consists of links to the updated transaction and its related entities.

{
  "_links": {
    "self": {
      "href": "/transactions/884820d4-1b11-4dfd-ab83-988f754712da"
    },
    "subaccount": {
      "href": "/subaccounts/c6d5e036-361e-4773-a514-b9496cf2d2b5"
    },
    "card": {
      "href": "/cards/4d1ff59f-4286-4209-9662-92e174193562"
    },
    "messages": [
      {
        "href": "/transaction-messages/f4b24a0a-6a37-4ce3-8845-ddf0b604a9b4"
      },
      {
        "href": "/transaction-messages/934f8701-53e3-4a2b-a000-6bb52195d2ea"
      }
    ]
  },
  "cardId": "4d1ff59f-4286-4209-9662-92e174193562",
  "cardholderBillingCurrency": "GBP",
  "cardholderBillingHoldAmount": 0,
  "cardholderBillingSettledAmount": 0.81,
  "createdAt": "2024-05-01T06:41:43.810Z",
  "descriptor": "Uber",
  "id": "884820d4-1b11-4dfd-ab83-988f754712da",
  "network": "MASTERCARD",
  "status": "SETTLED",
  "subaccountId": "c6d5e036-361e-4773-a514-b9496cf2d2b5",
  "transactionCurrency": "USD",
  "transactionHoldAmount": 0,
  "transactionSettledAmount": 1,
  "transactionType": "DEBIT_01",
  "updatedAt": "2024-05-02T08:41:43.810Z"
}

Augmenting transaction.updated with a projection of transaction messages data

It is possible to receive transaction message data as part of the transaction.updated webhook. Upon request, an array containing all correlated messages will be included on the transaction aggregate payload inside the_embedded field. Example:

{
  "_embedded": {
    "messages": [
      {
        "_links": {
          "self": {
            "href": "/transaction-messages/f4b24a0a-6a37-4ce3-8845-ddf0b604a9b4"
          }
        },
        "approvalCode": "537254",
        "transactionReference": "IWVQ22_2024-04-24",
        "dateTime": "2024-04-24T13:39:45",
        "id": "f4b24a0a-6a37-4ce3-8845-ddf0b604a9b4",
        "messageType": "FINL_ADVC",
        "network": "MASTERCARD",
        "result": "APPROVED"
      }
    ]
  }
}

To opt in to this feature, please reach out to your Astrada Account Manager or [email protected]

cardsubscription.created

Payload consists of links to the created subscription.

{
  "_links": {
    "card": {
      "href": "/cards/94b9b0ce-5775-470d-855e-0c0d0e72b0ea"
    },
    "self": {
      "href": "/card-subscriptions/aadf6c89-0356-4d94-8fa8-b5465077a0fb"
    }
  },
  "cardId": "94b9b0ce-5775-470d-855e-0c0d0e72b0ea",
  "createdAt": "2024-09-02T09:42:39.678Z",
  "customerReferenceId": null,
  "effectiveDate": "2024-09-02T09:42:39.677Z",
  "expirationDate": "2025-09-02T09:42:43.270Z",
  "id": "aadf6c89-0356-4d94-8fa8-b5465077a0fb",
  "state": "reqSCA",
  "subaccountId": "6103874b-248d-4825-af88-a0d24dd9b123",
  "updatedAt": "2024-09-02T09:42:43.576Z"
}

cardsubscription.updated

Payload consists of links to the updated subscription.

{
  "_links": {
    "card": {
      "href": "/cards/94b9b0ce-5775-470d-855e-0c0d0e72b0ea"
    },
    "self": {
      "href": "/card-subscriptions/aadf6c89-0356-4d94-8fa8-b5465077a0fb"
    }
  },
  "cardId": "94b9b0ce-5775-470d-855e-0c0d0e72b0ea",
  "createdAt": "2024-09-02T09:42:39.678Z",
  "customerReferenceId": null,
  "effectiveDate": "2024-09-02T09:42:39.677Z",
  "expirationDate": "2025-09-02T09:42:43.270Z",
  "id": "aadf6c89-0356-4d94-8fa8-b5465077a0fb",
  "state": "active",
  "subaccountId": "6103874b-248d-4825-af88-a0d24dd9b123",
  "updatedAt": "2024-09-02T10:01:44.176Z"
}