Get the staged wire

GET

/v1/loans/{ref}/wire

curl --request GET \
  --url http://localhost:8080/v1/loans/example/wire

Returns the latest wire instruction for the loan; amount (decimal string) and currency, every field with its source document and page, state, maker/checker ids and timestamps, export target; or 204 when no wire has been staged. Any staff role or an API key with status:read. 404 for an unknown loan.

Parameters

Path Parameters

ref

required

string

Responses

200

OK

Media typeapplication/json

object

id

required

string format: uuid

loanId

required

string format: uuid

loanRef

required

string

amount

required

string

currency

required

string

fields

required

Array<object>

One wire field with the provenance it was populated from.

object

name

required

string

value

required

string

source

required

string

documentId

required

null | string format: uuid

pageNo

required

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

state

required

string

stagedBy

required

string format: uuid

stagedAt

required

string format: date-time

approvedBy

required

null | string format: uuid

approvedAt

required

null | string format: date-time

exportedAt

required

null | string format: date-time

exportTarget

required

null | string

requiredApprovalRole

required

string

Example^generated

{
  "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "loanId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "loanRef": "example",
  "amount": "example",
  "currency": "example",
  "fields": [
    {
      "name": "example",
      "value": "example",
      "source": "example",
      "documentId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "pageNo": 1
    }
  ],
  "state": "example",
  "stagedBy": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "stagedAt": "2026-04-15T12:00:00Z",
  "approvedBy": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "approvedAt": "2026-04-15T12:00:00Z",
  "exportedAt": "2026-04-15T12:00:00Z",
  "exportTarget": "example",
  "requiredApprovalRole": "example"
}

204

No Content