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

List receipts beta

List receipts by trasnferID, scheduleID, or occurrenceID.

To access this endpoint using an access token you’ll need to specify the /accounts/{accountID}/transfers.read scope.

GET
/receipts
200 401 403 429 500 504
The request completed successfully.
[
  {
    "createdBy": "25a02396-1048-48f9-bf93-102d2fb7895e",
    "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": "2025-01-16T17:52:14.219311143Z"
      }
    ]
  }
]

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The user is not authorized to make the request.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

Query parameters

id

string <uuid>
The unique identifier to filter receipts by.

Response

application/json

createdBy

string<uuid>
AccountID for which the receipt request was created.

disabledOn

string<date-time>
The date and time the receipt was disabled.

email

string
The email address the receipt is sent to. Either email or emailAccountID will be in the response, but not both.

emailAccountID

string<uuid>
The accountID the receipt is sent to. Either email or emailAccountID will be in the response, but not both.

forOccurrenceID

string<uuid>
The ID of the schedule occurrence associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

forScheduleID

string<uuid>
The ID of the schedule associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

forTransferID

string<uuid>
The ID of the transfer associated with this receipt. Exactly one of forTransferID, forScheduleID, or forOccurrenceID must be provided.

kind

string
The type of receipt.
The type of receipt being requested.
Possible values: sale.customer.v1

receiptID

string<uuid>
Unique identifier for the receipt request.

sentFor

array
The list of receipts that have been sent.
Show child attributes

idempotencyKey

string<uuid>
The idempotency key used when creating the receipt.

receiptID

string<uuid>
Unique identifier for the receipt.

sentOn

string<date-time>
When the receipt was sent.