Refund to balance

Initiates a refund for a use balance transaction. Partial refunds are supported, and the same use balance transaction can have multiple refunds associated. The sum of all refunds must be less than or equal to the original transaction. Refunded amounts are returned to the customer's balance.


Authorization Scope

Only the merchant secret key is authorized to call this endpoint.

Body Params
string
required

The id of the use balance transaction to be refunded.

int64

The amount to refund into the customer's balance. Partial refunds are supported. If this value is not set, the full remaining amount of the target transaction will be refunded.

string

Optional descriptor for the refund.

json

JSON object of string key-value pairs that you can attach to the created refund.

additionalInfo
object

Additional structured information about this transaction. Does not impact transaction behavior

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json