Getting started
Introduction
What Key2Pay is and how the API is shaped.
The Key2Pay API exposes a small, opinionated surface for accepting local payments across LATAM, EU, and APAC and settling them as crypto. It is RESTful, returns JSON, and uses standard HTTP verbs and status codes. Everything you can do from the dashboard, you can do from the API.
The operation currency is ALWAYS USD. Every payment is initiated in USD — the `amount` you send is in USD major units, and there is no input currency to choose. Key2Pay converts USD → the buyer's local currency automatically (per country + method) and returns the local figures as `amountLocal` + `currencyLocal`. You always price and settle in USD.
Highlights
Hosted checkout
Drop-in payment page with live cascade and risk routing.
Server APIs
Direct charge, refund, retrieve, and list with offset-based pagination.
Signed webhooks
HMAC-SHA256 with replay protection and timestamp window.
Design principles
- Predictable: standard HTTP semantics, no envelope on success bodies, never an HTML error.
- Idempotent: every money-moving POST (
/payments,/withdrawals,/payments/{id}/refund) acceptsIdempotency-Key. - Versioned: pin a date and stay on it. New optional fields are not breaking changes.
- Compliant by default: hosted checkout keeps PAN out of your servers; webhooks are signed.