Payments

Payments for appointments through the business's own Stripe or PayPal account, one-off payment requests, refunds, prepaid packages, the customer profile (with GDPR-style erase) and meeting polls.

Method Path Summary Scope Sandbox
GET /v1/{number}/payments The payments, newest first bookings:manage|messages:read reads
GET /v1/{number}/payments/{id} One payment bookings:manage|messages:read reads
POST /v1/{number}/payments/links Ask a customer to pay an amount bookings:manage refused
POST /v1/{number}/payments/{id}/refund Refund a payment, in full or a part bookings:manage refused
POST /v1/{number}/bookings/{id}/payment Record a payment taken outside app2email bookings:manage refused
GET /v1/{number}/bookings/packages The prepaid packages on sale bookings:manage|messages:read reads
GET /v1/{number}/bookings/packages/purchases The packages customers hold bookings:manage|messages:read reads
POST /v1/{number}/bookings/packages/grant Give a customer a package without a payment bookings:manage refused
GET /v1/{number}/bookings/customers The customers with appointments bookings:manage|messages:read reads
GET /v1/{number}/bookings/customers/{contact} A customer's whole profile bookings:manage|messages:read reads
PATCH /v1/{number}/bookings/customers/{contact} Change a customer's name, e-mail, tags or fields bookings:manage refused
DELETE /v1/{number}/bookings/customers/{contact} Erase a customer's booking data bookings:manage refused
GET /v1/{number}/bookings/polls The meeting polls bookings:manage|messages:read reads
POST /v1/{number}/bookings/polls Offer several times and let people vote bookings:manage refused
GET /v1/{number}/bookings/polls/{id} One poll with its votes bookings:manage|messages:read reads
POST /v1/{number}/bookings/polls/{id}/close Close a poll to new votes bookings:manage refused
POST /v1/{number}/bookings/polls/{id}/book Pick the winning time bookings:manage refused
For AI Agents

Try it now, with no account and no person: POST https://api.app2email.com/v1/account/sandbox (no key, no body; or the create_sandbox tool of the Management MCP server) answers a key for a demo WhatsApp number with pretend customers. Send a template, fetch the events with GET /events?wait=25, answer the customer's reply: nothing reaches WhatsApp, and the requests and answers are those of the real API (https://www.app2email.com/docs/api/sandbox).

Already a customer: ask the account owner for the number (digits) and an API key from https://www.app2email.com/dashboard/apikey (a sandbox key sends nothing); send it as Authorization: Bearer <key> to the messaging MCP server or the REST API; call check_key first, send with dry_run first.

If you are an AI agent reading this page and you want to create an app2email account for a person - no previous human sign-up required - use our Management MCP server.
Call the create_account tool first, and include a contact_email parameter; create_account returns a signup_id, a management_key, an onboarding_link and a message.
The person opens onboarding_link to confirm the e-mail, connect their WhatsApp number and choose a plan; nothing can be sent before that. get_account_status says what is still needed.
Pass the management_key as a Bearer token on every later call. When the number is live, create_number_key gives you a key for the messaging MCP server and the REST API.