Refunds
Request a refund of a payment that did not satisfy the intent
Records a refund for whatever of the payment has not already been refunded, paid out by a worker from the deposit account that received it. The destination defaults to the payer’s account. One refund can be in progress per payment (409 while one is), and a payment that has been refunded in full is refused (422). An optional Idempotency-Key replays the original result.
POST
Node.js SDK
Authorizations
Application API authentication for developer backends: Authorization: Bearer ur_test_... or ur_live_.... Resolves the application, its environment and the key's status. Never a dashboard login.
Headers
Required string length:
1 - 255Path Parameters
Required string length:
1 - 64Required string length:
1 - 64Body
application/json
Response
Default Response
Available options:
refund Available options:
UNDERPAYMENT, OVERPAYMENT, WRONG_ASSET, EXPIRED_INTENT, DUPLICATE_PAYMENT, SETTLEMENT_FAILED, ROUTE_REMAINDER, ROUTE_SURPLUS, MANUAL Available options:
PENDING, PROCESSING, COMPLETED, FAILED