Skip to main content
POST
/
v1
/
businesses
/
{businessId}
/
withdrawal
/
link
Generate Withdrawal Link
curl --request POST \
  --url https://api.cadanapay.com/v1/businesses/{businessId}/withdrawal/link \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "refreshURL": "<string>",
  "returnURL": "<string>"
}
'
{
  "url": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-MultiTenantKey
string

Required when using a Platform API token. The tenant key identifying which business to operate on.

Path Parameters

businessId
string
required

The unique identifier for the business

Body

application/json

Common request body for endpoints that generate hosted (link-out) URLs.

refreshURL
string

The URL the user will be redirected to if the link is expired

returnURL
string

The URL that the user will be redirected to upon leaving or completing the linked flow.

Response

Common response body for endpoints that return a hosted (link-out) URL.

url
string

Fully-qualified hosted URL valid until the embedded token expires.