Send a Receipt
Email or text a customer their receipt for a completed payment
Send a customer their receipt for a completed payment — by email or text — using the payment's id. It works for any card payment (sale, capture, or refund), so you can confirm a charge to the customer without building your own receipt template.
Common use cases
- Email a receipt after a phone or virtual-terminal payment
- Text a receipt to a customer who paid in person
- Re-send a receipt a customer didn't receive
Send a receipt
Send the receipt for a payment by passing the payment id and a contact — an email address to email it, or a phone number to text it.
POST /checkout/v3/paymentreceipt?id=12345678&[email protected]Sent via POST /checkout/v3/paymentreceipt. You'll get back 202 Accepted — the receipt is queued for delivery to the contact.
| Parameter | Required | Description |
|---|---|---|
id | ✓ | The payment id to send the receipt for. |
contact | ✓ | Where to send it: an email address (emails the receipt) or a phone number (texts it). |
ignoreBcc | Skip the merchant BCC copy of the receipt. |
What appears on the receipt — business name, logo, contact details, and which fields show — comes from your receipt settings. Configure those on Merchant Configuration.
Retrieve a receipt
To read the receipt for a payment (rather than send it), call GET /checkout/v3/paymentreceipt?id={id} with the payment id.
See also
- Merchant Configuration: control how receipts look
- Sale: take the payment you're sending a receipt for
- Refund: send a receipt for a refund
- Payment Lifecycle: payment statuses and tracking
Updated about 4 hours ago