POST /v1/payment_records/report_payment
Report a new Payment Record. You may report a Payment Record as it is initialized and later report updates through the other report_* methods, or report Payment Records in a terminal state directly, through this method.
Servers
- https://api.stripe.com/
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 | |
customer_details |
Object | No |
Customer information for this payment. |
customer_details.customer |
String | No | |
customer_details.email |
String | No | |
customer_details.name |
String | No | |
customer_details.phone |
String | No | |
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 | |
payment_method_details |
Object | Yes |
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 |
|
processor_details |
Object | No |
Processor information for this payment. |
processor_details.custom |
Object | No | |
processor_details.custom.payment_reference |
String | Yes | |
processor_details.type |
String | Yes |
Valid values:
|
customer_presence |
String | No |
Indicates whether the customer was present in your checkout flow during this payment. Valid values:
|
outcome |
String | No |
The outcome of the reported payment. Valid values:
|
amount_requested |
Object | Yes |
The amount you initially requested for this payment. |
amount_requested.value |
Integer | Yes | |
amount_requested.currency |
String | Yes | |
initiated_at |
Integer | Yes |
When the reported payment was initiated. Measured in seconds since the Unix epoch. |
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.