transaction

Process a payout

Changed on Nov 7, 2026

post/transaction/{apiKey}/payout

Request

Base URL
https://gateway.tillpayments.com/api/v3
Auth
HTTP basic
TypeScript
https://skmtc.dev/tillpayments/apis/till-payments-gateway/docs/transaction/:apiKey/payout/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

apiKeystring required

API Key of Connector

Request body

merchantTransactionIdstring required

additionalId1string

additionalId2string

referenceSchemeLifecycleIdentifierstring

extraDataExtraData

pspPassthroughDataPspPassthroughData

merchantMetaDatastring

referenceUuidstring

amountstring required

currencystring required

successUrlstring

cancelUrlstring

errorUrlstring

callbackUrlstring

transactionTokenstring

descriptionstring

languagestring

includeTracingboolean

allowUnlinkedRefundboolean

When true, the payout is treated as an unlinked refund (a credit not tied to a prior debit transaction). Supported by select connectors only. Available on: Axepta, CheckoutCom, StripeExtended, WorldLine.

Response

Transaction response

successboolean

uuidstring

purchaseIdstring

redirectType'iframe' | 'fullpage' | '3ds'

redirectUrlstring

redirectQRCodestring

DataUrl

htmlContentstring

paymentDescriptorstring

paymentMethodstring

adapterMerchantTransactionIdstring

Adapter/PSP-side merchant transaction identifier recorded for transaction matching and reconciliation. Omitted when unavailable.

amountstring

surchargeAmountstring

gstAmountstring

totalAmountstring

adapterMessagestring

adapterCodestring

extraDataExtraData

Example response

{
  "returnData": {
    "cardUpdatedAt": "2024-05-07 00:00:00",
    "cardUpdatePausedUntil": "2024-05-07"
  }
}

Changes

Nov 7, 202642c40d316a83 Revision changes
- info
  added the new optional request property
- info
  added the new optional request property
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property / to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property to the response with the status
- info
  added the optional property to the response with the status
Apr 27, 20255d765c6bfe90 Revision changes
- info
  added the new optional request property
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status
- info
  added the optional property ///// to the response with the status

Operation history (3 revisions)