GuidesAPI ReferenceChangelog
Log In
API Reference

Create a refund

post
https://api-sandbox.uqpaytech.com/api/v2/payment/refunds

Create a refund for a completed payment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The ID of the payment intent to refund

string

The ID of the payment attempt to refund

string
required

The amount to refund

string
required
length ≤ 100

The reason for the refund

metadata
object

Additional metadata for the refund

Headers
string
required

The API client id generated by UQPAY

string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

uuid
required

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

Responses

Updated about 1 year ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago