Purchase Message

Sample event messages

purchase.card.issued

[{
  "id": "0d35289b-4fb4-49a1-806f-adb98462ce6a",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idCard": 31868,
    "cardGuid": "8e9de236-b255-4e47-8c47-cedf5a99dbb1",
    "type": "Virtual",
    "cardStatus": "Card - Active",
    "nameLine1": "Ping",
    "nameLine2": "VCC",
    "expirationDate": "1222",
    "terminateDate": "2022-08-25T23:59:59Z",
    "lastFour": "5600",
    "actualExpirationDate": "2022-02-30T23:59:59Z",
    "orderNumber": "Dan-20220225M94217",
    "customerId": "Joe Doe",
    "incomingTransactionCode": "907F7A1637814005390830075",
    "usageLimit": 1,
    "amountLimit": 10.0,
    "availableBalance": 10.0,
    "limitWindow": "LIFETIME",
    "activated": true
  },
  "eventType": "purchase.card.issued",
  "eventTime": "2022-03-03T23:05:18.0494148Z",
  "dataVersion": "1"
}]
{
  "id": "3067f2f0-e9cb-4d74-93c0-4c4010fd2941",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idCard": 31867,
    "cardGuid": "a7158c60-571f-4105-b140-d469ae97d7c2",
    "type": "Lodged",
    "cardStatus": "Card - Active",
    "nameLine1": "Ping",
    "nameLine2": "Lodged",
    "expirationDate": "0325",
    "lastFour": "6431",
    "actualExpirationDate": "2025-03-03T23:59:59Z",
    "incomingTransactionCode": "013C494637819446346278269",
    "usageLimit": 2,
    "amountLimit": 10.0,
    "availableBalance": 10.0,
    "limitWindow": "LIFETIME",
    "midWhitelist": [
      "123"
    ],
    "midBlacklist": [
      "555"
    ],
    "activated": true
  },
  "eventType": "purchase.card.issued",
  "eventTime": "2022-03-03T23:02:16.5705587Z",
  "dataVersion": "1"
}
{
  "id": "2bc66694-cb64-4354-be59-5ee1994dcd64",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idCard": 31866,
    "cardGuid": "be333a6e-5129-4147-9a36-f21ef0791440",
    "type": "Physical",
    "cardStatus": "Card - Unactivated",
    "nameLine1": "Ping",
    "nameLine2": "VCCPhysical",
    "expirationDate": "1222",
    "lastFour": "2641",
    "actualExpirationDate": "2022-12-30T23:59:59Z",
    "incomingTransactionCode": "F9F45A1637819446346278268",
    "usageLimit": 1,
    "amountLimit": 5.0,
    "availableBalance": 5.0,
    "limitWindow": "LIFETIME",
    "activated": false
  },
  "eventType": "purchase.card.issued",
  "eventTime": "2022-03-03T22:58:04.9731589Z",
  "dataVersion": "1"
}

purchase.card.terminated

