Sale Message

Data field descriptions

The table below describes the various event specific data field elements that will be present in sale event messages.

Field	Type	Description
amount	decimal	Amount of transaction
guid	string	Unique token that represents the sale
idSale	integer	Unique identifier of the Sale
orderNumber	string	Client provided transaction identifier
processorResponseCode	string	Processing response code used to classify transactions
processorMessage	string	Processing message used to describe the state of a transaction
requestIp	string	Requesting party IP address used for risk evaluation
incomingTransactionCode	string	ConnexPay generated code used to reference this transaction in order to issue purchases via the Purchase API
card.lastFour	string	Last four digits of the used (if applicable)
card.cardHolderName	string	Entered cardholder name (if applicable)

Sample Card Event messages

sale.card.auth.approved

[{
  "id": "406534e4-3ffd-4c4c-a8b0-2b226a07dd7b",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idSale": 55086,
    "amount": 20,
    "orderNumber": "06242021-85534-CREDIT",
    "guid": "7ea62139-4ab4-4972-9561-943225bf12ac",
    "processorResponseCode": "A0000",
    "processorMessage": "Success",
    "requestIp": "127.0.0.1",
    "incomingTransactionCode": "F804F93637601793395101085",
    "card": {
      "lastFour": "1234",
      "cardHolderName": "ConnexPay LLC"
    }
  },
  "eventType": "sale.card.auth.approved",
  "eventTime": "2021-06-25T00:55:45.008018Z",
  "dataVersion": "1"
}]

sale.card.auth.declined

[{
  "id": "b600cda7-98ea-42c7-aeb7-104ad7e2b6fa",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idSale": 55090,
    "amount": 1.15,
    "orderNumber": "06242021-104847-TEST",
    "guid": "a582856d-258a-425f-9c84-48e22577e994",
    "processorResponseCode": "D2020",
    "processorMessage": "CVV2 verification failed",
    "requestIp": "127.0.0.1",
    "sequenceNumber": "KPPRODTEST-06242021-104847",
    "card": {
      "lastFour": "0057",
      "cardHolderName": "ConnexPay LLC"
    }
  },
  "eventType": "sale.card.auth.declined",
  "eventTime": "2021-06-25T02:49:06.2874906Z",
  "dataVersion": "1"
}]

sale.card.auth.voided

[{
  "id": "35b0d6cd-2a43-459b-bda9-0831e70cf001",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "guid": "1a401155-ffd4-45bf-b652-d3da005ac59a",
    "amount": 1.15,
    "sale": {
      "amount": 1.15,
      "orderNumber": "06242021-120616-TEST",
      "timeStamp": "2021-06-24T16:06:28.87Z",
      "guid": "18a32ff9-c3a4-445e-a81a-b7e6feaa7c9d"
    }
  },
  "eventType": "sale.card.auth.voided",
  "eventTime": "2021-06-25T01:12:54.8636196Z",
  "dataVersion": "1"
}]

Sample Cash Event messages

sale.cash.approved

[{
  "id": "0349bf3d-51cd-445d-972e-b65219df2ff9",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idSale": 55087,
    "amount": 20,
    "orderNumber": "06242021-85826-CASH",
    "guid": "a4231c70-0cdc-49ea-8505-a00d9ecf2996",
    "processorResponseCode": "CASH000",
    "processorMessage": "Success",
    "requestIp": "127.0.0.1",
    "incomingTransactionCode": "9FB5E8A637601794983875491",
    "card": {
      "lastFour": "0000",
      "cardHolderName": "ConnexPay LLC"
    }
  },
  "eventType": "sale.cash.approved",
  "eventTime": "2021-06-25T00:58:31.1727296Z",
  "dataVersion": "1"
}]

sale.cash.declined

[{
  "id": "2bf7b9c6-89d2-492d-8277-2159d68b460a",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idSale": 55098,
    "amount": 999999.99,
    "orderNumber": "06242021-112526-CASH",
    "guid": "97e2cd01-f20e-4899-a3e6-a2be95ec69f4",
    "processorMessage": "Insufficient Available Cash Balance for the Merchant",
    "requestIp": "127.0.0.1"
  },
  "eventType": "sale.cash.declined",
  "eventTime": "2021-06-25T03:25:42.4052985Z",
  "dataVersion": "1"
}]

Sample ACH Event messages

sale.ach.pending

[{
  "id": "0abb0e44-5d1c-4871-8ff4-a03d94e1bc47",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idSale": 55100,
    "amount": 3.22,
    "orderNumber": "12345",
    "guid": "e9edc346-f27e-4980-b0e0-ea6bd0bf17ee",
    "processorResponseCode": "A0000",
    "processorMessage": "NotYetProcessed",
    "requestIp": "127.0.0.1",
    "incomingTransactionCode": "BC8E563637601887113687590"
  },
  "eventType": "sale.ach.pending",
  "eventTime": "2021-06-25T03:32:08.9817094Z",
  "dataVersion": "1"
}]

sale.ach.processed

[{
  "id": "abde4f8d-2c65-4de1-ad2e-2e7c3e53afda",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "idSale": 54943,
    "amount": 20.1,
    "orderNumber": "ACH-20210623M85716",
    "guid": "7b57e9ad-62e9-43aa-afc0-1e4b3ef3be9f",
    "processorResponseCode": "A0000",
    "processorMessage": "Processed",
    "requestIp": "127.0.0.1",
    "incomingTransactionCode": "50F27C1637600390391795116"
  },
  "eventType": "sale.ach.processed",
  "eventTime": "2021-06-25T01:46:39.2970047Z",
  "dataVersion": "1"
}]