Transactions

Generate new transaction

Creates a new transaction with QR code or barcode for payment processing. The same path with a multipart/form-data body is soundbite recognition (an audio fingerprint), answered only at https://soundbite.payware.eu (sandbox: https://soundbite-sandbox.payware.eu); api.payware.eu and sandbox.payware.eu refuse it with 421 ERR_SOUNDBITE_HOST.

post/api/transactions

Request

  • Base URL: https://api.payware.eu
  • URL: https://api.payware.eu/api/transactions
  • Auth: HTTP bearer

Headers

Soundbite-Sessionstring

Optional: one random UUID per tap, the same on every query of that tap, so its answers keep one id. Ignored when malformed

Idempotency-Keystring

Optional. A key of your choosing, unique per request (a UUID is typical), 1-255 printable ASCII characters without spaces. A retry with the same key and the same body, within 24 hours, gets the first call's response back with the header Idempotent-Replayed: true instead of creating a second transaction. The same key with a different body answers 422 ERR_IDEMPOTENCY_KEY_REUSED; a retry while the first call is still running answers 409 ERR_IDEMPOTENCY_KEY_IN_PROGRESS. Only successful responses are kept, so a call that failed can be retried with the same key.

Request body

shippableboolean
rolestring
paymentMethod'A2A' | 'CARD_FUNDED' | 'BNPL' | 'INSTANT_CREDIT'

Payment method chosen by customer. Used by banks when processing transactions. A2A = direct transfer (lower fee, no rewards). CARD_FUNDED = card-linked account (higher fee, rewards eligible). BNPL = buy now pay later (installments). INSTANT_CREDIT = credit line approved at purchase.

producerPartnerIdstring

partnerId of the POS terminal producer whose terminal produced this transaction. Must be a partner registered with payware and flagged as a producer; an unrecognised value is rejected. Determines the producer's revenue share and does NOT affect what the merchant is charged, which always follows the fee hierarchy. Omit it entirely when there is no producer. Not returned in any response.

terminalIdstring

Opaque identifier of the physical terminal, scoped to the producer's own estate. payware assumes no format and enforces no uniqueness; it is recorded for provenance and never affects attribution or pricing.

terminalManufacturerstring

Device manufacturer as reported by the terminal. Recorded for provenance; a mismatch against the expected producer is surfaced in settlement review, never blocked.

shopstring
skipImageGenerationboolean
accountstring
friendlyNamestring
callbackUrlstring
passbackParamsstring
vloginIdstring

Response

Transaction created successfully. A replay of an earlier call with the same Idempotency-Key carries the header Idempotent-Replayed: true.

OR

Example response

{
  "recognition": {
    "id": "3f2b8c1e-6a4d-4e2f-9b1a-5c7d8e9f0a1b"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.