Skip to content
Purser

Confirm Transfer

POST
/matching/confirm-transfer
curl --request POST \
  --url https://example.com/matching/confirm-transfer \
  --header 'Content-Type: application/json' \
  --data '{ "incoming_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "outgoing_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "remainder_category": "example" }'

Merge a one-sided pair into ONE transfer (write scope). With remainder_category it is a split loan payment: exact cash and principal legs plus one interest/fee posting; the response then also carries remainder and remainder_category. An ordinary confirm also proposes a payee-scoped transfer_link rule in the suggestions inbox (never active until accepted and its link count confirmed); the response then carries that suggestion’s suggestion_id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
ConfirmTransferRequest
object
incoming_id
required
Incoming Id
string format: uuid
outgoing_id
required
Outgoing Id
string format: uuid
remainder_category
Any of:
string

Example generated

{
  "incoming_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "outgoing_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "remainder_category": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
Response Confirm Transfer Matching Confirm Transfer Post
object
key
additional properties
string

Example generated

{
  "additionalProperty": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string

Example generated

{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}