Skip to main content

Integration options

Management your payment configuration​

The payment configuration, including providers, methods, payments and orders, can be done using our dcloud CLI tool. The configuration process is described in the Configuration section. dcloud interacts with the management endpoints of Payment Orchestrator.

Payment Orchestrator interactions with your Deity app​

Interacting with Payment Orchestrator is done through our @deity/falcon-payment-service-module package. This package interacts with Payment Orchestrator in two ways:

  • Through the REST API client endpoints
  • By listening for events on the RabbitMQ instance
Want to integrate Payment Orchestrator yourself?

If you're creating a custom integration or want more details on how Falcon Platform interacts with Payment Orchestrator, please check out our how to guide.

REST Endpoints​

Our @deity/falcon-payment-service-module package interacts with Payment Orchestrator using our four client endpoints. The API Reference for the client endpoints can be found here →.

loadMethodList

This method is used to get a list of available payment methods based on an order payload.

loadMethod

This method returns a single payment method, often with additional configuration needed to render client side components.

validate

The validate method is/should be triggered by the shop element that places an order (e.g. a 'Place Order' button). If validation is successful, it results in an order being created in the shop and the payment provider.

sendOrderUpdate

This method is used for order updates from the shop, e.g. refunds or shipments. The flow is as follows:

  1. Shop update (webhook)
  2. Falcon shop endpoint package
  3. Falcon shop API package
  4. Falcon Payment Service Client
  5. Payment Orchestrator (message queue)
  6. Payment provider (REST API)

Events​

@deity/falcon-payment-service-module also emits an event based on updates pushed to Payment Orchestrator. This event is for payment updates.

PaymentEvents.PAYMENT_STATUS_UPDATED

The payload associated with this event is:

{
  "orderId": "string", // The shop order ID associated with the payment update
  "status": "string", // payment status
  "payload": {} // This additional data is dependent on the payment provider, it often contains a payment ID
};