POST /v1/sources/{source}
Updates the specified source by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
This request accepts the metadata and owner as arguments. It is also possible to update type specific information for selected payment methods. Please refer to our payment method guides for more detail.
Servers
- https://api.stripe.com/
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
source |
String | Yes |
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 |
|---|---|---|---|
amount |
Integer | No |
Amount associated with the source. |
expand[] |
Array | No |
Specifies which fields in the response should be expanded. |
mandate |
Object | No |
Information about a mandate possibility attached to a source object (generally for bank debits) as well as its acceptance status. |
mandate.interval |
String | No |
Possible values:
|
mandate.amount |
No | ||
mandate.notification_method |
String | No |
Possible values:
|
mandate.currency |
String | No | |
mandate.acceptance |
Object | No | |
mandate.acceptance.online |
Object | No | |
mandate.acceptance.online.user_agent |
String | No | |
mandate.acceptance.online.ip |
String | No | |
mandate.acceptance.online.date |
Integer | No | |
mandate.acceptance.type |
String | No |
Possible values:
|
mandate.acceptance.user_agent |
String | No | |
mandate.acceptance.offline |
Object | No | |
mandate.acceptance.offline.contact_email |
String | Yes | |
mandate.acceptance.status |
String | Yes |
Possible values:
|
mandate.acceptance.ip |
String | No | |
mandate.acceptance.date |
Integer | No | |
source_order |
Object | No |
Information about the items and shipping associated with the source. Required for transactional credit (for example Klarna) sources before you can charge it. |
source_order.items[] |
Array | No | |
source_order.items[].description |
String | No | |
source_order.items[].parent |
String | No | |
source_order.items[].amount |
Integer | No | |
source_order.items[].quantity |
Integer | No | |
source_order.items[].type |
String | No |
Possible values:
|
source_order.items[].currency |
String | No | |
source_order.shipping |
Object | No | |
source_order.shipping.name |
String | No | |
source_order.shipping.carrier |
String | No | |
source_order.shipping.phone |
String | No | |
source_order.shipping.address |
Object | Yes | |
source_order.shipping.address.line2 |
String | No | |
source_order.shipping.address.line1 |
String | Yes | |
source_order.shipping.address.postal_code |
String | No | |
source_order.shipping.address.country |
String | No | |
source_order.shipping.address.state |
String | No | |
source_order.shipping.address.city |
String | No | |
source_order.shipping.tracking_number |
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 |
|
owner |
Object | No |
Information about the owner of the payment instrument that may be used or required by particular source types. |
owner.email |
String | No | |
owner.name |
String | No | |
owner.phone |
String | No | |
owner.address |
Object | No | |
owner.address.line2 |
String | No | |
owner.address.line1 |
String | No | |
owner.address.postal_code |
String | No | |
owner.address.country |
String | No | |
owner.address.state |
String | No | |
owner.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.