Router

Report the on-chain settlement tx for a minted payment (completes the record)

After you attached a mode-A credential and the agent settled on-chain, report the settlement txHash (from the agent’s PAYMENT-RESPONSE / X-PAYMENT-RESPONSE header) so the payment record moves Issued → Settled. Idempotent: re-reporting the same txHash is a no-op; a different txHash, or a record not in Issued, is rejected. NOT needed for mode B (/route and /proxy self-complete the record from the upstream settlement header).

post/router/payments/{id}/settled

Request

  • Base URL: https://api.sandbox.nevermined.app/api/v1
  • URL: https://api.sandbox.nevermined.app/api/v1/router/payments/{id}/settled
  • Auth: HTTP bearer

Path parameters

idstring required
Example:b1f9c2e4-3d5a-4c7e-9f21-6a8b0c4d2e13

The paymentId returned by POST /router/payments.

Request body

txHashstring required

On-chain settlement tx hash (from the upstream's PAYMENT-RESPONSE header).

Example request

{
  "txHash": "0xfc8af37baae588b5ee4a5e9212532b3d46702ac009b64c17e8ff810fd90ac493"
}

Response

The record is now Settled.

paymentIdstring required
status'Settled' required
txHashstring required

Example response

{
  "paymentId": "b1f9c2e4-3d5a-4c7e-9f21-6a8b0c4d2e13",
  "status": "Settled",
  "txHash": "0xfc8af37baae588b5ee4a5e9212532b3d46702ac009b64c17e8ff810fd90ac493"
}

Changes

No recorded changes to this operation across all 1 revision of this API.