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

NameTypeRequiredRestrictionsDescription
adjustedAmountobjectfalsenoneThe transaction amount after adjustments.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
applicationIDstring(uuid)falsenoneThe application ID used to make the transaction
billingContactobjectfalsenoneThe contact information of the person being billed.
➥ nameobjecttruenoneRepresents the full name
➥➥ givenNamestringtruenoneGiven name
➥➥ familyNamestringtruenoneFamily name
➥➥ additionalNamestringfalsenoneAdditional name, if any
➥ phonestringfalsenoneTelephone number including country code
➥ addressobjectfalsenoneRepresents a fully defined address for an entity
➥➥ address1stringtruenoneFirst address line
➥➥ address2stringfalsenoneSecond address line
➥➥ localitystringtruenoneThe locality (e.g. City) of the address.
➥➥ postalCodestringtruenoneThe administrative postal code (e.g. Zip Code)
➥➥ regionstringtruenoneThe region or first-level administration division (e.g. State/Province) of the address.
➥➥ countrystringtruenoneThe two character ISO-3166-1 country code.
➥ emailstring(email)falsenoneEmail address
buyerIDstring(uuid)falsenoneThe ID of the buyer for the transaction.
createdAtstring(date-time)falsenoneThe date and time the transaction was created.
descriptionstringfalsenonea description for the transaction
discountAmountobjectfalsenoneThe amount by which the transaction was discounted.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
expiresAtstring(date-time)falsenoneThe timestamp value formatted per RFC3339. This does not allow nulls.
externalIDstringfalsenoneThe external ID of the transaction to update.
fulfillmentCarrierstringfalsenonethe shipping carrier moving the transacted item.
fulfillmentTrackingNumberstringfalsenonethe number used to see the shipping progress of the transacted item.
idstring(uuid)falsenoneThe ID of the transaction
locationIDstring(uuid)falsenoneThe location the transaction was fulfilled at.
merchantIDstring(uuid)falsenoneThe ID of the merchant that sells the transacted item.
metadataobjectfalsenoneMetadata 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.
additionalPropertiesstringfalsenonenone
paymentAgreementIDstring(uuid)falsenoneThe ID of the payment agreement.
paymentProductIDstring(uuid)falsenoneThe ID of the specific loan product used to make this transaction.
merchantPaymentProductValuesIDstring(uuid)falsenoneThe ID of the merchant payment product values that should be used with this transaction.
productTypestringfalsenoneThe kind of the type of loan / payment product used to make this transaction.
programIDstring(uuid)falsenoneThe ID of the program the payment product is under.
merchantProgramValuesIDstring(uuid)falsenoneThe ID of the merchant program values that should be used with this transaction.
refundedAmountobjectfalsenoneThe amount that has been refunded for this transaction.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
chargedbackAmountobjectfalsenoneThe amount that has been chargedback for this transaction.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
cancelledAmountobjectfalsenoneThe amount that has been cancelled for this transaction.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
settledAmountobjectfalsenoneThe amount that's been settled between the buyer and merchant for this transaction.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
overflowAmountobjectfalsenoneThe amount that has been paid on creation of the transaction (i.e., a downpayment).
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
shippingAmountobjectfalsenoneThe cost of shipping the transacted item.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
shippingContactobjectfalsenoneThe contact information of the place receiving the transacted item.
➥ nameobjecttruenoneRepresents the full name
➥➥ givenNamestringtruenoneGiven name
➥➥ familyNamestringtruenoneFamily name
➥➥ additionalNamestringfalsenoneAdditional name, if any
➥ phonestringfalsenoneTelephone number including country code
➥ addressobjectfalsenoneRepresents a fully defined address for an entity
➥➥ address1stringtruenoneFirst address line
➥➥ address2stringfalsenoneSecond address line
➥➥ localitystringtruenoneThe locality (e.g. City) of the address.
➥➥ postalCodestringtruenoneThe administrative postal code (e.g. Zip Code)
➥➥ regionstringtruenoneThe region or first-level administration division (e.g. State/Province) of the address.
➥➥ countrystringtruenoneThe two character ISO-3166-1 country code.
➥ emailstring(email)falsenoneEmail address
statusstringfalsenoneThe possible statuses of a Transaction
taxAmountobjectfalsenoneRepresents a monetary amount in the specified currency
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
tenantIDstring(uuid)falsenoneA universally unique identifier (Version 4) as defined in RFC4122. This does not allow nulls.
isCartsbooleanfalsenoneWhether the transacted item is associated with a cart id.
totalAmountobjectfalsenoneThe amount that the transaction was created with.
➥ currencystringtruenoneThe three letter currency code as defined in ISO 4217.
➥ valueinteger(int64)truenoneMonetary value as an integral number of the currency fractional unit e.g for USD: cents
revisionintegerfalsenoneThe revision of the transaction. Incremented whenever there is a change to the transaction.
updatedAtstring(date-time)falsenoneThe 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