POST/api/v1/transactions

Transactions

Initiate a transaction

Create a redemption or a stable-to-stable swap.

Sandbox APIhttps://sandbox-api.nuvante.io

There are only two public useCase values: redeem and swap. Burn and mint happen inside the saga. The settlement mode comes from the issuer's configuration, so you don't set it in the request. Send a unique Idempotency-Key so you can retry safely.

Parameters

Initiate a transaction parameters
FieldTypeRequiredDescription
Authorizationstring · headerYesBearer sandbox API key with `transactions:write`.
Idempotency-Keystring · headerNoAn optional unique key that makes retries with the same body safe.
useCase"redeem" | "swap" · bodyYesThe public use case.
paymentReferencestring · bodyYesYour own payment reference.
sourceobject · bodyYesThe source amount and asset, including the issuer for issued assets.
targetobject · bodyYesThe target amount and asset.

Responses

201Transaction accepted.
400Invalid request body.
409Idempotency key reused with a different body.

Request

curl --request POST \
  --url 'https://sandbox-api.nuvante.io/api/v1/transactions' \
  --header 'Authorization: Bearer nvt_sandbox_your_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: dvp-redeem-0001' \
  --data '{
  "paymentReference": "DVP-REDEEM-0001",
  "source": {
    "amount": "250000.00",
    "asset": {
      "code": "GBPC",
      "issuer": "GA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUWDA"
    }
  },
  "target": {
    "amount": "250000.00",
    "asset": {
      "code": "GBP"
    }
  },
  "useCase": "redeem"
}'

Response

{
  "data": {
    "actions": {
      "cancel": {
        "allowed": true
      },
      "override": {
        "cancel": {
          "allowed": false
        },
        "settle": {
          "allowed": false
        }
      }
    },
    "details": {
      "chain": "None",
      "rtgs": "None",
      "sagaStep": {
        "current": 3,
        "name": "Lock",
        "total": 6
      }
    },
    "id": "123e4567-e89b-42d3-a456-426614174000",
    "initiatedAt": "2026-07-30T14:00:00.000Z",
    "lifecycleStatus": "received",
    "parked": false,
    "paymentReference": "DVP-REDEEM-0001",
    "receiveAmount": "250000.00",
    "platformFeeAmount": "250.00",
    "debitAmount": "250250.00",
    "feeStatus": "pending",
    "saga": {
      "currentStepIndex": 1,
      "steps": [
        {
          "happenedAt": "2026-07-30T14:00:00.000Z",
          "name": "Received",
          "status": "done"
        },
        {
          "happenedAt": "2026-07-30T14:00:00.000Z",
          "name": "Validated",
          "status": "done"
        },
        {
          "name": "Lock",
          "status": "current"
        },
        {
          "name": "Earmarked",
          "status": "pending"
        },
        {
          "name": "Burning",
          "status": "pending"
        },
        {
          "name": "Settled",
          "status": "pending"
        }
      ]
    },
    "settlement": {
      "creditor": {
        "participantId": "223e4567-e89b-42d3-a456-426614174001",
        "participantKind": "clearing_member",
        "participantName": "Example Bank"
      },
      "debtor": {
        "participantId": "323e4567-e89b-42d3-a456-426614174002",
        "participantKind": "stablecoin_issuer",
        "participantName": "GBPC Issuer"
      }
    },
    "source": {
      "amount": {
        "amount": "250000.00",
        "asset": {
          "code": "GBPC",
          "issuer": "GA7QYNF7SOWQ3GLR2BGMZEHXAVIRZA4KVWLTJJFC7MGXUA74P7UJUWDA"
        }
      },
      "party": {
        "participantId": "223e4567-e89b-42d3-a456-426614174001",
        "participantKind": "clearing_member",
        "participantName": "Example Bank"
      }
    },
    "target": {
      "amount": {
        "amount": "250000.00",
        "asset": {
          "code": "GBP"
        }
      },
      "party": {
        "participantId": "323e4567-e89b-42d3-a456-426614174002",
        "participantKind": "stablecoin_issuer",
        "participantName": "GBPC Issuer"
      }
    },
    "terminal": false,
    "updatedAt": "2026-07-30T14:00:00.000Z"
  },
  "meta": {
    "commandId": "423e4567-e89b-42d3-a456-426614174003"
  }
}