Stripe
Capture Stripe Payment Intent
Capture Stripe Payment Intent.
Endpoint
Parameters
| Name | Type | Required | Note |
|---|---|---|---|
| identifieraccount · required | account | required | — |
| paymentIntentIdstring · required | string | required | Stripe Payment Intent ID returned by the corresponding lookup. |
| amountToCapturenumber · optional | number | optional | Integer amount in the currency’s smallest unit. |
| finalCaptureboolean · optional | boolean | optional | Stripe final capture. |
Response schema
{
"type": "object",
"$schema": "http://json-schema.org/draft-07/schema#",
"required": [
"data"
],
"properties": {
"data": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"url": {
"type": [
"string",
"null"
]
},
"name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"total": {
"type": "number"
},
"active": {
"type": "boolean"
},
"amount": {
"type": "number"
},
"object": {
"type": "string"
},
"status": {
"type": [
"string",
"null"
]
},
"deleted": {
"type": "boolean"
},
"invoice": {
"type": [
"string",
"null"
]
},
"product": {
"type": "string"
},
"currency": {
"type": [
"string",
"null"
]
},
"customer": {
"type": [
"string",
"null"
]
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"amount_due": {
"type": "number"
},
"amount_paid": {
"type": "number"
},
"subscription": {
"type": [
"string",
"null"
]
},
"payment_intent": {
"type": [
"string",
"null"
]
},
"amount_remaining": {
"type": "number"
}
},
"additionalProperties": true
}
},
"name": {
"type": [
"string",
"null"
]
},
"email": {
"type": [
"string",
"null"
]
},
"total": {
"type": "number"
},
"active": {
"type": "boolean"
},
"amount": {
"type": "number"
},
"object": {
"type": "string"
},
"status": {
"type": [
"string",
"null"
]
},
"deleted": {
"type": "boolean"
},
"invoice": {
"type": [
"string",
"null"
]
},
"product": {
"type": "string"
},
"currency": {
"type": [
"string",
"null"
]
},
"customer": {
"type": [
"string",
"null"
]
},
"has_more": {
"type": "boolean"
},
"metadata": {
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"amount_due": {
"type": "number"
},
"amount_paid": {
"type": "number"
},
"subscription": {
"type": [
"string",
"null"
]
},
"payment_intent": {
"type": [
"string",
"null"
]
},
"amount_remaining": {
"type": "number"
}
},
"additionalProperties": true
}
},
"additionalProperties": false
}