v1

latestOpenAPI 3.1.02026-07-2685154311.7 KB
Transfers

Settle a transfer

Settles a transfer by providing settlement transaction details. This endpoint accepts optional settlement ID, settlement ID index, and revert settlement ID.

post/entities/{entityDID}/tx/{transferId}/settle

Path parameters

entityDIDstring did required

Decentralized Identifier (DID)

Example:did:web:vasps.id:jxnl0411:at

The DID of the entity

transferIdstring uuid required
Example:01f09c55-9de0-42c5-874f-237dcb51fd9f

The transfer ID

Request body

settlementIdstring
settlementIdIndexstring
revertSettlementIdstring

Example request

{
  "settlementId": "eip155:1:tx/0x1234567890abcdef"
}

Response

Transfer settlement accepted

messagestring

Example response

{
  "message": "Transfer settlement accepted"
}