Transactions

https://api.payload.co/transactions

Nested Objects

https://api.payload.co/transactions/{id}/allocations

https://api.payload.co/transactions/{id}/customer

https://api.payload.co/transactions/{id}/ledger

https://api.payload.co/transactions/{id}/payment_method

https://api.payload.co/transactions/{id}/processing

https://api.payload.co/transactions/{id}/reader

https://api.payload.co/transactions/{id}/receipts

Example

{
  "id": "txn_1DeOxKq5oUCME3tDCSICxo4jE",
  "object": "transaction",
  "amount": 546.57,
  "attrs": {},
  "avs": "no_match",
  "card_code": "numeric",
  "conv_fee": 1.32,
  "created_at": "2022-02-02 21:11:49",
  "customer_id": "acct_rtLMeYSZWJYfF5CgoEeQed9y",
  "description": "string",
  "descriptor": "string",
  "fee": 1.32,
  "funding_status": "pending",
  "ledger": [],
  "modified_at": "2022-02-02 21:11:49",
  "order_number": "string",
  "payment_method": {},
  "payment_method_id": "pm_1rHHFdDCa1jbRGhIXxTvBkxS2",
  "processed_date": "2022-02-02",
  "processing_id": "acct_1dc19DKUT7fOwxXusf0C4ds8R",
  "reader_id": "rdr_1SkUP3VMn9Hhc4LQokMgqb1Cx",
  "receipts": [],
  "ref_number": "string",
  "risk_flag": "in_review",
  "risk_score": 550.39,
  "source": "keyed",
  "status": "authorized",
  "status_code": "string",
  "status_message": "string",
  "type": "payment",
  "order_details": {
    "incl_costs": {
      "duty": 161.71,
      "shipping": 934.25,
      "tax": 558.08
    },
    "line_items": [
      {
        "amount": "string",
        "commodity_code": "string",
        "description": "string",
        "discount_amount": "string",
        "product_code": "string",
        "qty": 443.07,
        "unit_of_measure": "string",
        "unit_price": 49.07
      }
    ]
  },
  "shipping_details": {
    "city": "string",
    "country_code": "string",
    "postal_code": "postal_code",
    "rcpt_company": "string",
    "rcpt_first_name": "string",
    "rcpt_last_name": "string",
    "state_province": "string",
    "street_address": "string",
    "unit_number": "string"
  }
}

Attributes	Description
`id` string readonly	Object ID
`object` string readonly	Value: transaction
`amount` number required	Transaction amount
`attrs` json	Custom object attributes
`avs` string readonly	Values: no_match street_and_zip street zip unknown
`card_code` numeric non-default	CVV code on back of card
`conv_fee` number non-default readonly	Convenience fee
`created_at` datetime readonly	Timestamp object was created
`customer_id` id readonly: update	ID of associated Customer object
`description` string	Description of the transaction
`descriptor` string non-default readonly: update	The transaction descriptor displayed on the bank statement
`fee` number non-default readonly	Processing fee
`funding_status` string readonly: function	Values: pending captured batched refunded reversed
`ledger` list	Array of associated Transaction Ledger objects
`modified_at` datetime readonly	Timestamp object was last updated
`order_number` string	None
`payment_method` object	Associated Payment Method object
`payment_method_id` id readonly: update	ID of the associated Payment Method object
`processed_date` date readonly: method	Date transaction was processed
`processing_id` id readonly: update	ID of the associated Processing Account object
`reader_id` id readonly: update	None
`receipts` list	Array of associated Notification objects
`ref_number` string readonly	Human-readable reference number for receipts and reporting
`risk_flag` string readonly	Values: in_review allowed denied
`risk_score` number readonly	Risk score between 0 and 1
`source` string readonly: update	Values: keyed swipe emv emv_quickchip nfc googlepay applepay
`status` string	Values: authorized processing processed declined voided rejected
`status_code` string readonly: function	Code detailing the reason for the transaction status
`status_message` string readonly	Human-readable status description
`type` string readonly: update	Values: payment deposit reversal refund credit chargeback chargeback_reversal

order_details:

incl_costs:
`duty` number	Amount of duty (tariff) included in the transaction amount
`shipping` number	Amount of shipping included in the transaction amount
`tax` number	Amount of tax included in the transaction amount

line_items:
`amount` string	The total amount including all taxes and fees
`commodity_code` string required	The international description code of the good or service
`description` string required	Short description of the line item
`discount_amount` string	Any discount applied to this item
`product_code` string required	SKU
`qty` number	The quantity of the line item
`unit_of_measure` string	The unit of measure of the line item
`unit_price` number required	The price per unit

shipping_details:
`city` string	City of the company
`country_code` string	Country code of the shipping address
`postal_code` postal_code required	Postal code of the shipping address
`rcpt_company` string	Company name of recipient
`rcpt_first_name` string	First name of recipient
`rcpt_last_name` string	Last name of recipient
`state_province` string	State of the shipping address
`street_address` string	Street address of the shipping address
`unit_number` string	Unit number of the shipping address