Skip to main content
POST
Claim Unsolicited Refund

Authorizations

x-auth-token
string
header
required

The API token for login provided by UQPay.

Headers

x-on-behalf-of
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 endpoint. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-key
string<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.

Body

application/json

The original authorization's transaction identifier that the unsolicited refund is matched against. Use the authorization's transaction_id, not its short_reference_id.

Example:

"c0cef051-29c5-4796-b86a-cd5b684bfad7"

remark
string

Optional note describing the claim, stored with the request.

Example:

"claim unsolicited refund"

Response

200 - application/json

OK - The claim was accepted for asynchronous processing.

request_status
enum<string>

Request status.

Available options:
SUCCESS