API Reference

Create a Refund.

post
https://api.stage.payouts.com/refund/create

Required permissions for this API:

  • WRITE:FINANCE
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
number

Amount of the Refund. If not specified, amount will be same as PaymentAttempt.

metadata
object

A set of key-value pairs that you can attach to the Refund.

string

ID of PaymentAttempt on which the Refund is created. If not specified, create Refund on PaymentIntent.

string

ID of PaymentIntent on which the Refund is created. If not specified and ID of PaymentAttempt is specified, create Refund on PaymentAttempt.

string

Reason of the Refund.

string
required

Client-generated idempotency key. Must be unique per request attempt. Conversion requests with the same request_id will be rejected. Parameter supports a maximum of 64 characters.

Responses

Updated about 1 year ago

Did this page help you?
Language
Credentials
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago

Did this page help you?