# Create a Receipt Create a resource to generate a receipt for a Transfer or Authorization. ### Basic Details A should include basic details, such as the total amount, buyer billing information, merchant name, and contact information. ### Additional Details You can provide additional details on the as described below. #### Include a breakdown of charges You can provide a breakdown of the additional charges/fees () 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 (), including product name, description, price, quantity, etc., for each item in this order. #### Include Additional Details You can provide additional details to be included on the receipt such as "Invoice Number", "VIN", "Service Date", or "Technician". Endpoint: POST /receipts Version: 2022-02-01 Security: BasicAuth ## Header parameters: - `Finix-Version` (string) Specify the API version of your request. For more details, see Versioning. Example: "2022-02-01" ## Request fields (application/json): - `entity_id` (string, required) The ID of the or for which the receipt must be generated. - `send_receipt_to_buyer` (boolean, required) Whether to send a receipt to the buyer. - `requested_delivery_methods` (array) An array of delivery methods used to send the receipt. - `requested_delivery_methods.type` (string, required) The type of delivery method used to send the receipt. Enum: "EMAIL", "SMS", "PRINT" - `requested_delivery_methods.destinations` (array, required) A list of destinations to send the receipt. - `amount_breakdown` (object) The individual charges/fees that add up to the total amount. - `amount_breakdown.subtotal_amount` (integer) The subtotal amount of the purchase before any taxes, shipping, or additional charges are applied. - `amount_breakdown.shipping_amount` (integer) The amount charged for shipping the items in the order. - `amount_breakdown.estimated_tax_amount` (integer) The estimated amount of tax applied to the order. - `amount_breakdown.additional_buyer_charges` (object,null) Additional charges that the buyer paid. - `amount_breakdown.additional_buyer_charges.convenience_amount` (integer,null) A convenience fee to charge the buyer for the transaction. This object property is mutually exclusive. - `amount_breakdown.additional_buyer_charges.rent_surcharge_amount` (integer,null) A rent surcharge to charge the buyer for the transaction. This object property is mutually exclusive. - `amount_breakdown.additional_buyer_charges.surcharge_amount` (integer,null) A surcharge amount to charge the buyer for the transaction. This object property is mutually exclusive. - `amount_breakdown.discount_amount` (integer) A reduction applied to the total amount. - `amount_breakdown.tip_amount` (integer) The tip amount included in the order total. - `items` (object) An itemized list of products/services. - `items.name` (string) The product name. - `items.description` (string) A product description. - `items.quantity` (integer) The product quantity. - `items.image_details` (object) Product image locations. - `items.image_details.primary_image_url` (string) The location of a product image. - `items.image_details.alternative_image_urls` (array) The locations of backup images if there is an issue with the primary image. - `items.price_details` (object) Additional details about the price. - `items.price_details.sale_amount` (integer) The on-sale price of the item if it is different from the . - `items.price_details.currency` (string) ISO 4217 3 letter currency code. Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" - `items.price_details.price_type` (string) Whether the price is on-sale () or the normal price (). Enum: "PROMOTIONAL", "REGULAR" - `items.price_details.regular_amount` (integer) The standard price of the item without any adjustments applied (e.g. discounts, taxes, sales). - `additional_details` (array) An array of key-value pairs for including any extra metadata or custom information related to the receipt. Each entry must contain a and a corresponding . - `additional_details.name` (string) The label or title for the additional detail being provided. This should be a short, human-readable identifier such as "Invoice Number", "VIN", "Service Date", or "Technician". - `additional_details.value` (string) The corresponding value for the detail specified in name. This can be any string that provides relevant context or information to appear on the receipt, such as an actual invoice number, vehicle identification number, or date. ## Response 201 fields (application/json): - `id` (string) The ID of the resource. - `created_at` (string) Timestamp of when the object was created. - `updated_at` (string) Timestamp of when the object was last updated. - `amount` (integer) The total amount that will be debited in cents (e.g. 100 cents to debit $1.00). - `currency` (string) ISO 4217 3 letter currency code. Enum: "AED", "AFN", "ALL", "AMD", "ANG", "AOA", "ARS", "AUD", "AWG", "AZN", "BAM", "BBD", "BDT", "BGN", "BHD", "BIF", "BMD", "BND", "BOB", "BOV", "BRL", "BSD", "BTN", "BWP", "BYR", "BZD", "CAD", "CDF", "CHE", "CHF", "CHW", "CLF", "CLP", "CNY", "COP", "COU", "CRC", "CUC", "CUP", "CVE", "CZK", "DJF", "DKK", "DOP", "DZD", "EGP", "ERN", "ETB", "EUR", "FJD", "FKP", "GBP", "GEL", "GHS", "GIP", "GMD", "GNF", "GTQ", "GYD", "HKD", "HNL", "HRK", "HTG", "HUF", "IDR", "ILS", "INR", "IQD", "IRR", "ISK", "JMD", "JOD", "JPY", "KES", "KGS", "KHR", "KMF", "KPW", "KRW", "KWD", "KYD", "KZT", "LAK", "LBP", "LKR", "LRD", "LSL", "LTL", "LYD", "MAD", "MDL", "MGA", "MKD", "MMK", "MNT", "MOP", "MRO", "MUR", "MVR", "MWK", "MXN", "MXV", "MYR", "MZN", "NAD", "NGN", "NIO", "NOK", "NPR", "NZD", "OMR", "PAB", "PEN", "PGK", "PHP", "PKR", "PLN", "PYG", "QAR", "RON", "RSD", "RUB", "RWF", "SAR", "SBD", "SCR", "SDG", "SEK", "SGD", "SHP", "SLL", "SOS", "SRD", "SSP", "STD", "SVC", "SYP", "SZL", "THB", "TJS", "TMT", "TND", "TOP", "TRY", "TTD", "TWD", "TZS", "UAH", "UGX", "USD", "USN", "UYI", "UYU", "UZS", "VEF", "VND", "VUV", "WST", "XAF", "XAG", "XAU", "XBA", "XBB", "XBC", "XBD", "XCD", "XDR", "XOF", "XPD", "XPF", "XPT", "XSU", "XTS", "XUA", "XXX", "YER", "ZAR", "ZMW", "ZWL" - `amount_breakdown` (object,null) The individual charges/fees that add up to the total amount. - `amount_breakdown.subtotal_amount` (integer) The subtotal amount of the purchase before any taxes, shipping, or additional charges are applied. - `amount_breakdown.discount_amount` (integer,null) A reduction applied to the total amount. - `amount_breakdown.shipping_amount` (integer,null) The amount charged for shipping the items in the order. - `amount_breakdown.estimated_tax_amount` (integer,null) The estimated amount of tax applied to the order. - `amount_breakdown.tip_amount` (integer,null) The tip amount included in the order total. - `amount_breakdown.additional_buyer_charges` (object,null) Additional charges that the buyer paid. - `amount_breakdown.additional_buyer_charges.convenience_amount` (integer,null) A convenience fee to charge the buyer for the transaction. This object property is mutually exclusive. - `amount_breakdown.additional_buyer_charges.rent_surcharge_amount` (integer,null) A rent surcharge to charge the buyer for the transaction. This object property is mutually exclusive. - `amount_breakdown.additional_buyer_charges.surcharge_amount` (integer,null) A surcharge amount to charge the buyer for the transaction. This object property is mutually exclusive. - `send_receipt_to_buyer` (boolean) Whether to send a receipt to the buyer. - `device_id` (string,null) Applies to [in-person payments](/guides/in-person-payments). The ID of the Point-of-Sale terminal used to process the payment. - `entity_details` (object) The or details from which to generate the receipt. - `entity_details.id` (string) The ID of the or . - `entity_details.created_at` (string) The timestamp when the or was created. - `entity_details.type` (string) The type of transaction the receipt was created for. Enum: "TRANSFER", "AUTHORIZATION" - `type` (string) The type of receipt, either for the customer () or the merchant () for a CP (card-present) transaction. For a CNP transaction, the will be . Enum: "BUYER", "MERCHANT" - `items` (array) An itemized list of products/services. - `merchant_details` (object) Object containing details. - `merchant_details.id` (string) The ID of the . - `merchant_details.business_name` (string,null) The merchant's legal business name. For a sole proprietorship, pass the owner's legal first name, last name, and middle initial. - `merchant_details.doing_business_as` (string,null) Alternate names of the business. If there are no other names, pass the same value used for . - `merchant_details.business_address` (object,null) The primary address for the legal entity. - `merchant_details.business_address.city` (string,null) City. - `merchant_details.business_address.country` (string,null) The sender’s country. Enum: "ABW", "AFG", "AGO", "AIA", "ALA", "ALB", "AND", "ARE", "ARG", "ARM", "ASM", "ATA", "ATF", "ATG", "AUS", "AUT", "AZE", "BDI", "BEL", "BEN", "BES", "BFA", "BGD", "BGR", "BHR", "BHS", "BIH", "BLM", "BLR", "BLZ", "BMU", "BOL", "BRA", "BRB", "BRN", "BTN", "BVT", "BWA", "CAF", "CAN", "CCK", "CHE", "CHL", "CHN", "CIV", "CMR", "COD", "COG", "COK", "COL", "COM", "CPV", "CRI", "CUB", "CUW", "CXR", "CYM", "CYP", "CZE", "DEU", "DJI", "DMA", "DNK", "DOM", "DZA", "ECU", "EGY", "ERI", "ESH", "ESP", "EST", "ETH", "FIN", "FJI", "FLK", "FRA", "FRO", "FSM", "GAB", "GBR", "GEO", "GGY", "GHA", "GIB", "GIN", "GLP", "GMB", "GNB", "GNQ", "GRC", "GRD", "GRL", "GTM", "GUF", "GUM", "GUY", "HKG", "HMD", "HND", "HRV", "HTI", "HUN", "IDN", "IMN", "IND", "IOT", "IRL", "IRN", "IRQ", "ISL", "ISR", "ITA", "JAM", "JEY", "JOR", "JPN", "KAZ", "KEN", "KGZ", "KHM", "KIR", "KNA", "KOR", "KWT", "LAO", "LBN", "LBR", "LBY", "LCA", "LIE", "LKA", "LSO", "LTU", "LUX", "LVA", "MAC", "MAF", "MAR", "MCO", "MDA", "MDG", "MDV", "MEX", "MHL", "MKD", "MLI", "MLT", "MMR", "MNE", "MNG", "MNP", "MRT", "MSR", "MTQ", "MUS", "MWI", "MYS", "MYT", "NAM", "NCL", "NER", "NFK", "NGA", "NIC", "NIU", "NLD", "NOR", "NPL", "NRU", "NZL", "OMN", "PAK", "PAN", "PCN", "PER", "PHL", "PLW", "PNG", "POL", "PRI", "PRK", "PRT", "PRY", "PSE", "PYF", "QAT", "REU", "ROU", "RUS", "RWA", "SAU", "SDN", "SEN", "SGP", "SGS", "SHN", "SJM", "SLB", "SLE", "SLV", "SMR", "SOM", "SPM", "SRB", "SSD", "STP", "SUR", "SVK", "SVN", "SWE", "SWZ", "SXM", "SYC", "SYR", "TCA", "TCD", "TGO", "THA", "TJK", "TKL", "TKM", "TLS", "TON", "TTO", "TUN", "TUR", "TUV", "TWN", "TZA", "UGA", "UKR", "UMI", "URY", "USA", "UZB", "VAT", "VCT", "VEN", "VGB", "VIR", "VNM", "VUT", "WLF", "WSM", "XKX", "YEM", "ZAF", "ZMB", "ZWE" - `merchant_details.business_address.line1` (string,null) The first line of the address. - `merchant_details.business_address.line2` (string,null) The second line of the address. - `merchant_details.business_address.postal_code` (string,null) The zip or postal code. - `merchant_details.business_address.region` (string,null) 2-letter state code. - `payment_instrument_details` (object) Object containing details. - `payment_instrument_details.type` (string) The type of . Enum: "PAYMENT_CARD" - `payment_instrument_details.billing_address` (object) The primary address associated with the . - `payment_instrument_details.bin` (string) The Bank Identification Number for the . - `payment_instrument_details.brand` (string) The of the card saved in the . Enum: "UNKNOWN", "DINERS_CLUB_INTERNATIONAL", "DANKORT", "MIR", "TROY", "UATP", "CHINA_T_UNION", "CHINA_UNION_PAY", "AMERICAN_EXPRESS", "VERVE", "RUPAY", "DISCOVER", "JCB", "MASTERCARD", "INTERPAYMENT", "INSTAPAYMENT", "MAESTRO", "VISA", "LANKAPAY", "DINERS_CLUB", "INTERAC" - `payment_instrument_details.card_type` (string) The type of payment card saved in the . Enum: "CREDIT", "DEBIT", "HSA_FSA", "NON_RELOADABLE_PREPAID", "RELOADABLE_PREPAID", "UNKNOWN" - `payment_instrument_details.last_four` (string) The last four digits of the card or bank account number. - `payment_instrument_details.name` (string,null) The name of the bank account or card owner. - `network_details` (object,null) An object containing EMV data. - `network_details.application_label` (string,null) The EMV application label. Tag 50 from the EMVCo standard. - `network_details.application_identifier` (string,null) The ID of the application used in the transaction. Tag 9F06 from the EMVCo standard. - `network_details.cryptogram` (string,null) The cryptogram returned by the card. Tag 9F26 of the EMVCo standard. - `network_details.approval_code` (string,null) The unique ID used to identify the approval of the . - `requested_delivery_methods` (array) An array of delivery methods used to send the receipt. - `requested_delivery_methods.type` (string, required) The type of delivery method used to send the receipt. Enum: "EMAIL", "SMS", "PRINT" - `requested_delivery_methods.destinations` (array, required) A list of destinations to send the receipt. - `receipt_url` (string) The location of the receipt on Finix's Amazon S3. - `_links` (object) An object containing link(s) relevant to the request. You can store these links for follow-up requests. - `_links.self` (object) - `_links.self.href` (string) The path to the new resource. ## Response 401 fields (application/json): - `total` (integer) - `_embedded` (object) - `_embedded.errors` (array) - `_embedded.errors.code` (string) Enum: "UNKNOWN" - `_embedded.errors.logref` (object) - `_embedded.errors.message` (string) - `_embedded.errors._links` (object) - `_embedded.errors._links.self` (object) - `_embedded.errors._links.self.href` (string) - `_embedded.errors._links.source` (object) ## Response 403 fields (application/json): - `total` (integer) - `_embedded` (object) - `_embedded.errors` (array) - `_embedded.errors.code` (string) Enum: "FORBIDDEN" - `_embedded.errors.logref` (object) - `_embedded.errors.message` (string) - `_embedded.errors._links` (object) - `_embedded.errors._links.source` (object) - `_embedded.errors._links.source.href` (string) ## Response 404 fields (application/json): - `total` (integer) - `_embedded` (object) - `_embedded.errors` (array) - `_embedded.errors.code` (string) Enum: "NOT_FOUND" - `_embedded.errors.logref` (object) - `_embedded.errors.message` (string) - `_embedded.errors._links` (object) - `_embedded.errors._links.source` (object) - `_embedded.errors._links.source.href` (string) ## Response 422 fields (application/json): - `total` (integer) - `_embedded` (object) - `_embedded.errors` (array) - `_embedded.errors.code` (string) Enum: "INVALID_FIELD" - `_embedded.errors.field` (string) - `_embedded.errors.logref` (object) - `_embedded.errors.message` (string) - `_embedded.errors._links` (object) - `_embedded.errors._links.source` (object) - `_embedded.errors._links.source.href` (string)