Skip to content
Developerhome

Submit and process electronic payments

  Less than to read

Through Payments Out Service, you can submit and process electronic payments. To do this, you need to implement one of these workflows:

  • fileformatId and providerId
  • subscriptionId

The workflow you choose depends on the parameters your application populates in the batches of payments.

For more information about these parameters, go to the Consumer API reference.

Batch has fileformatId and providerId populated

In this workflow, your application must create a batch of payments with the fileformatId and providerId parameters populated.

When the Consumer API receives the batch, it sends a webhook to the payment provider. The provider ID is contained in the batch, and notifies them that there’s a new batch of payments. To receive and process the webhook, the provider needs to implement a Webhook Notifications API.

The payment provider can then retrieve and process the batch. After each processing stage, they will update the batch status.

Workflow for file format ID and provider ID

Batch has subscriptionId populated

To implement this workflow, you must have a subscription to a payment provider. For more information on how to create a subscription, go to the Consumer API reference.

In this workflow, your application must create a batch of payments with the subscriptionId parameter populated.

When the Consumer API receives the batch, it sends a webhook to the payment provider. The provider is notified that a new batch has been received. To receive and process the webhook, the payment provider needs to implement a Webhook Notifications API.

The payment provider then retrieves and processes the batch. After each processing stage the payment provider updates the batch status.

When the Provider API receives the batch, it sends a webhook to the Sage application. To receive and process the webhook, the Sage application needs to implement a Webhook Notifications API.

Workflow for subscription ID