Skip to main content
POST
Node.js SDK

Authorizations

Authorization
string
header
required

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

idempotency-key
string
Required string length: 1 - 255

Path Parameters

id
string
required
Required string length: 1 - 64
paymentId
string
required
Required string length: 1 - 64

Body

application/json
reason
enum<string>
required
Available options:
UNDERPAYMENT,
OVERPAYMENT,
WRONG_ASSET,
EXPIRED_INTENT,
DUPLICATE_PAYMENT,
SETTLEMENT_FAILED,
ROUTE_REMAINDER,
ROUTE_SURPLUS,
MANUAL
destination_address
string
Required string length: 1 - 128
destination_memo
object

Response

Default Response

id
string
required
object
enum<string>
required
Available options:
refund
funding_intent_id
string
required
payment_id
string
required
application_id
string
required
asset
string
required
amount
string
required
destination
object
required
reason
enum<string>
required
Available options:
UNDERPAYMENT,
OVERPAYMENT,
WRONG_ASSET,
EXPIRED_INTENT,
DUPLICATE_PAYMENT,
SETTLEMENT_FAILED,
ROUTE_REMAINDER,
ROUTE_SURPLUS,
MANUAL
status
enum<string>
required
Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
transaction_hash
string | null
required
failure
object | null
required
created_at
string
required
completed_at
string | null
required