JSON Payment Notification

timestampinteger<int64>

The time of the card assign event. Unix timestamp in milliseconds.

Example: 1607017210793

eventTypestring

The event type that triggered the payment notification.

Example: ASSIGN_CARDS

versionstring

API version number.

Example: 1

data object

Contains the data of the transaction.

midstring

The 10-digit Merchant ID.

Possible values: Value must match regular expression ^[0-9]{10}$

Example: 1100000000

customer object

Contains the customer data.

idstring

The unique customer identifier provided by the merchant.

Example: kfoLkCq3RBIJiJF6sJWBeYA4tnfsCms2

payment_idstring

The unique ID of the payment.

Example: pay_1100000000_XdyBD9FuEJVhpX3hctwJzCB8W1rEzqTo_USD

payment_instrumentstring

The payment method used.

Possible values: [paysafecard, giftcard]

Example: giftcard

payment_instrument_subtypestring

The type of gift card used.

Possible values: [cvspharmacy, dollargeneral, openbuckscard]

Example: cvspharmacy

card_details object[]

Contains the details of the card used for the transaction with the card information.

Up to 10 iterations, which is the maximum number of cards that can be used in a single transaction.

Possible values: <= 10

Array [

serialstring

The serial number that identifies the card.

Example: 1888540789315005

currencystring

The currency code of the card in ISO 4217 3-digit format.

Possible values: >= 3 characters and <= 3 characters, Value must match regular expression ^[A-Z]{3}$

Example: USD

amountnumber<double>

The amount used from the card (with 2 decimal numbers).

Example: 10

typestring

The 5 characters code that identifies the card type.

Possible values: >= 5 characters and <= 5 characters

Example: 00086

countrystring

The country code of the card in ISO 3166-1 2-digit format.

Possible values: >= 2 characters and <= 2 characters, Value must match regular expression ^[A-Z]{2}$

Example: US

]

JSON Payment Notification

{
  "timestamp": 1607017210793,
  "eventType": "ASSIGN_CARDS",
  "version": "1",
  "data": {
    "mid": "1100000000",
    "customer": {
      "id": "kfoLkCq3RBIJiJF6sJWBeYA4tnfsCms2"
    },
    "payment_id": "pay_1100000000_XdyBD9FuEJVhpX3hctwJzCB8W1rEzqTo_USD",
    "payment_instrument": "giftcard",
    "payment_instrument_subtype": "cvspharmacy",
    "card_details": [
      {
        "serial": "1888540789315005",
        "currency": "USD",
        "amount": 10,
        "type": "00086",
        "country": "US"
      }
    ]
  }
}