Receipts

The Receipt resource generates a receipt for Transfers or Authorizations. You can then send the Receipt via Email, SMS, or use the information from the Receipt to send it yourself.

Create a Receipt

Create a Receipt resource to generate a receipt for a Transfer or Authorization.

A Receipt will include basic details, such as the total amount, buyer billing information, merchant name, and contact information.

You can provide additional details on the Receipt as described below.

Include a breakdown of charges

You can provide a breakdown of the additional charges/fees (amount_breakdown) that add up to the total amount, such as subtotal, shipping amount, or surcharge.

Display an itemized product list

You can provide details of the products in the order (items), including product name, description, price, quantity, etc., for each item in this order.

Request
header Parameters
Finix-Version
string
Default: 2018-01-01

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

Example: 2022-02-01
Request Body schema: application/json
entity_id
required
string

The ID of the Transfer or Authorization for which the receipt must be generated.

send_receipt_to_buyer
required
boolean

Whether to send a receipt to the buyer.

Array of objects

An array of delivery methods used to send the receipt.

object

The individual charges/fees that add up to the total amount.

object

An itemized list of products/services.

Responses
201

A single Receipt object.

401

Authentication information is missing or invalid

403

Forbidden

404

Object does not exist

422

Invalid field

post/receipts
Request samples 
Response samples 
application/json
{
  • "id": "receipt_cdGdu7mHL2DaEHHYf8PPg",
  • "created_at": "2024-07-30T00:26:55.87Z",
  • "updated_at": "2024-07-30T00:26:55.87Z",
  • "amount": 22300,
  • "currency": "USD",
  • "amount_breakdown": null,
  • "send_receipt_to_buyer": true,
  • "device_id": null,
  • "entity_details": {
    • "id": "TRraKDGt53y1XeTbeCkXYMkn",
    • "created_at": "2024-07-30T00:22:25.28Z",
    • "type": "TRANSFER"
    },
  • "type": "BUYER",
  • "items": [ ],
  • "merchant_details": {
    • "id": "MUeDVrf2ahuKc9Eg5TeZugvs",
    • "business_name": "Dunder Mifflin",
    • "doing_business_as": "Dunder Mifflin",
    • "business_address": {
      }
    },
  • "payment_instrument_details": {
    • "id": "PIe2YvpcjvoVJ6PzoRPBK137",
    • "type": "PAYMENT_CARD",
    • "billing_address": {
      },
    • "bin": "489514",
    • "brand": "VISA",
    • "card_type": "UNKNOWN",
    • "last_four": "0006",
    • "name": "Amy White"
    },
  • "network_details": null,
  • "requested_delivery_methods": [
    • {
      },
    • {
      },
    • {
      }
    ],
  • "receipt_url": "https://receipt.sandbox-payments-checkout.com/TYPQp7",
  • "_links": {}
}
Fetch a Receipt
Retrieve the details of a previously created Receipt.


Request 
path Parameters
receipt_id
required
string
The ID of the Receipt.


 
query Parameters
entity_id
string
The ID of the Transfer or Authorization for which the receipt was be generated.


 
header Parameters
Finix-Version
string
 Default:  2018-01-01
Specify the API version of your request. For more details, see Versioning.


 
 Example:  2022-02-01
Responses 
200
A single Receipt object.


401
Authentication information is missing or invalid


403
Forbidden


404
Object does not exist


422
Invalid field


