Getting started

The Beta Ramps Gateway API is the partner-facing interface to the Beta Ramps payment gateway. It exposes accounts, orders, payouts, quotes, wallets, bank accounts, and related resources over HTTPS/JSON. Access is authenticated with OAuth2 client-credentials (machine-to-machine) tokens — there is no interactive user login.

EnvironmentsCopy Anchor Link

The API runs in two independent environments, each with its own base URL:

An access token is valid only against the environment it was minted for. A token obtained from the Sandbox token endpoint is rejected by the Production API, and vice versa.

QuickstartCopy Anchor Link

1. Obtain an integration key. Create an integration key for your account to receive a client_id and client_secret. The scopes you select when creating the key determine what the resulting tokens can do.
2. Mint an access token. Exchange the integration key for a short-lived bearer token at the token endpoint.
3. Call an endpoint. Send the bearer token in the Authorization header on every request.

1. Mint an access tokenCopy Anchor Link

curl -X POST https://api.betaramps.com/auth/token \
  -H 'Content-Type: application/json' \
  -d '{"client_id":"...","client_secret":"..."}'

The response contains an access_token and an expires_in (seconds). Read expires_in and refresh the token before it elapses.

2. Call an endpointCopy Anchor Link

curl https://api.betaramps.com/orders \
  -H 'Authorization: Bearer <access_token>'

Error modelCopy Anchor Link

Failures return a JSON envelope {code, message}. A 429 response additionally includes a retry_after field and a Retry-After header indicating how long to wait before retrying.

Next stepsCopy Anchor Link

See Authentication for the full client-credentials flow, token lifetime and caching rules, and the list of selectable scopes.