External Settlement

The External Settlement flow makes use of the following Spark methods:

External Settlement Flow

The flow is initiated by the 3rd Party Server after the service or products have been provided to the consumer.

To understand the external settlement flow, see the diagram below:

Below is a breakdown of the diagram:

  1. The process begins with transaction initiation on the Nayax Device. The device sends an Authorization Request to the Nayax Server.
  2. The Nayax Server processes the request by performing authorization with a payment provider (an action external to the direct flow) and sends an Authorization Response back to the Nayax Device. Upon receiving this, the device is back to IDLE.
  3. The 3rd Party Server initiates communication with the Nayax Server by sending a /StartAuthentication message.
  4. The Nayax Server acknowledges the notification by responding with a Start Authentication Response to the 3rd Party Server.
  5. If Service/Product(s) are Provided: The 3rd Party Server sends an /ExternalSettlement request to the Nayax Server. Simultaneously, the Nayax Server initiates the financial finalization by performing settlement with the payment provider.
  6. The Nayax Server completes the settlement flow by sending an External Settlement Response back to the 3rd Party Server.

Alternatively:

  1. If Service/Product(s) are Not Provided: The 3rd Party Server sends an /ExternalCancel request to the Nayax Server. Simultaneously, the Nayax Server initiates the financial cancellation with the payment provider.
  2. The Nayax Server completes the cancellation flow by sending an External Cancel Response back to the 3rd Party Server.

Failure Handling

Failure TypeRecommended ActionRetry Policy
Start Authentication FailureThe Third-Party Server/Spark Provider must retry the authentication request.Not specified, typically immediate.
External Settlement FailureThe Third-Party Server/Spark Provider must retry the transaction settlement.Up to 5 retries recommended, all within 24 hours of the initial attempt.
External Cancel FailureNo action is required by the 3rd-Party Server.The Nayax Server will automatically retry the cancellation on the server side later.