[
    {
        "id": "577bfb69-dda2-4cbd-9360-441e6dad560f",
        "subject": "520ab518-8830-49c4-a764-4b16c4f8ac23",
        "data": {
            "idCard": 280888,
            "cardGuid": "c31b94f0-628c-4858-afa6-500fbde01689",
            "type": "Virtual",
            "cardStatus": "Card - Deactivated",
            "nameLine1": "Mike",
            "nameLine2": "Timmons",
            "expirationDate": "0922",
            "terminateDate": "2022-08-25T23:59:59Z",
            "lastFour": "1834",
            "actualExpirationDate": "2022-08-07T04:00:00Z",
            "orderNumber": "123456789",
            "customerId": "Mike Timmons",
            "incomingTransactionCode": "0A0789F637955493434227205",
            "usageLimit": 100,
            "amountLimit": 100,
            "merchantIdentifier": "520ab518-8830-49c4-a764-4b16c4f8ac23",
            "merchantName": "cusdyn",
            "availableBalance": 70,
            "limitWindow": "LIFETIME",
            "activated": false
        },
        "eventType": "purchase.card.terminated",
        "eventTime": "2022-08-08T16:49:57.7766526Z",
        "dataVersion": "1"
    }
]
{
  "id": "7e156257-6b11-4702-82da-0d7d7b4a69d1",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idCard": 31867,
    "cardGuid": "a7158c60-571f-4105-b140-d469ae97d7c2",
    "type": "Lodged",
    "cardStatus": "Card - Deactivated",
    "nameLine1": "Ping",
    "nameLine2": "Lodged",
    "expirationDate": "0325",
    "lastFour": "6431",
    "actualExpirationDate": "2022-03-02T06:00:00Z",
    "incomingTransactionCode": "013C494637819446346278269",
    "usageLimit": 2,
    "amountLimit": 30.0,
    "availableBalance": 30.0,
    "limitWindow": "WEEK",
    "activated": false
  },
  "eventType": "purchase.card.terminated",
  "eventTime": "2022-03-03T23:04:43.1227852Z",
  "dataVersion": "1"
}
{
  "id": "f6649fd8-ef1d-4ac7-8ffd-8668c30539d3",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idCard": 31866,
    "cardGuid": "be333a6e-5129-4147-9a36-f21ef0791440",
    "type": "Physical",
    "cardStatus": "Card - Deactivated",
    "nameLine1": "Ping",
    "nameLine2": "VCCPhysical",
    "expirationDate": "1222",
    "lastFour": "2641",
    "actualExpirationDate": "2022-03-02T06:00:00Z",
    "incomingTransactionCode": "F9F45A1637819446346278268",
    "usageLimit": 1,
    "amountLimit": 20.0,
    "availableBalance": 20.0,
    "limitWindow": "LIFETIME",
    "activated": false
  },
  "eventType": "purchase.card.terminated",
  "eventTime": "2022-03-03T23:00:53.5451851Z",
  "dataVersion": "1"
}

purchase.card.adjusted

[{
  "id": "10b77ec5-8d54-4cfb-abc9-637e55bfa128",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idCard": 31868,
    "cardGuid": "8e9de236-b255-4e47-8c47-cedf5a99dbb1",
    "type": "Virtual",
    "cardStatus": "Card - Active",
    "nameLine1": "Ping",
    "nameLine2": "VCC",
    "expirationDate": "1222",
    "terminateDate": "2022-08-25T23:59:59Z",
    "lastFour": "5600",
    "actualExpirationDate": "2022-12-30T23:59:59Z",
    "orderNumber": "Dan-20220225M94217",
    "customerId": "Mike Timmons",
    "incomingTransactionCode": "907F7A1637814005390830075",
    "usageLimit": 1,
    "amountLimit": 12.0,
    "purchaseType": "01",
    "availableBalance": 12.0,
    "limitWindow": "LIFETIME",
    "activated": true
  },
  "eventType": "purchase.card.adjusted",
  "eventTime": "2022-03-03T23:05:56.8012976Z",
  "dataVersion": "1"
}]
{
  "id": "3c6e7e5d-2fe5-493b-88bd-05d4e3df2153",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idCard": 31867,
    "cardGuid": "a7158c60-571f-4105-b140-d469ae97d7c2",
    "type": "Lodged",
    "cardStatus": "Card - Active",
    "nameLine1": "Ping",
    "nameLine2": "Lodged",
    "expirationDate": "0325",
    "lastFour": "6431",
    "actualExpirationDate": "2025-03-03T23:59:59Z",
    "incomingTransactionCode": "013C494637819446346278269",
    "usageLimit": 2,
    "amountLimit": 30.0,
    "purchaseType": "Airline",
    "availableBalance": 30.0,
    "limitWindow": "WEEK",
    "midWhitelist": [
      "123"
    ],
    "midBlacklist": [
      "555"
    ],
    "activated": true
  },
  "eventType": "purchase.card.adjusted",
  "eventTime": "2022-03-03T23:04:01.0190942Z",
  "dataVersion": "1"
}
{
  "id": "849d32cb-f5d3-490c-bf2a-44c7a2f5c78d",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idCard": 31867,
    "cardGuid": "a7158c60-571f-4105-b140-d469ae97d7c2",
    "type": "Lodged",
    "cardStatus": "Card - Suspended",
    "nameLine1": "Ping",
    "nameLine2": "Lodged",
    "expirationDate": "0325",
    "lastFour": "6431",
    "actualExpirationDate": "2025-03-03T23:59:59Z",
    "incomingTransactionCode": "013C494637819446346278269",
    "usageLimit": 2,
    "amountLimit": 30.0,
    "purchaseType": "Airline",
    "availableBalance": 30.0,
    "limitWindow": "WEEK",
    "midWhitelist": [
      "123"
    ],
    "midBlacklist": [
      "555"
    ],
    "activated": false
  },
  "eventType": "purchase.card.adjusted",
  "eventTime": "2022-03-03T23:04:24.8815995Z",
  "dataVersion": "1"
}
{
  "id": "eaf0ccf9-8601-40bc-aa66-8d97fd603f27",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idCard": 31866,
    "cardGuid": "be333a6e-5129-4147-9a36-f21ef0791440",
    "type": "Physical",
    "cardStatus": "Card - Active",
    "nameLine1": "Ping",
    "nameLine2": "VCCPhysical",
    "expirationDate": "1222",
    "lastFour": "2641",
    "actualExpirationDate": "2022-12-30T23:59:59Z",
    "incomingTransactionCode": "F9F45A1637819446346278268",
    "usageLimit": 1,
    "amountLimit": 20.0,
    "purchaseType": "Airline",
    "availableBalance": 20.0,
    "limitWindow": "LIFETIME",
    "activated": true
  },
  "eventType": "purchase.card.adjusted",
  "eventTime": "2022-03-03T23:00:01.0601114Z",
  "dataVersion": "1"
}

