Skip to main content
POST
cURL

Authorizations

API-Key
string
header
required

Your public API key. Identifies the partner making the request.

API-Sign
string
header
required

HMAC signature over the request, computed with your private key.

API-Nonce
string
header
required

Monotonically increasing nonce included in the request signature.

Path Parameters

account_id
string
required

Public identifier of the account the link belongs to.

Required string length: 14 - 42

Body

application/json
method_id
string
required

Funding method to link — a method ID, never a name. Use GET /v1/accounts/{account_id}/funds/deposits/methods/{asset_symbol} to discover the methods available to this account.

Required string length: 1 - 64
return_url
string<uri>

Optional partner URL to return the user to after the hosted widget completes. When supplied it must be an absolute https URL without userinfo; other values are rejected.

Required string length: 1 - 2048
external_reference
string

Optional partner correlation value.

Required string length: 1 - 64

Response

Successful response

data
Bank link · object
required

The Bank Link, in pending with a next_action.