Transaction

Transaction is a representation of a single transaction

{
  "adjustedAmount": {
    "currency": "USD",
    "value": 234399
  },
  "applicationID": "4632f059-9c79-467d-bb09-b844d4d3a3f1",
  "billingContact": {
    "name": {
      "familyName": "Doe",
      "givenName": "John"
    }
  },
  "buyerID": "dc9e066a-141d-4dc7-872b-8882edae8b38",
  "createdAt": "2020-12-31T15:10:55Z",
  "description": "a description of the transaction",
  "discountAmount": {
    "currency": "USD",
    "value": 34399
  },
  "expiresAt": "2021-12-31T15:10:55Z",
  "externalID": "3140be70-245b-47fc-a9ac-14a347acf450",
  "locationID": "8030ae90-045b-07fc-09ac-13c348abf477",
  "fulfillmentCarrier": "USPS",
  "fulfillmentTrackingNumber": "9400100000000000000000",
  "id": "01cc0231-e9a9-4d4c-bf0b-878fbf9eca64",
  "merchantID": "7ae4ffb3-482b-4482-b794-d10c4e1bfe5d",
  "metadata": {
    "externalMerchantData": "externalInfo"
  },
  "paymentAgreementID": "6da770ce-2751-450f-ae13-afe28ecb0ec1",
  "paymentProductID": "9691676b-385e-41f0-b472-ec289d43b346",
  "merchantPaymentProductValuesID": "f9aefd19-8a42-4623-8902-9ab1ad4dee7c",
  "productType": "INSTALLMENTS",
  "programID": "0582f43e-fbcb-4568-a938-a0c0a73b19a5",
  "merchantProgramValuesID": "9691676b-385e-41f0-b472-ec289d43b346",
  "refundedAmount": {
    "currency": "USD",
    "value": 8999
  },
  "chargedbackAmount": {
    "currency": "USD",
    "value": 8999
  },
  "cancelledAmount": {
    "currency": "USD",
    "value": 8999
  },
  "settledAmount": {
    "currency": "USD",
    "value": 8999
  },
  "shippingAmount": {
    "currency": "USD",
    "value": 2500
  },
  "shippingContact": {
    "name": {
      "familyName": "Doe",
      "givenName": "John"
    }
  },
  "status": "AUTHORIZED",
  "taxAmount": {
    "currency": "USD",
    "value": 1300
  },
  "tenantID": "5851fcf1-86a2-4b7b-b1f3-ded19c551a5b",
  "totalAmount": {
    "currency": "USD",
    "value": 334399
  },
  "overflowAmount": {
    "currency": "USD",
    "value": 13000
  },
  "revision": 1,
  "updatedAt": "2021-01-31T14:10:55Z"
}

Properties

