Refund a payment, in full or a part
https://api.app2email.com/v1/{number}/payments/{id}/refund Scope: bookings:manage. Not with a sandbox key. Sends real money back through the business's own provider; it cannot be undone. amount is a part in the payment's currency; left out, everything that is left. A full refund of an appointment's payment sets its payment.status to refunded. booking.refunded is sent. 409 refund_not_possible, 502 payment_provider_error. Send an Idempotency-Key header to retry safely: the same key and body within 24 hours gets the first answer again (an error does not use the key up). For a payment of kind ticket use POST /tickets/orders/{id}/refund instead: it also ends the tickets.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The payment's id.
e.g.15
Headers
-
A unique value for this message or list (eg a UUID). The same request with the same key within 24 hours gets the first answer again, and nothing is sent twice. Ignored by dry runs.
e.g.order-1234-shipped
Body application/json
- amount number
A part of the money, in the payment's currency. Left out: everything that is left.
e.g.10
Responses
Fields
- success boolean
- request_id string
- payment object
A payment row. kind booking: the online payment (or deposit) of an appointment; request: a one-off payment request; package: a prepaid package bought online. Money is a number in the payment's currency plus a label such as "$40.00". Also inside booking.paid, booking.refunded and payment.paid. ticket: the online payment of a ticket order (the order's payment.id).
24 fields
- id integere.g.
15 - kind string
bookingrequestpackageticket - status string
pendingpaidpartly_refundedrefundedfailedexpiredcancelled - provider string
stripepaypal - amount numbere.g.
40 - amount_label stringe.g.
$40.00 - full_label string
The price before a discount.
- discount_label string
- coupon_code string
- currency stringe.g.
USD - refunded number
- refunded_label string
- description string
- contact string
- payer_name string
- appointment_id integer | null
- booking_reference stringe.g.
BK-7Q3M2A - package_purchase_id integer | null
- checkout_url string
The provider's checkout page while the payment is open. Empty otherwise.
- link_url string
A payment request's page on the business's booking site.
- last_error string
- paid string (date-time) | null
- refunded_at string (date-time) | null
- created string (date-time)
- note string
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 409 Idempotency-Key: the first request with this key is still running, or did not finish. Or a conflict: the template name exists, the webhook URL is used by another webhook, the broadcast cannot be cancelled, the booking slot is taken or the booking is already cancelled, or the Flow is not published.
- 415 The body is not JSON.
- 422 The request is understood but cannot be sent (template parameters, media, text, recipient, or a WhatsApp rule such as the 24 hour window).
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.
- 502 WhatsApp (Meta) returned an error or could not be reached.