Gateway-backed payment operations — set up a payment method, authorize, and verify a payment.
Overview
Payment endpoints cover gateway-backed operations that run through your account’s active payment gateway — initializing payment collection on the front end, and authorizing or confirming a payment.
How It Works
- Create a Stripe setup intent to confirm and save a card off-session (SCA / 3D Secure) without charging it.
- Generate a Braintree client token to initialize the Braintree JS SDK and collect a payment method.
- Get the CyberSource key to render CyberSource’s hosted card form on the front end.
- Authorize a payment through the gateway (Tap).
- Verify a payment (Tap) — the 3D Secure confirmation step after authorize.
API Endpoints
| Method | Endpoint | Description |
|---|---|---|
POST | /api/v1/sdk/customer/setupIntent | Stripe setup intent |
GET | /api/v1/sdk/payment/braintree/generate_client_token | Braintree client token |
GET | /api/v1/sdk/payment/{gateway}/get_frontend_key | CyberSource key |
POST | /api/v1/sdk/payment/{gateway}/authorize | Tap authorize payment |
POST | /api/v1/sdk/payment/{gateway}/verify | Tap verify payment |
Important Behaviors
- These endpoints require an authenticated customer (Bearer JWT) and an active payment gateway on the account.
- The Stripe setup intent requires a Stripe connected account; the Braintree client token requires an active Braintree gateway; authorize and verify currently require Tap.
- The CyberSource key is CyberSource-specific and validates the request
Originagainst the gateway’s supported sites (otherwise400 Site not supported.).