Transaction object

Transactions represent changes in balance within one account. The details (attributes) contained within one transaction define the Transaction object.

Attribute	Description
`action`	Payment type
`amount`	Payment amount
`code`	Payment code according to which the payment has been created
`currency`	Payment currency
`description`	Payment code description
`descriptor`	Name of the company/website that deducted money
`mode`	Payment mode
`orderId`	Unique order identifier
`status`	Payment status
`transactionId`	Unique payment identifier
`url`	Link to the ACS in the issuer domain

Source (payment method) object

Attribute	Description
`brand`	Card brand
`bic`	Bank identifier code
`method`	Payment method
`number`	Card number
`paymentAccountId`	Unique encrypted account identifier

Consumer object

Attribute	Description
`city`	Customer's city name
`country`	Customer's country name
`email`	Customer's email address
`externalId`	Unique customer identifier within the merchant's system
`firstName`	Customer's first name
`id`	Unique customer identifier within Gateway's system
`lastName`	Customer's last name
`phone`	Customer's phone number
`state`	Customer's state name
`zip`	Zip code

Subscription object

Attribute	Description
`cancelDate`	Subscription cancel date
`cycle`	Sequential number of recurring payments in a subscription
`id`	Subscription ID
`renewalDate`	Subscription renewal date
`status`	Subscription Status

Metadata object

Used for storing additional structured information associated with the payment.

Payment object example

{
  "payment": {
    "code": "0",
    "description": "APPROVED",
    "action": "charge",
    "url": "https://google.com/oijhflsfs9",
    "mode": "sale",
    "status": "success",
    "amount": 9.99,
    "currency": "USD",
    "orderId": "235324530",
    "transactionId": "12345",
    "descriptor": "centrohelp.com",
    "source": {
      "method": "card",
      "number": "402400****6348",
      "brand": "visa",
      "paymentAccountId": "d86bdcbb-c369-46d9-a9d0-9c5010e3bfdb"
    }
  },
  "consumer": {
    "id": "string",
    "externalId": "14253ms92m0as",
    "email": "[email protected]",
    "firstName": "string",
    "lastName": "string",
    "phone": "+1987353539",
    "country": "string",
    "state": "string",
    "city": "string",
    "zip": "36101"
  },
  "subscription": {
    "id": "string",
    "status": "active",
    "renewalDate": "2020-04-17 13:43:02",
    "cancelDate": "2020-11-17 13:43:02",
    "cycle": 0
  },
  "metadata": {
    "foo": "bar"
  }
}