Create receipts beta
Create receipts for transfers and scheduled transfers.
To access this endpoint using an access token
you’ll need to specify the /accounts/{accountID}/transfers.write scope.
POST
/receipts
curl --request POST \
--url https://api.moov.io/receipts \
--header 'Authorization: Basic REPLACE_BASIC_AUTH' \
--header 'content-type: application/json' \
--header 'x-moov-version: SOME_STRING_VALUE' \
--data '[{"kind":"sale.customer.v1","email":"jordan.lee@classbooker.dev","emailAccountID":"522950e7-5e68-46b6-abff-8cfb302f3759","forTransferID":"193ceb53-94c7-41c4-9272-c90c2832cb4c","forScheduleID":"ffb5384a-0324-4676-9fec-22943da3a3e1","forOccurrenceID":"d0b80ae0-671a-4854-bc7b-d77ed3cc9214"}]'The resource was successfully created.
{
"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 server could not understand the request due to invalid syntax.
{
"error": "string"
}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.
The requested resource was not found.
Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request conflicted with the current state of the target resource.
{
"error": "string"
}Response headers
x-request-id
string
<uuid>
required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
{
"email": "string",
"emailAccountID": "string",
"forOccurrenceID": "string",
"forScheduleID": "string",
"forTransferID": "string",
"kind": "string"
}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
YYYYis the yearQQis the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)BBis the build number, starting at.01, for subsequent builds in the same quarter.- For example,
v2024.01.00is the initial release of the first quarter of 2024.
- For example,
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
Body
array
application/json
kind
string
required
The type of receipt being requested.
The type of receipt being requested.
Possible values:
sale.customer.v1
string
The email address to send the receipt to.
Either email or emailAccountID must be provided, but not both.
emailAccountID
string<uuid>
The accountID to send the receipt to.
Either email or emailAccountID must be provided, 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.
Response
application/json
createdBy
string<uuid>
required
AccountID for which the receipt request was created.
kind
string
required
The type of receipt.
The type of receipt being requested.
Possible values:
sale.customer.v1
receiptID
string<uuid>
required
Unique identifier for the receipt request.
sentFor
array
required
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.
disabledOn
string<date-time>
The date and time the receipt was disabled.
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.