Turnkey

Borrow against the authenticated org's line to an allowlisted destination

post/v3/turnkey/borrow

Request

  • Base URL: https://api.creditcoop.xyz
  • URL: https://api.creditcoop.xyz/v3/turnkey/borrow
  • Auth: one of:
    • API key in header x-api-key
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://clerk.creditcoop.xyz/oauth/authorize, token URL https://clerk.creditcoop.xyz/oauth/token)

Request body

lineIdstring required

Credit position id on the selected line (unrelated to lineAddress)

amountstring required

Amount in smallest units (uint256 string)

tostring required

Destination address (must be on the allowlist)

organizationIdstring

Required only for multi-org users; inferred otherwise

lineAddressstring

Which bound line to borrow against. Required for a topology v2 (multi-line) org; optional for v1 (defaults to the sole bound line)

networkIdstring

CAIP-2 network id of lineAddress (e.g. eip155:8453). Required with lineAddress

Response

Default Response

transactionHashstring

Changes

No recorded changes to this operation across all 1 revision of this API.