Settlement Message

Sample event messages

purchase.card.auth.declined

[{
  "id": "0ec83dab-0a7a-4b23-91d7-9035302b4e3c",
  "subject": "1818a55e-8541-4bfe-a288-bad870afbe1d",
  "data": {
    "amount": 1.01,
    "cardGuid": "9dc184e9-e1c4-4193-a9e0-c9746e8d2ecd",
    "currencyCode": "USD",
    "network": "MASTERCARD",
    "cardAcceptorName": "JUDSON CENTRAL EIGHT",
    "cardAcceptorMid": "000000000596175",
    "cardAcceptorMcc": "4457",
    "cardAcceptorCity": "770-6342359",
    "cardAcceptorState": "GA",
    "cardAcceptorZip": "30022",
    "authCode": "1832",
    "authMessage": "Auth restriction found for given mid or mcc",
    "availableBalance": 1.01,
    "precedingRelatedToken": "e28ef76e-6793-4920-a8a2-4cbfc6a208c4"
  },
  "eventType": "purchase.card.auth.declined",
  "eventTime": "2021-05-17T15:03:12.022653Z",
  "dataVersion": "1"
}]

purchase.card.auth.approved

[{
  "id": "94726ac7-0d29-4061-9a52-f5dc8996b096",
  "subject": "60909ac4-e729-44ef-880b-99e1245e0122",
  "data": {
    "amount": 132.4,
    "cardGuid": "dd455c47-1ef1-47ac-b8ff-80d91edee895",
    "idCard": 1733467,
    "currencyCode": "USD",
    "network": "VISA",
    "cardAcceptorName": "SPIRIT AIR VISA",
    "cardAcceptorMid": "8031779914",
    "cardAcceptorMcc": "3260",
    "cardAcceptorCity": "8007727117",
    "cardAcceptorState": "12",
    "cardAcceptorZip": "330256542",
    "availableBalance":2.4
  },
  "eventType": "purchase.card.auth.approved",
  "eventTime": "2021-05-06T18:41:10.0085564Z",
  "dataVersion": "1"
}]

purchase.card.auth.reversal.cleared

[{
  "id": "9fa3b514-c6fc-4497-a9b4-53b51f29332f",
  "subject": "60909ac4-e729-44ef-880b-99e1245e0122",
  "data": {
    "amount": 85.57,
    "cardGuid": "c82fb3db-4145-41a9-8fd3-07215e2d3fa4",
    "idCard": 1731857,
    "currencyCode": "USD",
    "network": "VISA",
    "cardAcceptorName": "SPIRIT AIR VISA",
    "cardAcceptorMid": "8031779914",
    "cardAcceptorMcc": "3260",
    "cardAcceptorCity": "8007727117",
    "cardAcceptorState": "12",
    "cardAcceptorZip": "330256542",
    "availableBalance": 85.57,
    "precedingRelatedToken": "e28ef76e-6793-4920-a8a2-4cbfc6a208c4"
  },
  "eventType": "purchase.card.auth.reversal.cleared",
  "eventTime": "2021-05-06T19:20:39.1590974Z",
  "dataVersion": "1"
}]

Data field descriptions

Field

Type

Description

amount

decimal

Amount of transaction

cardGuid

string

Unique token that represents the issued VCC brand and type

idCard

integer

Unique identifier of the VCC

currencyCode

string

Type of currency

network

string

Visa or Mastercard

cardAcceptorName

string

Card acceptor merchant name

cardAcceptorMid

string

Unique identifier for acceptor merchant

cardAcceptorMcc

string

Merchant category code (MCC)

cardAcceptorCity

string

Card acceptor merchant city

cardAcceptorState

string

Card acceptor merchant state

cardAcceptorZip

string

Card acceptor merchant zip

authCode

string

Authorization code

authMessage

string

Reason the auth was declined in the purchase.card.auth.declined event

availableBalance

decimal

Amount remaining on the card after the specific auth event

precedingRelatedToken

string

ID to associate original authorization events to subsequent authorization clearing and authorization reversal events.*

*When a card is initially authorized, we will return an ID for that event:

"id": "9fa3b514-c6fc-4497-a9b4-53b51f29332f"

That ID will be returned in future auth events to allow you to tie the original authorization to any future activity.


Did this page help you?