Purchase Message

Sample event messages

purchase.card.issued

[{
  "id": "26d5e251-531f-404c-8bd3-23c2fa970123",
  "subject": "60909ac4-e729-44ef-880b-99e1245e0123",
  "data": {
    "idCard": 1733751,
    "cardGuid": "d94e3e11-9b6b-4114-a263-c562462e3123",
    "nameLine1": "Kunal",
    "nameLine2": "Patel",
    "expirationDate": "0121",
    "lastFour": "1234",
    "actualExpirationDate": "2021-01-09T23:59:59Z",
    "orderNumber": "48505123",
    "incomingTransactionCode": "2E1E1226123123125046256123",
    "usageLimit": 3,
    "amountLimit": 500
  },
  "eventType": "purchase.card.issued",
  "eventTime": "2021-05-06T19:41:46.7083384Z",
  "dataVersion": "1"
}]

purchase.card.terminated

[{
  "id": "4512db13-3f49-44ed-8a83-ecb7af30af47",
  "subject": "60909ac4-e729-44ef-880b-99e1245e0123",
  "data": {
    "idCard": 1733721,
    "cardGuid": "5cbe289c-31b8-425a-94c4-71eee99a5123",
    "nameLine1": "Kunal",
    "nameLine2": "Patel",
    "expirationDate": "0121",
    "lastFour": "1234",
    "actualExpirationDate": "2021-05-06T04:00:00Z",
    "orderNumber": "48505123",
    "incomingTransactionCode": "007138A637559121934844123"
  },
  "eventType": "purchase.card.terminated",
  "eventTime": "2021-05-06T19:36:39.0152303Z",
  "dataVersion": "1"
}]

Data field descriptions

Field

Type

Description

idCard

integer

Unique identifier of the VCC

cardGuid

string

Unique token that represents the issued VCC brand and type

nameLine1

string

VCC first name

nameLine2

string

VCC last name

expirationDate

string

VCC expiration date

lastFour

string

Last four digits of VCC

orderNumber

string

Unique token that identifies an entire order which can comprise of multiple sales and purchases

incomingTransactionCode

string

Unique token that links sale to purchase

usageLimit

string

Maximum number of transactions that are allowed on the issued VCC

amountLimit

string

Maximum funds of the issued VCC

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

Field

Type

Description

paymentId

integer

Unique identifier of the ACH purchase transaction

paymentGuid

string

Unique token that represents the issued ACH purchase

isCredit

Boolean

Is the transaction a debit or a credit

description

string

purchase description you provide

lastFour

string

Last four numbers of the bank account number to be credited

scheduleDate

string (date/time)

Date the payment is scheduled to process

receiptDate

string (date/time)

Date/time transaction was received by the processor

processingDate

string (date/time)

Date/time the transaction was processed

activationDate

string (date/time)

Date payment is activated

orderNumber

string

Transaction ID within client environment associated with the order.

incomingTransactionCode

string

Application 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.

amount

int64

ACH Purchase Amount


Did this page help you?