Skip to main content

Refund Payment

Authentication: Bearer token required.

Endpoint: POST /api/v1/payments/{id}/refund

Queues a blockchain refund (refund on the payment facet) with custodial approval for the paid token amount plus refund commission where applicable. The integration's node must have access to the payment's node.


Preconditions

  • Payment payment_method must be web3.
  • Payment status must be blockchain_distributed (deposit on-chain and distribute / reconciliation completed). Otherwise the consumer skips processing.

Request body

Empty JSON object {} is accepted (path id identifies the payment).


Response — 202 Accepted

{ "status": "accepted" }
StatusDescription
403Insufficient permission to access payment's node
404Payment not found

Processing is asynchronous; follow payment status and payment logs. If a webhook is configured for the payment's wallet and network, the platform may notify your success_path / error_path when custody completes or fails — see Webhooks — merchant payment callbacks.