Create refund

post

https://api.synaptopay-sandbox.com/v1/accounts/*/refunds

Required capability: payments. Tap to Pay currently supports only full cancellation-backed refunds, subject to provider acceptance. A PENDING response is not proof of reversal; track GetRefund or refund.updated events. REQUIRES_ACTION with an unknown cancellation outcome requires Synapto support and retains the reserved amount.

Body Params

charge

string

Name of the charge to be refunded. Tap to Pay supports full cancellation-backed refunds only, subject to
provider acceptance. The purchase must be completed; verified provider completion may reconcile a delayed
local result. The response may be PENDING: track progress through GetRefund or refund.updated events.

Example: "accounts/acct_RwDJsJd8z0exhtfX2570Q/charges/ch_iWPEzBE2xMAEuW1a5TOe8".

amount

string

The amount to be refunded in minor units, always to be interpreted in the currency of the charge above.
When set to zero, the remaining un-refunded amount of the charge is refunded.
Tap to Pay requires that the entire original amount remains available. Partial amounts or a conflicting
money return are rejected, never expanded to full cancellation. Repeated full requests return the existing
pending, support-required, or successful reversal instead of initiating another cancellation.

reason

string

enum

FRAUD: The transaction is suspected to be fraudulent by the merchant.
CUSTOMER_REQUEST: The customer requested the refund.

Allowed:

description

string

Description of the refund, internal use only.

metadata

object

Client supplied metadata. At most 50 keys with a max length of 40 characters are permitted. Values may be strings up to 500 characters each.

Response

200A successful response.