Sign in
Receipts

Fetch a Receipt

Retrieve the details of an existing Receipt.

get/receipts/{receipt_id}

Headers

Finix-Versionstring
Example:2022-02-01

Specify the API version of your request. For more details, see Versioning.

Response

A single Receipt

idstring

The ID of the resource.

created_atstring date-time

Timestamp of when the object was created.

updated_atstring date-time

Timestamp of when the object was last updated.

amountinteger

The total amount that will be debited in cents (e.g. 100 cents to debit $1.00).

application_idstring

ID of the Application the resource was created under.

currency'CAD' | 'USD'

ISO 4217 3-letter currency code.

send_receipt_to_buyerboolean

Whether to send a receipt to the buyer.

device_idstring nullable

Applies to in-person payments. The ID of the Point-of-Sale terminal used to process the payment.

type'BUYER' | 'MERCHANT'

The type of receipt, either for the customer (BUYER) or the merchant (MERCHANT) for a CP (card-present) transaction. For a CNP transaction, the type will be BUYER.

receipt_urlstring

The location of the receipt on Finix's Amazon S3.

Example response

{
  "additional_details": [
    {
      "name": "Invoice Number",
      "value": "4FEBVZP0-0002"
    }
  ],
  "amount": 5000,
  "customization_details": {
    "subheader_attributes": [
      {
        "name": "PO Number",
        "value": "PO-12345"
      }
    ],
    "summary_sections": [
      {
        "name": "Payment Instructions",
        "value": "Make a payment using our online portal."
      }
    ],
    "footer_sections": [
      {
        "name": "Return Policy",
        "value": "30-day return window with receipt. No refunds on clearance items. Exchanges allowed within 14 days."
      }
    ]
  },
  "items": [
    {
      "item_details": {
        "commodity_code": "175-62-20",
        "cost_per_unit": 500,
        "merchant_product_code": "1149611",
        "unit_of_measure": "BX"
      }
    }
  ]
}

Changes