Transactions

https://api.payload.com/transactions

Nested Objects

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

https://api.payload.com/transactions/{id}/check_back

https://api.payload.com/transactions/{id}/check_front

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

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

https://api.payload.com/transactions/{id}/operations

https://api.payload.com/transactions/{id}/payment_link

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

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

https://api.payload.com/transactions/{id}/processing_method

https://api.payload.com/transactions/{id}/processing_settings

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

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

Example

{
  "id": "txn_ZV3cFnHL1gHM1udLUv1vL1En",
  "object": "transaction",
  "amount": 804.06,
  "attrs": {},
  "avs": "no_match",
  "card_code": "numeric",
  "conv_fee": 1.32,
  "created_at": "2024-08-21 13:35:03",
  "customer_id": "acct_TM9Rwxd8vrGYnFdK9Drm0FDd",
  "description": "string",
  "descriptor": "string",
  "fee": 1.32,
  "funding_delay": 428.6,
  "funding_status": "pending",
  "funding_type": "debit",
  "ledger": [],
  "modified_at": "2024-08-21 13:35:03",
  "notes": "string",
  "order_number": "string",
  "payment_link_id": "pay_1hVDJyJEsXayvrNQxKZNWVpOE",
  "payment_method": {},
  "payment_method_id": "pm_1PAyxRtjm7MGHFZzYMWjnbW2U",
  "processed_date": "2024-08-21",
  "processing_id": "acct_F3lTF6YNMILcFPEuQpeW4Xub",
  "processing_method": {},
  "processing_method_id": "pm_13XQbMfVXNsZLND422hSWfB7y",
  "processing_settings_id": "ps_26rBKRcw1zRdaKrLp8yEc9lzU",
  "reader_id": "rdr_33bcSq7PhFl73QawLX9OaaSE",
  "ref_number": "string",
  "rejected_date": "2024-08-21",
  "risk_flag": "in_review",
  "risk_score": 578.18,
  "source": "api",
  "status": "authorized",
  "status_code": "string",
  "status_message": "string",
  "type": "payment",
  "initiator": {
    "ip": "string"
  },
  "order_details": {
    "cust_ref_number": "string",
    "incl_costs": {
      "sales_tax": 245.79
    },
    "line_items": [
      {
        "commodity_code": "string",
        "description": "string",
        "product_code": "string",
        "qty": 391.1,
        "tax_amount": 516.11,
        "tax_rate": 86.32,
        "unit_of_measure": "string",
        "unit_price": 856.19
      }
    ]
  },
  "shipping_details": {
    "dest": {
      "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"
    },
    "src": {
      "postal_code": "postal_code"
    }
  }
}

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	None
`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_delay` number readonly	Number of days to delay funding a transaction
`funding_status` string readonly: function	Values: pending captured batched refunded reversed
`funding_type` string	Values: debit credit
`ledger` list	Array of associated Transaction Ledger objects
`modified_at` datetime readonly	None
`notes` string	Additional notes
`order_number` string	None
`payment_link_id` id non-default readonly: update	ID of the associated Payment Link object
`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
`processing_method` object	Associated Payment Method object
`processing_method_id` id	ID of the associated Payment Method object
`processing_settings_id` id non-default readonly: update	ID of the associated Processing Settings object
`reader_id` id readonly: update	None
`ref_number` string readonly	Human-readable reference number for receipts and reporting
`rejected_date` date readonly: method	Date transaction was rejected
`risk_flag` string readonly	Values: in_review allowed denied
`risk_score` number readonly	Risk score between 0 and 1
`source` string readonly: update	Values: api keyed swipe emv emv_quickchip nfc googlepay applepay check
`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

initiator:
`ip` string	None

order_details:
`cust_ref_number` string	None

incl_costs:
`sales_tax` number	Amount of tax included in the transaction amount

line_items:
`commodity_code` string required	The international description code of the good or service
`description` string required	Short description of the line item
`product_code` string required	SKU
`qty` number	The quantity of the line item
`tax_amount` number	The tax value for this item
`tax_rate` number	The tax rate for this item
`unit_of_measure` string	The unit of measure of the line item
`unit_price` number required	The price per unit

shipping_details:

dest:
`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

src:
`postal_code` postal_code	Postal code of origin