Payout Request

This feature is only available if your acquiring bank or payment method supports outbound transactions.

Supported Payout Type

Request Type	Description
`CardPayoutRequest`	Send funds to a customer’s credit or debit card.

Example: Card Payout Request

<SinglePayoutRequest>
  <CardPayoutRequest>
    <Account>
      <PayGateId>10011013800</PayGateId>
      <Password>test</Password>
    </Account>
    <Customer>
      <FirstName>Joe</FirstName>
      <LastName>Soap</LastName>
      <Email>[email protected]</Email>
    </Customer>
    <CardNumber>4000000000000002</CardNumber>
    <CardExpiryDate>052015</CardExpiryDate>
    <Order>
      <MerchantOrderId>order-1234</MerchantOrderId>
      <Currency>ZAR</Currency>
      <Amount>100</Amount>
    </Order>
  </CardPayoutRequest>
</SinglePayoutRequest>

Example: Card Payout Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/">
	<SOAP-ENV:Header/>
	<SOAP-ENV:Body>
		<ns2:SinglePayoutResponse xmlns:ns2="http://www.paygate.co.za/PayHOST">
			<ns2:CardPayoutResponse>
				<ns2:Status>
					<ns2:TransactionId>1036203748</ns2:TransactionId>
					<ns2:Reference>order-1234</ns2:Reference>
					<ns2:StatusName>Completed</ns2:StatusName>
					<ns2:PayRequestId>E0CAAB06-B555-41D0-8E8F-F025C83F1745</ns2:PayRequestId>
					<ns2:TransactionStatusCode>0</ns2:TransactionStatusCode>
					<ns2:TransactionStatusDescription>Not Done</ns2:TransactionStatusDescription>
					<ns2:ResultCode>990006</ns2:ResultCode>
					<ns2:ResultDescription>Request for Payout Received</ns2:ResultDescription>
					<ns2:Currency>ZAR</ns2:Currency>
					<ns2:Amount>100</ns2:Amount>
					<ns2:PaymentType>
						<ns2:Method>CC</ns2:Method>
						<ns2:Detail>Visa</ns2:Detail>
					</ns2:PaymentType>
					<ns2:DateTime>2025-06-20T08:38:49.540+02:00</ns2:DateTime>
				</ns2:Status>
			</ns2:CardPayoutResponse>
		</ns2:SinglePayoutResponse>
	</SOAP-ENV:Body>
</SOAP-ENV:Envelope>

📘
A successful response means the request was accepted, not necessarily processed immediately. You should monitor final status via the Query API.

Request Field Reference

Field	Description	Type	Required
`Account`	PayGate credentials (ID and Password).	PayGateAccountType	✅
`Customer`	The customer receiving the payout.	PersonType	✅
`CardNumber`	Target card number to receive funds.	Number(19)	✅
`CardExpiryDate`	Format: MMYYYY (e.g. `052025` = May 2025).	Number(6)	✅
`Order`	Unique reference, amount, and currency for the transaction.	OrderType	✅

Response Field Reference

Field	Description	Type
Status	The system will return a full transaction detail response.	StatusType

Notes & Best Practices

The payout flow is one-way — funds go to the cardholder.
Ensure the card supports refunds or push payments.
Some acquirers require KYC checks before enabling this feature.
Monitor your payout logs and responses regularly for reconciliation.