Data field descriptions

FieldTypeDescription
idCardintegerUnique identifier of the card
cardGuidstringUnique token that represents the issued card brand and type
nameLine1stringFirst name placed on the card
nameLine2stringLast name placed on the card
expirationDatestringCard expiration date
lastFourstringLast four digits of the card
orderNumberstringUnique token that identifies an entire order which can comprise of multiple sales and purchases
incomingTransactionCodestringUnique token that links sale to purchase
usageLimitstringMaximum number of times the card may be authorized
amountLimitstringMaximum dollar amount the card can be authorized and settled
typestringIdentifies type of card. Options are "Virtual", "Lodged" or "Physical"
cardstatusstringIdentifies the status of the card. Options are:

"Card - Unactivated" - which identifies a Physical card that is initially shipped out and has not yet been activated (only available for Physical cards).

"Card - Active" which identifies a card that can be transacted with.

"Card - Deactivated" identifies a card that was previously active but has been deactivated.

"Card- Terminated" identifies a card that has been terminated and cannot be transacted with. It can also not be activated again.

purchase.ach.issued

[{
  "id": "04d5ba2f-b3a0-4875-b720-083e9c0a2f7d",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "paymentId": 478,
    "paymentGuid": "34ce2303-0aad-48b3-9bb5-b5bc43f7e937",
    "isCredit": false,
    "description": "ACH Test",
    "lastFour": "1222",
    "scheduleDate": "2021-07-07T00:00:00Z",
    "receiptDate": "2021-07-06T00:00:00Z",
    "processingDate": "2021-07-06T00:00:00Z",
    "activationDate": "2021-07-07T00:00:00Z",
    "orderNumber": "12345",
    "incomingTransactionCode": "B3A8E34637611774230898784",
    "amount": 3.0
  },
  "eventType": "purchase.ach.issued",
  "eventTime": "2021-07-06T18:11:08.2082372Z",
  "dataVersion": "1"
}]

ACH Data field descriptions

FieldTypeDescription
paymentIdintegerUnique identifier of the ACH purchase transaction
paymentGuidstringUnique token that represents the issued ACH purchase
isCreditBooleanIs the transaction a debit or a credit
descriptionstringpurchase description you provide
lastFourstringLast four numbers of the bank account number to be credited
scheduleDatestring (date/time)Date the payment is scheduled to process
receiptDatestring (date/time)Date/time transaction was received by the processor
processingDatestring (date/time)Date/time the transaction was processed
activationDatestring (date/time)Date payment is activated
orderNumberstringTransaction ID within client environment associated with the order.
incomingTransactionCodestringApplication level setting to associate the ACH payment request with an original sale. The value is provided in the sale response of the original sale transaction.
amountint64ACH Purchase Amount