Fluent Commerce Logo
Docs
Sign In

Connector Contracts - Create Order Payment

Interface Contract Flow

Changed on:

13 Dec 2023

Overview

Payment transactions reflect when and how a customer has paid for an order. Multiple (split) payments are supported and custom business logic can be applied on the Fluent side, to identify when an order has been fully paid.

Considerations for the payment workflow:

  • The workflow needs to reflect the business model on when to capture the payment: at order placement, or at fulfilment.
  • Create order payment should simply track the payment details against the order placed, nothing more.
  • All available payment transactions (authorisation and/or capture) should be pushed to Fluent.
  • These transactions can be used to issue refunds on returns or cancellations.
  • Payment pre-authorisations usually only hold for 5-7 days. The workflow should expect it to fail when capturing at fulfilment time for delayed orders.
  • Pre-orders will need a different flow, as capturing at fulfilment time will most likely be outside the 5-7 window.

API Details

Event Names

  • `fc.connect.order.transaction.add`

API contract

To download the add payment transaction 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

First 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