Send a receipt | Run Developers

Emails a receipt for a past transaction. No active terminal session or online terminal is required: the receipt is generated from stored transaction data, so its content matches a receipt emailed at charge time.

This endpoint is under /api/v1/, not /api/terminal/.

Authentication

AuthorizationBearer

Use a Payments API key as the bearer token: Authorization: Bearer <api_key>. Get a fresh key from Refresh API Keys.

Request

This endpoint expects an object.

emailstringRequiredformat: "email"

Recipient email address. Always required; there's no fallback to an email on file.

midstringRequired

Merchant ID. Resolves and authorizes the acting account.

trans_idstringRequired

Transaction to generate the receipt for. Lookup by order_id isn't supported.

custom_messagestringOptional

Message to include in the receipt email.

Response

Receipt sent

successbooleanOptional

messagestringOptional

Errors

400

Bad Request Error

401

Unauthorized Error

422

Unprocessable Entity Error

429

Too Many Requests Error

500

Internal Server Error