Create a KuvarSend account-link request

POST

/api/v1/payouts/account-link-requests

KuvarSend Payouts

Start the one-time authorization that lets you pay a KuvarSend user directly into their
KuvarSend wallet. Returns an authorization_url to send the user to; the request expires
after 10 minutes. Requires a LIVE secret key with the account_links:write scope, the
business enabled for external payouts, and a source IP on the payout allowlist. Sandbox
keys are rejected (ACCOUNT_LINK_LIVE_ONLY).

Request

Authorization

API Key

Add parameter in header

X-API-Key

Example:

X-API-Key: ********************

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Authorization request created

Bodyapplication/json

🟠400

🟠403

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location '/api/v1/payouts/account-link-requests' \
--header 'Idempotency-Key;' \
--header 'X-API-Key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "external_user_reference": "string",
    "redirect_uri": "stringstring",
    "state": "stringstringstringstri",
    "code_challenge": "string",
    "code_challenge_method": "S256",
    "scope": "payouts:receive"
}'

Response Example

201 - Example 1

{
    "data": {
        "id": "string",
        "authorization_url": "string",
        "expires_at": "2019-08-24T14:15:22.123Z"
    }
}

Modified at 2026-09-29 14:59:15

Get payout status

Exchange an approved authorization for a linked account