Refund an order or some of its tickets
https://api.app2email.com/v1/{number}/tickets/orders/{id}/refund Scope: tickets:manage. Not with a sandbox key. Refunds every valid ticket of the order, or only ticket_ids. what: all (the default) or prices (without booking fees and donations). money says how the money goes back: provider = through the business's own Stripe or PayPal account (real money, it cannot be undone), recorded = it was handed back outside, outside = the business refunded it at Stripe or PayPal itself, none = cancel without a refund. Left out, it follows the order: provider for an online order, recorded for a sale paid outside, none for free and complimentary tickets. The refunded tickets stop working at once and their places go back on sale; the buyer is told unless notify is false. ticket.order.refunded is sent. 409 refund_not_possible when nothing is left to refund, 409 payments_not_connected, 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).
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The order: its id or its reference (TK-XXXXXX).
e.g.TK-7H3KQ9
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
-
Tickets of this order. Left out or []: every valid ticket of the order.
-
all: everything paid for the tickets. prices: without booking fees and donations.
allprices - money string
provider: back through the business's own Stripe or PayPal account. recorded: the money was handed back outside. outside: the business refunded it at Stripe or PayPal itself. none: cancel without a refund. Left out: provider for an online order, recorded for a sale paid outside, none for free and complimentary tickets.
providerrecordedoutsidenone -
false: do not tell the buyer.
Responses
Fields
- success boolean
- request_id string
- order object
A ticket order: the buyer, the money and, where asked for, its tickets. Money is a number in the order's currency plus a label. Also inside ticket.order.confirmed and ticket.order.refunded, there with an empty page_url.
42 fields
- id integer
The order's id.
e.g.8812 - reference stringe.g.
TK-7H3KQ9 - status string
pending: a checkout that is not finished. expired: it was never paid or confirmed. confirmed: the tickets were issued.
pendingconfirmedpartly_refundedrefundedcancelledexpired - kind string
online: paid by card. free: a free order. comp: complimentary. outside: paid outside app2email.
onlinefreecompoutside - channel string
Where it was made.
webwhatsappstaffdoorapi - source string
The src label of the link the buyer came through.
- event object
- date object
The date that was bought.
4 fields
- id integer
- start string (date-time) | null
- start_local string
- label string
- buyer object
4 fields
- name string
- contact string
The WhatsApp number in digits, or a business-scoped user id. Empty when unknown; erased-... after an erase.
- email string
- no_whatsapp boolean
The buyer said they do not use WhatsApp.
- currency stringe.g.
AUD - total number
What the buyer pays, in currency.
- total_label stringe.g.
A$24.00 - tickets_total number
The sum of the ticket prices.
- order_fee number
- donation number
- discount number
Information: already taken off tickets_total.
- fees number
Information: the booking fees inside total.
- tax number
Information: the tax inside total.
- refunded number
- refunded_label string
Empty while nothing was refunded.
- ticket_count integer
Tickets of role ticket.
- people_count integer
The people they admit.
- addon_count integer
- promo_code string
- payment object
- comp_reason string
kind comp: guest, artist, press, sponsor, staff, prize or other.
- staff_note string
The business's internal note.
- created_by string
customer, a person of the business, or API key <name>.
- attention string
Not empty: the order needs a look. dispute: the buyer's bank opened a card dispute and the tickets are blocked.
refund_failedrefund_outsiderefund_mismatchpaid_twicedispute - close_reason string
Why it ended without tickets: unpaid, buyer_cancelled, staff_cancelled, late_payment, date_cancelled, event_cancelled or erased.
- refund_request object | null
A refund the buyer asked for. null when there is none.
-
The answers given for the order: question id -> value.
- marketing_optin boolean
- erased boolean
The buyer's details were erased on request.
- page_url string
The ticket page of this order. Anyone who has the link can open the tickets: treat it like a password and give it only to the buyer. Empty in webhook events and for an erased order.
- expires string (date-time) | null
pending: until when it can be paid or confirmed.
- confirmed string (date-time) | null
When the tickets were issued.
- cancelled string (date-time) | null
- refunded_at string (date-time) | null
- created string (date-time)
- updated string (date-time)
- tickets object[]
Every ticket of the order, any status. In GET /tickets/orders only with tickets=true.
29 item fields
- id integer
The ticket's id.
e.g.501 - order_id integere.g.
8812 - order_reference stringe.g.
TK-7H3KQ9 - event_id integere.g.
12 - date_id integer
The date the ticket is for.
e.g.31 - type_id integere.g.
44 - type_name string
The ticket type's name as it was sold.
e.g.Adult - role string
ticketaddon - seq integer
1..n inside the order.
- status string
valid and blocked tickets hold a place; refunded, cancelled and transferred (passed on) are final.
validblockedrefundedcancelledtransferred - holder_name string
-
The answers given for this ticket: question id -> value.
- seat object | null
null without a seat.
- admits integer
- check_in object
The check-in state of a ticket.
7 fields
- people integer
People admitted so far (0 to admits). Above 0 = checked in.
- inside integer
People inside now, for events that count people leaving.
- entries integer
Accepted scans on the way in.
- first_at string | null
- last_at string | null
- last_out_at string | null
- gate string
The id of the entrance of the last scan.
- currency string
- price number
What was paid for this ticket, all in: what a refund of it returns.
- price_label string
- face number
The all-in list price before a discount.
- refunded number
- refunded_at string (date-time) | null
- block_reason string
Why staff blocked it. A disputed payment reads Payment disputed.
- passed_on boolean
true: the ticket was made when a holder passed a ticket on.
- replaces_id integer
The ticket this one replaced. 0 = none.
- replaced_by_id integer
The ticket that replaced this one. 0 = none.
- page_url string
The ticket page of this ticket. Anyone who has the link can open the ticket: treat it like a password and give it only to the buyer. Empty in webhook events, for an erased order and for a ticket that is no longer valid.
- created string (date-time)
- updated string (date-time)
- buyer object
Only in the rows of GET /tickets/issued: who bought it.
- sent boolean
Only after an order was made: a delivery to the buyer was started.
- refunded number
Only after a refund: what this call refunded.
- refunded_label string
- note string
What happened, in one sentence.
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.
- 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.