GET
/
api
/
v1
/
loans
/
{loan_ref}
/
transfer-launch
/
status
Poll transfer-launch wallet-address readiness
curl --request GET \
  --url http://34.170.194.254:8000/api/v1/loans/{loan_ref}/transfer-launch/status \
  --header 'Authorization: Bearer <token>'
{
  "status": "<string>",
  "asset_transfer_instruction_id": "<string>",
  "embed_url": "<string>",
  "redirect_url": "<string>",
  "expires_at": "2023-11-07T05:31:56Z",
  "token": "<string>",
  "pending_message": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
loan_ref
string
required

Loan reference

Response

Status fetched

Response for GET /v1/loans/{loan_ref}/transfer-launch/status.

Mirrors the launch response so the UI can swap the polled body in once the address is ready. Until then address_status='pending' and the session URLs are absent.

​
status
string
required

Status fetch outcome

​
address_status
enum<string>
required

Wallet-address lifecycle from custody side

Available options:
ready,
pending
​
asset_transfer_instruction_id
string | null

Internal transfer instruction id

​
delivery_mode
enum<string> | null

Delivery mode.

Available options:
embedded,
hosted
​
embed_url
string | null

Embed url.

​
redirect_url
string | null

Redirect url.

​
expires_at
string<date-time> | null

Expires at.

​
token
string | null

Token.

​
pending_message
string | null

Latest partner status message when address_status='pending'