Skip to main content
↓ Download as Markdown

External Payment Operations Endpoint

note

Information in this article is in preview status. Do not use information in this article without being in contact with Future Ordering.

This article provides an OpenAPI specification and quick reference for the External Payment API endpoint that the payment provider must expose.

OpenAPI specification​

A specification for the External Payment API is available as a downloadable JSON file:

This specification defines request schemas, response formats, and error responses.

Quick reference​

PropertyValue
MethodPOST
Content-Typeapplication/json
SecurityOAuth 2.0 bearer token
TransportHTTPS (TLS 1.2+)

The concrete endpoint URL is agreed during onboarding.

Operation payloads​

The request body uses a discriminator field named type. Future Ordering sends one of these operation payloads:

  • payment.external.transaction.registration
  • payment.external.transaction.authorization
  • payment.external.transaction.capture
  • payment.external.transaction.annulment

All requests include a transactionId. See the integration guide for details on each operation type.

Registration example​

{
    "type": "payment.external.transaction.registration",
    "merchantId": "eb621215-9ee9-4715-941c-fd6cd2235d63",
    "currency": "EUR",
    "amount": 1000,
    "revenueCenterId": "example-revenue-center-id",
    "orderId": "example-order-id",
    "customerReference": "example-customer-reference",
    "paymentMethodId": "example-payment-method-id",
    "posReferences": {
        "ExampleKeyOne": "example-value-one",
        "example_key_two": "example-value-two"
    },
    "transactionId": "6c1245b4-cdae-4110-8598-9b13a91258d5",
    "deviceId": "example-device-id"
}

posReferences is optional and normally absent. Keys are produced by the Point of Sale (POS) integration, not defined by Future Ordering, and are matched case-sensitively.

Integration details​

For comprehensive integration information including:

  • Detailed endpoint specifications
  • Request and response handling
  • Authentication and token validation
  • Idempotency requirements
  • Retry logic
  • Payment Notifications API

See External Payment Provider integration guide.