Skip to main content
Checks the status of a hosted merchant login started with buy_connect. Call it after the user finishes logging in, and call it again in a few seconds if the link is still in progress.

Parameters

ParameterTypeRequiredDescription
merchantstringYesMerchant slug (e.g. doordash).
pending_idstringYesThe pending_id returned by buy_connect.

Returns

One of four states with a message spelling out the next step: linking (still in progress, wait a few seconds and call again), linked (success, the merchant is ready to shop), expired (the session ended before the user finished, start a new buy_connect), or error (the login failed, try buy_connect again). The merchant slug is included when linked.

Example

{ "name": "buy_connect_status", "arguments": { "merchant": "doordash", "pending_id": "pend_8f2c1a" } }