API Reference

Create refund

post
https://api.synapto.construction/v1/accounts/*/refunds

Required capability: payments

Body Params
string

Name of the charge to be refunded.

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

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.

string
enum
  • FRAUD: The transaction is suspected to be fraudulent by the merchant.
  • CUSTOMER_REQUEST: The customer requested the refund.
Allowed:
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

Updated about 1 month ago

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

Updated about 1 month ago