POST /v1/payment_records/{id}/report_refund
Report that the most recent payment attempt on the specified Payment Record was refunded.
Servers
- https://api.stripe.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
id |
String | Yes |
The ID of the Payment Record. |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/x-www-form-urlencoded" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
refunded |
Object | Yes |
Information about the payment attempt refund. |
refunded.refunded_at |
Integer | Yes | |
amount |
Object | No |
A positive integer in the smallest currency unit representing how much of this payment to refund. Can refund only up to the remaining, unrefunded amount of the payment. |
amount.value |
Integer | Yes | |
amount.currency |
String | Yes | |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
initiated_at |
Integer | No |
When the reported refund was initiated. Measured in seconds since the Unix epoch. |
metadata |
No |
Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. Individual keys can be unset by posting an empty value to them. All keys can be unset by posting an empty value to |
|
processor_details |
Object | Yes |
Processor information for this refund. |
processor_details.custom |
Object | No | |
processor_details.custom.refund_reference |
String | Yes | |
processor_details.type |
String | Yes |
Valid values:
|
outcome |
String | Yes |
The outcome of the reported refund. Valid values:
|
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.