API reference

Register a merchant-signed refund transaction

Register a merchant-signed StableOps refund transaction hash so the platform can verify finality, source and destination addresses, asset, and exact amount.

POST/v1/refunds/{id}/submit

Authorization

bearerAuth

AuthorizationBearer <token>

Paste your API key from the dashboard.

In: header

Path Parameters

id*string

Refund id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

tx_hash*string

Response Body

`application/json`

curl -X POST "https://example.com/v1/refunds/string/submit" \  -H "Content-Type: application/json" \  -d '{    "tx_hash": "string"  }'

{
  "id": "string",
  "payment_order_id": "string",
  "source_payment_event_id": "string",
  "chain": "ethereum",
  "asset": "USDC",
  "amount": "string",
  "amount_minor": "string",
  "source_address": "string",
  "destination_address": "string",
  "status": "requested",
  "tx_hash": "string",
  "failure_reason": "string",
  "submitted_at": "2019-08-24T14:15:22Z",
  "confirmed_at": "2019-08-24T14:15:22Z",
  "canceled_at": "2019-08-24T14:15:22Z",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z"
}

How is this guide?

Last updated

Retrieve a refund GET

Retrieve a StableOps refund by ID, including its source payment, chain, asset, amount, destination, transaction hash, status, timestamps, and failure reason.

Cancel an unsubmitted refund request POST

Cancel a StableOps refund request before a transaction is submitted, preserving the original payment and returning the amount to the order refund capacity.