Fluent Commerce Logo
Docs
Sign In

Connector Contracts - Payment Capture

Interface Contract Flow

Changed on:

13 Dec 2023

Overview

Payment Capture is the flow in which some or all of the authorized funds are taken.

In many jurisdictions, this must happen at the point of shipping the product, in which case Fluent will send a webhook to the Payment Service Provider connector with details of the authorization and capture amount.

Flow

Typically, the order is placed on an e-commerce system with appropriate payment information, and the Order and authorized transaction information are passed to Fluent (see Order Connector Contract).

Once we’re ready to capture some or all of that payment, Fluent workflows will produce the “capture request” webhook for the Payment Connector.

The Payment Service Provider will then validate and process the request and respond (asynchronously) with either a “success” or “error” event.

API Details

Event Names

`fc.connect.payment.capture`

API contract

Event API

To download the payment capture connector payload schema, click here.


Interface Contract

Diagram

No alt text provided

Configuration example

1Not available

Language: json

Request Payload

Property

Description

Type

Required?

Notes






Version History

2023-08-07

v0.0.0

Initial release

Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.

Fluent Logo