Connections

Create a connection

Start a reusable login at a merchant. Returns a connect_url, a live window on the merchant's own sign-in page, for the person to complete.

POST/v1/connections

Authorization: BearerBody (JSON)

Live API. A POST to /v1/cards issues a real card.

Authorizations

Authorizationstringrequired

Bearer token: Authorization: Bearer mk_live_.... Create a key in the AgentPay console under Developer, API keys.

Bodyapplication/json

merchantstringrequired

The merchant to connect a login for.

user_refstring

Your own reference for the end user this login belongs to.

Response200application/json

connection_idstring

merchantstring

connect_urlstring

Open it for the person. AgentPay never sees the password.

statusstring

pending until you call complete.

request_idstring

The request id, also in the X-Mooj-Request-Id header.

Errors

Status	Code	When
400	`invalid_request`	`merchant` is missing.
502	`connect_start_failed`	The live window could not be opened. Retry.

Create a connection

curl -X POST https://api.joomjoo.com/v1/connections \
  -H "Authorization: Bearer $AGENTPAY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"merchant":"amazon","user_ref":"user_42"}'

import { AgentPay } from "@agentpay-global/sdk";

const agentpay = new AgentPay(process.env.AGENTPAY_API_KEY);
const conn = await agentpay.connections.create({ merchant: "amazon", user_ref: "user_42" });

import os
from agentpay import AgentPay

agentpay = AgentPay(api_key=os.environ["AGENTPAY_API_KEY"])
conn = agentpay.connections.create(merchant="amazon", user_ref="user_42")

200

{
  "connection_id": "conn_5d2b...",
  "merchant": "amazon",
  "connect_url": "https://connect.browserbase.com/...",
  "status": "pending",
  "request_id": "req_a1b2c3"
}