Ramp Post-Redirect Connection Handler

Completes the Ramp boarding handshake after the merchant returns from the Ramp hosted form. Validates the nonce, exchanges the OAuth authorization code for a per-merchant access token, registers and verifies the webhook subscription, hydrates initial connection status, and invalidates the nonce.

Path Params
string
required

Merchant ID

Body Params
string
required
length between 16 and 256

Replay-protection nonce generated by the boarding service at application creation time. Compared with the persisted nonce in constant time. Required.

string
required

OAuth 2.0 authorization code returned by Ramp in the post-redirect query string. Exchanged for a per-merchant access token. Required.

string

Optional client-side state token echoed through the redirect. Not interpreted server-side; provided for parity with OAuth flows that round-trip a state value.

string

Optional override for the OAuth redirect_uri sent during token exchange. Must match the value used in the authorize step. Defaults are managed by the boarding form configuration.

Responses

400

Invalid request — merchant has no Ramp connection or platform OAuth credentials are missing.

401

Nonce mismatch.

404

Merchant or platform not found.

409

Ramp connection state invalid (nonce missing or already invalidated; OR another handshake is in progress for this merchant).

500

Internal server error — token exchange, webhook setup, or persistence failed.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json