transaction

Process a payout

post/transaction/{apiKey}/payout

Request

Base URL
https://secure.tillpayments.com/api/v3
Auth
HTTP basic
TypeScript
https://skmtc.dev/tillpayments/apis/tillpayments-com-payment-platform/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

extraDataExtraData

pspPassthroughDataPspPassthroughData

merchantMetaDatastring

referenceUuidstring

amountstring required

currencystring required

successUrlstring

cancelUrlstring

errorUrlstring

callbackUrlstring

transactionTokenstring

descriptionstring

languagestring

publicDataPublicData (unresolved $ref)

includeTracingboolean

allowUnlinkedRefundboolean

When true, processes this payout as an unlinked (unreferenced) refund instead of a standard payout. No reference to an original transaction is required. Available on: Axepta, CheckoutCom, StripeExtended, WorldLine.

Response

Transaction response

successboolean

uuidstring

purchaseIdstring

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

redirectUrlstring

redirectQRCodestring

DataUrl

htmlContentstring

paymentDescriptorstring

paymentMethodstring

adapterMessagestring

adapterCodestring