get/receipts/{receipt_id}
Request samples 
curl "https://finix.sandbox-payments-api.com/receipts/receipt_cdGdu7mHL2DaEHHYf8PPg" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples 
application/json
{
  • "id": "receipt_cdGdu7mHL2DaEHHYf8PPg",
  • "created_at": "2024-07-30T00:26:55.87Z",
  • "updated_at": "2024-07-30T00:26:55.87Z",
  • "amount": 22300,
  • "currency": "USD",
  • "amount_breakdown": null,
  • "send_receipt_to_buyer": true,
  • "device_id": null,
  • "entity_details": {
    • "id": "TRraKDGt53y1XeTbeCkXYMkn",
    • "created_at": "2024-07-30T00:22:25.28Z",
    • "type": "TRANSFER"
    },
  • "type": "BUYER",
  • "items": [ ],
  • "merchant_details": {
    • "id": "MUeDVrf2ahuKc9Eg5TeZugvs",
    • "business_name": "Dunder Mifflin",
    • "doing_business_as": "Dunder Mifflin",
    • "business_address": {
      }
    },
  • "payment_instrument_details": {
    • "id": "PIe2YvpcjvoVJ6PzoRPBK137",
    • "type": "PAYMENT_CARD",
    • "billing_address": {
      },
    • "bin": "489514",
    • "brand": "VISA",
    • "card_type": "UNKNOWN",
    • "last_four": "0006",
    • "name": "Amy White"
    },
  • "network_details": null,
  • "requested_delivery_methods": [
    • {
      },
    • {
      },
    • {
      }
    ],
  • "receipt_url": "https://receipt.sandbox-payments-checkout.com/TYPQp7",
  • "_links": {}
}
Create a Delivery Attempt
Create a Delivery Attempt on an existing Receipt resource.


Request 
path Parameters
receipt_id
required
string
The ID of the Receipt.


 
header Parameters
Finix-Version
string
 Default:  2018-01-01
Specify the API version of your request. For more details, see Versioning


 
 Example:  2022-02-01
Request Body schema: application/json
required
Array of objects
A list of delivery methods used to send the receipt.


 
Responses 
202
Accepted for processing


401
Authentication information is missing or invalid


403
Forbidden


404
Object does not exist


422
Invalid field


post/receipts/{receipt_id}/delivery_attempts
Request samples 
curl -i -X POST \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e \
  'https://finix.sandbox-payments-api.com/receipts/receipt_cdGdu7mHL2DaEHHYf8PPg/delivery_attempts' \
  -H 'Content-Type: application/json' \
  -H 'Finix-Version: 2022-02-01' \
  -d '{
    "requested_delivery_methods": [
      {
        "type": "EMAIL",
        "destinations": [
          "benroundtree@gmail.com"
        ]
      },
      {
        "type": "SMS",
        "destinations": [
          "8005550175"
        ]
      },
      {
        "type": "PRINT",
        "destinations": [
          "DVsEanpBtsAVvCHbNXkFaH6f"
        ]
      }
    ]
  }'
Response samples 
application/json
{ }
List Delivery Attempts for a Receipt
Whenever a receipt is sent, a Delivery Attempt resource is created. Use this endpoint to retrieve a list of delivery attempts for a specific Receipt.


Request 
path Parameters
receipt_id
required
string
The ID of the Receipt.


 
query Parameters
limit
integer
The numbers of items to return.


 
 Example:  limit=10
after_cursor
string
Return every resource created after the cursor value.


 
 Example:  after_cursor=TRnasXQ5AmjsLnPMwnme7TL4
before_cursor
string
Return every resource created before the cursor value.


 
 Example:  before_cursor=TRnasXQ5AmjsLnPMwnme7TL4
header Parameters
Finix-Version
string
 Default:  2018-01-01
Specify the API version of your request. For more details, see Versioning.


 
 Example:  2022-02-01
Responses 
200
List of Delivery Attempt objects.


401
Authentication information is missing or invalid


403
Forbidden


404
Object does not exist


422
Invalid field


get/receipts/{receipt_id}/delivery_attempts
Request samples 
curl "https://finix.sandbox-payments-api.com/receipts/receipt_cdGdu7mHL2DaEHHYf8PPg/delivery_attempts" \
  -H "Finix-Version: 2022-02-01" \
  -u USsRhsHYZGBPnQw8CByJyEQW:8a14c2f9-d94b-4c72-8f5c-a62908e5b30e
Response samples 
application/json
{}