API Reference

Reverse Payment Item

post
https://{env}.gsg.tech/api/v1/pay/payments//items//reversal

Allows the reversal or void of the full or partial amount charged against a particular item on a payment. Item-level reversals support partial reversals by specifying an amount in the request body. When the amount field is omitted, the full remaining balance of the item is reversed. When provided, only the specified amount is reversed, allowing for partial item reversals.

Path Params
string
required

Unique PaymentExpress receipt number about which to request details.

string
required

Unique identifier provided by the client for an item attached to the confirmation when the payment was made.

Body Params
string

Optional amount to reverse from this item. If omitted, the full remaining balance of the item will be reversed. If provided, only the specified amount will be reversed, enabling partial reversals at the item level.

Responses

Updated 4 months ago

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

Updated 4 months ago