FIfinix
Receipts

Create a Receipt

Changed on

Create a Receipt resource to generate a receipt for a Transfer or Authorization. Receipts are supported for DEBIT and REVERSAL transfers, as well as CREDIT transfers from unreferenced refunds.

Include basic details such as total amount, buyer billing information, merchant name, and contact info.

Optionally, provide:

  • an amount_breakdown of charges like subtotal, shipping, and surcharges
  • an items list with product name, description, price, and quantity
  • customization_details for structured data in the receipt header (subheader_attributes) and free-form text arrays above or below the receipt line items (summary_sections and footer_sections).
  • additional_details as an array of key-value pairs to capture extra metadata, such as "Invoice Number" or "Service Date". additional_details is mutually exclusive with customization_details.subheader_attributes.
post/receipts

Request

Headers

Finix-Versionstring
Example:2022-02-01

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

Content-Typestring
Example:application/json

The data type being sent in the request body must be application/json.

Request body

OR

Example request

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

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": {
    "footer_sections": [
      {
        "name": "Return Policy",
        "value": "30-day return window with receipt. No refunds on clearance items. Exchanges allowed within 14 days."
      }
    ],
    "subheader_attributes": [
      {
        "name": "PO Number",
        "value": "PO-12345"
      }
    ],
    "summary_sections": [
      {
        "name": "Payment Instructions",
        "value": "Make a payment using our online portal."
      }
    ]
  },
  "items": [
    {
      "item_details": {
        "commodity_code": "175-62-20",
        "cost_per_unit": 500,
        "merchant_product_code": "1149611",
        "unit_of_measure": "BX"
      }
    }
  ]
}

Changes

  • fa256b901d16Revision changes
    • breaking

      the request's body type changed from object to no type

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      added to the request body anyOf list

  • 156f17ff484dRevision changes
    • info

      added the new optional request property

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status

    • info

      the response property /// became required for the status