Skip to main content
​
Documentation
New documentation site. The PayChoice developer docs now live here, organised in the order you integrate: getting started, taking payments, getting the result, storing payment methods, after the payment, recurring billing. The Postman collection remains available with a runnable request for every endpoint.Response fields documented from source. Every endpoint now documents its response fields with types and allowed values, verified against the API implementation. Notable corrections against earlier documentation:
  • Billing objects (customer, membership, subscription, payment schedule, invoice) use a GUID id plus an integer reference_id; the keys are billing_cycle and trial_period; fixed_term is a boolean.
  • status_code is a string on Create charge, Capture, Pre-authorisation and in the webhook charge payload, and an integer on Retrieve charge, List charges and Refund.
  • Reverse returns a flat object, not a reversal_response wrapper.
Webhooks. Notifications are sent for every charge (card and bank, API and Widget), not only bank transactions. Documented the X-Webhook-Signature format (uppercase hex pairs separated by hyphens), that a bank charge receives a second notification on settlement, that there is no automatic retry, and the Retry Notification and Update (PATCH) endpoints. Retrieve is agency-only.Widget. Full parameter reference including Method=all, RequireConfirm and meta; corrected postMessage listener; the asynchronous update clarified as the standard webhook.Brand settings. Documented as part of the merchant-profile API with Basic Authentication; empty-settings 400 and multipart POST behaviour.Other. Pre-authorisation is POST /preauth. The phone parameter is no longer needed on bank charges. The /token and /bank_token endpoints return 200 on v4 and 201 on v5.3D Secure is targeted for release at the end of November 2026.