Skip to content
BookendBookend Docs

Stage a wire instruction

POST
/v1/loans/{ref}/wire
curl --request POST \
  --url http://localhost:8080/v1/loans/example/wire

Maker step: builds the wire from the DR&A’s wire disbursement line (amount, payee) and the LAR’s beneficiary bank details (bank, ABA, account), adds the loan reference and memo, and records it as staged with provenance for every field. The loan must be boarded or funded, or approved/boarding_staged when boarding.allow_wire_before_boarded is on. No body. Requires a signed-in admin, manager or specialist. 404 for an unknown loan, 409 when the loan state does not allow it or a wire is already staged or approved, 422 when no wire disbursement line, no LAR or incomplete bank details were extracted.

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
ref
required
string

Responses

Section titled “Responses”

201

Section titled “201”

Created

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
Examplegenerated
{
  "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"
}