NAnatural
Card Sessions

Claim card session

Changed on

Claim the stand-in card and proxy login for an approved session. It succeeds once; with an Idempotency-Key, retrying with the same key returns a fresh login until expiresAt.

post/card-sessions/{sessionId}/claim

Request

  • Base URL
    https://api.natural.com
  • URL
    https://api.natural.com/card-sessions/{sessionId}/claim
  • Auth
    HTTP bearer

Path parameters

sessionIdstring required

Card session ID (csn_*).

Query parameters

customerPartyIdstring

Customer party to act for (pty_*). Omit to act as your own party. To act for another party, pass the ID of a party that has authorized you to act on its behalf.

Headers

Idempotency-Keystring

Optional. Retrying the claim with the same key before expiresAt returns a new stand-in card and proxy login that expire at the same time as the first. Without a key, the credential can't be fetched again.

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

sessionIdstring required
cardIdstring required
allowedHostsstring[] required
expiresAtstring required
instructionsstring[] required

Instructions for configuring and verifying the checkout proxy before paying.

Changes