Name	Type	Required	Restrictions	Description
adjustedAmount	object	false	none	The transaction amount after adjustments.
➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
applicationID	string(uuid)	false	none	The application ID used to make the transaction
billingContact	object	false	none	The contact information of the person being billed.
➥ name	object	true	none	Represents the full name
➥➥ givenName	string	true	none	Given name
➥➥ familyName	string	true	none	Family name
➥➥ additionalName	string	false	none	Additional name, if any
➥ phone	string	false	none	Telephone number including country code
➥ address	object	false	none	Represents a fully defined address for an entity
➥➥ address1	string	true	none	First address line
➥➥ address2	string	false	none	Second address line
➥➥ locality	string	true	none	The locality (e.g. City) of the address.
➥➥ postalCode	string	true	none	The administrative postal code (e.g. Zip Code)
➥➥ region	string	true	none	The region or first-level administration division (e.g. State/Province) of the address.
➥➥ country	string	true	none	The two character ISO-3166-1 country code.
➥ email	string(email)	false	none	Email address
buyerID	string(uuid)	false	none	The ID of the buyer for the transaction.
createdAt	string(date-time)	false	none	The date and time the transaction was created.
description	string	false	none	a description for the transaction
discountAmount	object	false	none	The amount by which the transaction was discounted.
➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
expiresAt	string(date-time)	false	none	The timestamp value formatted per RFC3339. This does not allow nulls.
externalID	string	false	none	The external ID of the transaction to update.
fulfillmentCarrier	string	false	none	the shipping carrier moving the transacted item.
fulfillmentTrackingNumber	string	false	none	the number used to see the shipping progress of the transacted item.
id	string(uuid)	false	none	The ID of the transaction
locationID	string(uuid)	false	none	The location the transaction was fulfilled at.
merchantID	string(uuid)	false	none	The ID of the merchant that sells the transacted item.
metadata	object	false	none	Metadata is a JSON field available to merchants for storing external data on a Transaction Metadata keys have a max size of 128, and there can be up to 50 keys total. The max value size for a key is 5000.
➥ additionalProperties	string	false	none	none
paymentAgreementID	string(uuid)	false	none	The ID of the payment agreement.
paymentProductID	string(uuid)	false	none	The ID of the specific loan product used to make this transaction.
merchantPaymentProductValuesID	string(uuid)	false	none	The ID of the merchant payment product values that should be used with this transaction.
productType	string	false	none	The kind of the type of loan / payment product used to make this transaction.
programID	string(uuid)	false	none	The ID of the program the payment product is under.
merchantProgramValuesID	string(uuid)	false	none	The ID of the merchant program values that should be used with this transaction.
refundedAmount	object	false	none	The amount that has been refunded for this transaction.
➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
chargedbackAmount	object	false	none	The amount that has been chargedback for this transaction.
➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
cancelledAmount	object	false	none	The amount that has been cancelled for this transaction.
➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
settledAmount	object	false	none	The amount that's been settled between the buyer and merchant for this transaction.
➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
overflowAmount	object	false	none	The amount that has been paid on creation of the transaction (i.e., a downpayment).
➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
shippingAmount	object	false	none	The cost of shipping the transacted item.
➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
shippingContact	object	false	none	The contact information of the place receiving the transacted item.
➥ name	object	true	none	Represents the full name
➥➥ givenName	string	true	none	Given name
➥➥ familyName	string	true	none	Family name
➥➥ additionalName	string	false	none	Additional name, if any
➥ phone	string	false	none	Telephone number including country code
➥ address	object	false	none	Represents a fully defined address for an entity
➥➥ address1	string	true	none	First address line
➥➥ address2	string	false	none	Second address line
➥➥ locality	string	true	none	The locality (e.g. City) of the address.
➥➥ postalCode	string	true	none	The administrative postal code (e.g. Zip Code)
➥➥ region	string	true	none	The region or first-level administration division (e.g. State/Province) of the address.
➥➥ country	string	true	none	The two character ISO-3166-1 country code.
➥ email	string(email)	false	none	Email address
status	string	false	none	The possible statuses of a Transaction
taxAmount	object	false	none	Represents a monetary amount in the specified currency
➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
tenantID	string(uuid)	false	none	A universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.
isCarts	boolean	false	none	Whether the transacted item is associated with a cart id.
totalAmount	object	false	none	The amount that the transaction was created with.
➥ currency	string	true	none	The three letter currency code as defined in ISO 4217.
➥ value	integer(int64)	true	none	Monetary value as an integral number of the currency fractional unit e.g for USD: cents
revision	integer	false	none	The revision of the transaction. Incremented whenever there is a change to the transaction.
updatedAt	string(date-time)	false	none	The timestamp value formatted per RFC3339. This does not allow nulls.

Enumerated Values

Value
INSTALLMENTS
SPLITPAY
DEBT_CONSOLIDATION
PERSONAL_LOAN
AUTHORIZED
CANCELLED
EXPIRED
PARTIALLY_AUTHORIZED
PARTIALLY_REFUNDED
PARTIALLY_SETTLED
PENDING
REFUNDED
SETTLED
CHARGEDBACK
PARTIALLY_CHARGEDBACK