Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Use cases API Changelog
  1. Guides
  2. Money movement

Receipts

Send branded receipts to payers for each transfer.

Send a branded receipt which displays your logo, company name, and links to your customer service portals. You can send a receipt to the payer, the payee, or both. Branded receipts can be sent in the following scenarios:

  • Transfer has been initiated or confirmed
  • Transfer has been refunded
  • Transfer in a series has failed
Receipt email
Receipts API

Send a receipt to the payer after a transfer has been initiated.

Send receipts

Send a receipt using the transfer receipts POST endpoint. The examples below show how to send a receipt for a single transfer, a series of transfers, and a single occurrence in a series of transfers.

If you want to send a receipt to a different email address, you can specify the email field instead of emailAccountID.

For a single transfer, use forTransferID and Moov will send the confirmation, refund, or failure receipt to the payer.

{
  "kind": "sale.customer.v1",
  "email": "customer@example.com",
  "forTransferID": "YOUR_TRANSFER_ID"
}

Schedule receipts for a series of transfers by using forScheduleID. Moov will send the confirmation, refund, or failure receipt to the payer on every occurrence.

{
  "kind": "sale.customer.v1",
  "email": "customer@example.com",
  "forScheduleID": "YOUR_SCHEDULE_ID"
}

For an individual occurrence in a series of transfers, use forOccurrenceID. Moov will send the confirmation, refund, or failure receipt to the payer.

{
  "kind": "sale.customer.v1",
  "email": "customer@example.com",
  "forOccurrenceID": "YOUR_OCCURRENCE_ID"
}

Retrieve receipts

You can retrieve a list of receipts with the transfer receipts GET endpoint. The following is an example response:

[
  {
    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
    "disabledOn": "2009-11-10T23:00:00Z",
    "email": "jordan.lee@classbooker.dev",
    "forTransferID": "193ceb53-94c7-41c4-9272-c90c2832cb4c",
    "kind": "sale.customer.v1",
    "receiptID": "4925c8a5-3b9a-4488-a514-9fd992546aca",
    "sentFor": [
      {
        "idempotencyKey": "0c14c6a6-6f50-4d1e-b0c4-b46ff43ba6a1",
        "receiptID": "4925c8a5-3b9a-4488-a514-9fd992546aca",
        "sentOn": "2009-11-10T23:00:00Z"
      }
    ]
  }
]

Transfer description

When creating a transfer, you can provide a description that will be included in the receipt. This is useful for providing additional context to the payer. If no description is provided, the line item will simply include "Sale".

Sales tax

For transfers that include sales tax, the emailed receipt will include a breakdown of the sales tax amount and the total amount paid. When sales tax is not set, the receipt will only include the total amount paid.

Multiple receipts

You can create multiple receipts for the same transfer with the create receipt endpoint. Creating multiple receipts for a transfer is useful if you want to send a receipt to more than one recipient for the same transaction.

You can send multiple receipts for a transfer by sending more than one receipt object in the request, each with a different email address and the associated forTransferID. If the transaction is part of a scheduled transfer or an occurrence, you can send the associated forScheduleID or forOccurrenceID instead.

curl -X POST "https://api.moov.io/receipts" \
  -H "Authorization: Bearer {token}" \
  --data '[
    {
      "kind": "sale.customer.v1",
      "email": "customer1@example.com",
      "forTransferID": "YOUR_TRANSFER_ID"
    },
    {
      "kind": "sale.customer.v1",
      "email": "customer2@example.com",
      "forTransferID": "YOUR_TRANSFER_ID"
    },
    {
      "kind": "sale.customer.v1",
      "email": "billing@example.com",
      "forTransferID": "YOUR_TRANSFER_ID"
    }
  ]'\

Receipt emails

Receipt emails are optimized to work on all screen sizes and for all email clients.

Sales / purchases

Receipts for purchases include the following details:

  • Transfer amount
  • Transfer date
  • Receipt ID
  • Transfer description (if provided)
  • Source payment method
  • Sales tax amount and total amount paid (if applicable)
  • Issuer confirmation number (if applicable)

Refunds

Receipts for refunds include the following details:

  • Refund amount
  • Refund date
  • Original payment method
  • Receipt ID

Failures

Receipts for failed transfers include the following details:

  • Transfer amount
  • Receipt ID
  • Source payment method
Summary Beta