For the complete documentation index, see llms.txt. This page is also available as Markdown.

Prepare the next repayment transaction

Refreshes current dues and returns the next unsigned transaction. This endpoint is normally called by the SDK after a TOKEN_APPROVAL transaction confirms, or to retry an expired preparation. Approval and REPAYMENT amounts use the fixed maximum established when the repayment resource was created. If fresh dues exceed that fixed maximum, Qiro fails the repayment with REPAYMENT_QUOTE_EXPIRED and the partner must create a fresh repayment.

post
Required scopes
This endpoint requires the following scopes:
  • : Create and prepare repayments.
Authorizations
OAuth2clientCredentialsRequired
Token URL:
Path parameters
repayment_idstringRequired

Stable Qiro identifier for one drawdown repayment workflow.

Example: rpy_01J5TC7H3ABMPattern: ^rpy_[A-Za-z0-9]+$
Header parameters
X-Correlation-IDstring · min: 1 · max: 128Optional

Optional end-to-end request identifier. The SDK supplies one automatically; Qiro generates and echoes one when absent.

Example: cor_repayment_123
Responses
200

Next unsigned transaction in the repayment flow.

application/json
repayment_idstringRequiredPattern: ^rpy_[A-Za-z0-9]+$
statusstring · enumRequiredPossible values:
actionstring · enumRequiredPossible values:
sequenceinteger · min: 1Required
amount_base_unitsstringRequiredPattern: ^(0|[1-9]\d*)$
maximum_repayment_base_unitsstringRequiredPattern: ^(0|[1-9]\d*)$
expires_atstring · date-timeRequired
post/v1/repayments/{repayment_id}/prepare
POST /v1/repayments/{repayment_id}/prepare HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
{
  "repayment_id": "rpy_01J5TC7H3ABM",
  "status": "SUBMITTING",
  "action": "REPAYMENT",
  "sequence": 2,
  "amount_base_units": "500440449041000000000000",
  "maximum_repayment_base_units": "500440449041000000000000",
  "expires_at": "2026-08-12T11:12:00Z",
  "transaction": {
    "chain_id": 421614,
    "to": "0x57923bc2f063a06abc88a1a1c49109191034246e",
    "data": "0x1234abcd",
    "value": "0"
  }
}

Last updated