Overview

The Merchant API is one API for taking payments on every method and channel your account is set up for. Create a payment intent, send your customer to our checkout or confirm it with the method they chose, and follow it to its outcome. Your server calls it on https://api.example.com; every path is under /v1.

Additive changes (a new field, resource or error code) ship inside /v1, so build your integration to ignore fields it does not know. Removing or changing the meaning of anything needs /v2 and a deprecation period.

Test and live

Your account has two environments, and an API key belongs to one of them. Test keys (ci_test_..., sk_test_...) work in test mode, where no money ever moves and every payment is simulated. Live keys (ci_live_..., sk_live_...) take real payments. Every object says which it belongs to in livemode, and a key sees only its own mode's objects. Build and try everything in test mode first: see Test mode and test values.

Where to go next

QuickstartFrom an API key to a first test payment, with curl.

AuthenticationExchange your key for an Access Token, and what a key can reach.

Test mode and test valuesTry the whole path without moving money.

Testing your integrationMake a payment succeed, fail or expire, and what changes when you go live.

Payment intentsThe lifecycle of a payment, and the three ways a customer pays.

WebhooksBe told how each payment went, and verify the signature.

RefundsReturn money to a customer, in full or in part.

API referenceEvery operation, with its parameters and responses.