POST /v1/payment_records/{id}/report_payment_attempt
Report a new payment attempt on the specified Payment Record. A new payment attempt can only be specified if all other payment attempts are canceled or failed.
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 |
|---|---|---|---|
description |
String | No |
An arbitrary string attached to the object. Often useful for displaying to users. |
failed |
Object | No |
Information about the payment attempt failure. |
failed.failed_at |
Integer | Yes | |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
guaranteed |
Object | No |
Information about the payment attempt guarantee. |
guaranteed.guaranteed_at |
Integer | Yes | |
initiated_at |
Integer | Yes |
When the reported payment was initiated. Measured in seconds since the Unix epoch. |
payment_method_details |
Object | No |
Information about the Payment Method debited for this payment. |
payment_method_details.custom |
Object | No | |
payment_method_details.custom.display_name |
String | No | |
payment_method_details.custom.type |
String | No | |
payment_method_details.type |
String | No |
Valid values:
|
payment_method_details.payment_method |
String | No | |
payment_method_details.billing_details |
Object | No | |
payment_method_details.billing_details.email |
String | No | |
payment_method_details.billing_details.name |
String | No | |
payment_method_details.billing_details.phone |
String | No | |
payment_method_details.billing_details.address |
Object | No | |
payment_method_details.billing_details.address.line2 |
String | No | |
payment_method_details.billing_details.address.line1 |
String | No | |
payment_method_details.billing_details.address.postal_code |
String | No | |
payment_method_details.billing_details.address.country |
String | No | |
payment_method_details.billing_details.address.state |
String | No | |
payment_method_details.billing_details.address.city |
String | No | |
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 |
|
outcome |
String | No |
The outcome of the reported payment. Valid values:
|
shipping_details |
Object | No |
Shipping information for this payment. |
shipping_details.name |
String | No | |
shipping_details.phone |
String | No | |
shipping_details.address |
Object | No | |
shipping_details.address.line2 |
String | No | |
shipping_details.address.line1 |
String | No | |
shipping_details.address.postal_code |
String | No | |
shipping_details.address.country |
String | No | |
shipping_details.address.state |
String | No | |
shipping_details.address.city |
String | No |
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.