Skip to main content
GET
Retrieve settlement instructions

Authorizations

Authorization
string
header
required

A secret NorthFond business API key. Keep it on your server.

Path Parameters

id
string<uuid>
required

NorthFond resource identifier.

Response

Settlement returned

id
string<uuid>
required
transaction_id
string<uuid>
required
status
enum<string>
required
Available options:
awaiting_transfer,
detected,
confirmed
chain
enum<string>
required
Available options:
base,
polygon,
arbitrum,
optimism,
avalanche
asset
any
required
token_address
string
required
from_address
string
required
to_address
string
required
amount
string
required
confirmations
integer
required
required_confirmations
integer
required
expires_at
string<date-time>
required
fee_address
string | null
fee_amount
string
total_required
string
execution
object

Use direct_transfer when the fee is zero. For fee_splitter, approve the exact raw amount and submit the returned transaction.

transaction_hash
string | null
detected_at
string<date-time> | null
confirmed_at
string<date-time> | null