Create position return

POST

/positions/{position_id}/returns

Initiate an asynchronous borrower return saga for a position.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

Created

Headers

Bodyapplication/json

🟠400

🟠401

🟠403

🟠409

🟠429

🔴500

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://tokenet-ng-api.digitalprimetechnologies.co/positions/7c9e6679-7425-40de-944b-e07fc1f90ae7/returns' \
--header 'Content-Type: application/json' \
--data '{
    "quantity": "1.25"
}'

Response Example

201 - Success

{
    "return": {
        "asset": "BTC",
        "asset_price_usd": "50000.00",
        "asset_transfer_status": "PENDING",
        "borrower_organization_id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "collateral_asset": "USDC",
        "collateral_price_usd": "1.00",
        "collateral_release_quantity": "12500.00",
        "collateral_release_status": "PENDING",
        "contract_id": "550e8400-e29b-41d4-a716-446655440000",
        "correlation_id": "0f8fad5b-d9cb-469f-a165-70867728950f",
        "create_time": "2026-03-03T12:00:00Z",
        "current_step": "VALIDATE_ASSET",
        "id": "0f8fad5b-d9cb-469f-a165-70867728950e",
        "lender_organization_id": "6ba7b811-9dad-11d1-80b4-00c04fd430c8",
        "position_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
        "position_update_status": "PENDING",
        "principal_repayment_fraction": "0.250000000000000000",
        "quantity": "0.25",
        "return_type": "PARTIAL",
        "status": "INITIATED",
        "update_time": "2026-03-03T12:00:00Z"
    }
}

Modified at 2026-06-16 11:15:56

Get position

Complete return asset transfer