Skip to navigation
API Reference

Capture Payment Intent

Authentication

AuthorizationBasic

Standard Basic HTTP authentication. The username is the Fluveo secret key and the password must be empty, encoded as base64(api_key:).

OR
AuthorizationBearer

Bearer HTTP authentication. Allowed header: Authorization: Bearer <api_key>.

Path parameters

intentstringRequired

Headers

Idempotency-KeystringOptional1-255 characters

Makes a POST safely retryable according to that operation’s documented idempotency policy. The durable 24-hour journal applies only where the resource documentation explicitly claims it. Reusing a key with different parameters or another endpoint returns an idempotency error.

Request

This endpoint expects an object.
amount_to_captureintegerOptional
metadatamap from strings to stringsOptional

Stripe-compatible public metadata: at most 50 merchant-visible entries, with keys up to 40 characters and string values up to 500 characters. Server-owned fluveo_ stamps are not part of the public allowance and are never returned.

statement_descriptor_suffixstringOptional

Refused on capture with a 400 naming this parameter: no Fluveo capture connector sends a descriptor, so it would be dropped. Set it when you create or update the PaymentIntent.

Response

Stripe-compatible response

amountinteger
amount_capturableinteger
amount_receivedinteger
applicationstring or null<=5000 characters
application_fee_amountinteger or null
automatic_payment_methodsobject or null
canceled_atinteger or null
cancellation_reasonenum or null
capture_methodenum
Allowed values:
client_secretstring or null<=5000 characters
confirmation_methodenum
Allowed values:
createdinteger
currencystringformat: "currency"
customerobject or string or null
customer_accountstring or null<=5000 characters
descriptionstring or null<=5000 characters
excluded_payment_method_typeslist of enums or null
idstringformat: "^pi_.+"<=5000 characters

Fluveo narrowing: not in upstream pin; truthful public id-prefix constraint: pi_.

last_payment_errorobject or null
latest_chargeobject or string or null
livemodeboolean
managed_paymentsobject or null
metadatamap from strings to strings
next_actionobject or null

Test-mode redirect action. redirect_to_url.url sends the customer to authenticate; after completion the customer is redirected to redirect_to_url.return_url.

objectenum

Fluveo narrowing annotation: truthful single-value public object constant.

Allowed values:
on_behalf_ofstring or null<=5000 characters
payment_methodobject or string or null
payment_method_configuration_detailsobject or null
payment_method_optionsobject or null
payment_method_typeslist of strings
processingobject or null
receipt_emailstring or null<=5000 characters
reviewstring or null<=5000 characters
setup_future_usageenum or null
Allowed values:
shippingobject or null
sourcestring or null<=5000 characters
statement_descriptorstring or null<=5000 characters
statement_descriptor_suffixstring or null<=5000 characters
statusenum
transfer_groupstring or null<=5000 characters
amount_detailsobjectOptional
hooksobjectOptional
payment_detailsobjectOptional
presentment_detailsobjectOptional
transfer_dataobject or nullOptional