The payments, newest first
https://api.app2email.com/v1/{number}/payments Scope: bookings:manage (or messages:read). The payments of appointments, package purchases and payment requests. Filter by booking (id or reference), contact, status and kind. Page with next_cursor.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Query
- booking string
Only this appointment's payments (id or BK- reference).
e.g.BK-7Q3M2A - contact string
Only this customer's payments.
e.g.61412345678 - status string
Only this status.
pendingpaidpartly_refundedrefundedfailedexpiredcancelled - kind string
Only this kind.
bookingrequestpackageticket -
How many (1 to 200, default 50).
- cursor string
The next_cursor of the previous answer, unchanged. Leave out for the first page.
Responses
Fields
- success boolean
- request_id string
- payments object[]
Newest first.
24 item 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)
- count integer
- next_cursor string
Pass it as cursor for the next page. Left out on the last page.
- currency 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.
- 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.