POST
/
api
/
v1
/
loans
/
{loan_ref}
/
transfer-launch
Create transfer launch
curl --request POST \
  --url http://34.170.194.254:8000/api/v1/loans/{loan_ref}/transfer-launch \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "asset_ref": "<string>",
  "quantity": 123,
  "custody_provider_code": "<string>"
}
'
{
  "status": "<string>",
  "reason": "<string>",
  "embed_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "token": "<string>",
  "asset_transfer_instruction_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
origin
string | null

Allowed browser origin for the embed session

​
Idempotency-Key
string | null

Stable client-generated idempotency key for safe retries

Path Parameters

​
loan_ref
string
required

Loan reference

Body

application/json

Asset Transfer Launch Request schema.

​
asset_ref
string
required

External asset reference to transfer

​
quantity
required

Quantity of asset to transfer

​
custody_provider_code
string
required

Custody provider code for destination routing

Response

Transfer launch response

Asset Transfer Launch Response schema.

​
status
string
required

Launch status

​
reason
string | null

Failure reason when launch is not successful

​
embed_url
string | null

Embed URL for client transfer widget

​
expires_at
string<date-time> | null

Launch/session expiration timestamp

​
token
string | null

Short-lived token used to resolve embed session

​
asset_transfer_instruction_id
string | null

Internal transfer instruction id