Skip to content

Latest commit

 

History

History
69 lines (59 loc) · 1.95 KB

retrieve-transaction-response.md

File metadata and controls

69 lines (59 loc) · 1.95 KB

Retrieve Transaction Response

Defines the fields that are included in the response body of a request to the RetrieveTransaction endpoint.

One of errors or transaction is present in a given response (never both).

Structure

Retrieve Transaction Response

Fields

Name Type Tags Description
errors List of Error Optional Any errors that occurred during the request.
transaction Transaction Optional Represents a transaction processed with Square, either with the
Connect API or with Square Point of Sale.

The tenders field of this object lists all methods of payment used to pay in
the transaction.

Example (as JSON)

{
  "transaction": {
    "created_at": "2016-03-10T22:57:56Z",
    "id": "KnL67ZIwXCPtzOrqj0HrkxMF",
    "location_id": "18YC4JDH91E1H",
    "product": "EXTERNAL_API",
    "reference_id": "some optional reference id",
    "tenders": [
      {
        "additional_recipients": [
          {
            "amount_money": {
              "amount": 20,
              "currency": "USD"
            },
            "description": "Application fees",
            "location_id": "057P5VYJ4A5X1"
          }
        ],
        "amount_money": {
          "amount": 5000,
          "currency": "USD"
        },
        "card_details": {
          "card": {
            "card_brand": "VISA",
            "last_4": "1111"
          },
          "entry_method": "KEYED",
          "status": "CAPTURED"
        },
        "created_at": "2016-03-10T22:57:56Z",
        "id": "MtZRYYdDrYNQbOvV7nbuBvMF",
        "location_id": "18YC4JDH91E1H",
        "note": "some optional note",
        "processing_fee_money": {
          "amount": 138,
          "currency": "USD"
        },
        "transaction_id": "KnL67ZIwXCPtzOrqj0HrkxMF",
        "type": "CARD"
      }
    ]
  }
}