/v1/capture

post

https://api-sandbox.flexfactor.io/v1/capture

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

idempotencyKey

uuid | null

Optional but recommended GUID. A double capture is always prevented on (orderId, amount, currency); reusing the key on a retry also replays the original response and surfaces a reused-key conflict as 409.

orderId

uuid

required

The FlexFactor orderId returned by /evaluate.

amount

int32

required

Amount to capture, in cents.

currency

string

required

length ≥ 1

ISO 4217 currency code.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

content-type

string

enum

Defaults to application/json

Generated from available request content types

Allowed:

Responses

401

Unauthorized

500

Server Error

Language

Credentials

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

application/json

text/json

200Success

400Bad Request. The request failed validation; the body names the fields in error.

404Not Found

409Conflict. An idempotent request with the same key is still in progress, or the idempotency key was reused with a materially different payload.

503Service Unavailable. The duplicate-request check is temporarily unavailable; honor the Retry-After header and retry.