3. Iban

You can authorize Paywall to process your PayOut transactions using your own access credentials through the PayOut providers supported by Paywall.

Iban

POST {{Base Address}}/api/paywall/payout/send/iban

Sending a request to the provided address will be sufficient. You can use the 'Base Address' as you wish for both the testing and production environments.

Important: In order to use the Payout - Iban service, you need to send the 'apikeyprivate' and 'apiclientprivate' parameters in the 'Header' field.

PaymentAPI Address

Parameter	Type	Compulsory	Description
apikeyprivate	string	Yes	The Private Key obtained from the merchant panel.
apiclientprivate	string	Yes	The Private Client obtained from the merchant panel.

The parameters that need to be sent to the service are as follows:

Parameter	Type	Compulsory	Description
PayoutProviderKey	string	Yes	The key term for the PayOut provider in Paywall.
MerchantGroupCode	string	No	This is the group code you will define for tracking the PayOut transaction. With the relevant code, you can assign the same group code to your transfers under a specific transaction and report them.
MerchantUniqueCode	string	Yes	The unique code you will define for tracking the PayOut transaction (you cannot use the same codes within the same month).
ReceiverTitle	string	Yes	Recipient name or company name
ReceiverIban	string	Yes	Recipient IBAN
ReceiverIdentity	string	Yes/No	Recipient identification information (TCKN - Turkish Citizen ID or VKN - Tax Identification Number).
Description	string	Yes	Description to be communicated to the recipient for PayOut.
Amount	decimal	Yes	PayOut amount
CurrencyId	int	Yes	Currency See: Currency list
CallbackSupport	bool	No	Should feedback be provided in case of asynchronous failure or refund of the PayOut transaction?
CallbackAddress	string	Yes (Conditional)	Address to which feedback will be sent

Json

{
    "PayoutProviderKey": "ProviderKey",
    "MerchantUniqueCode": "ASDJHISOFIFJDJAJF23423",
    "ReceiverTitle": "Receiver Title",
    "ReceiverIban": "TR370006400000293847574839",
    "ReceiverIdentity": "11111111110",
    "Description": "Description",
    "Amount": 10,
    "CurrencyId": 1
}

C#

// Soon

GO

// Soon

Java

// Soon

PHP

// Soon

Python

// Soon

Ruby

// Soon

TypeScript

// Soon

Curl

// Soon

Response returned from the service:

Parameter	Type	Description
Body	object	Optional JSON containing details about the payment.
ErrorCode	int	Error code. Returns '0' if the transaction is successful.
Result	bool	Returns a value of 'true' or 'false'. Returns 'true' if the transaction is successful.
Message	string	If the transaction fails, this is the message specified for the error, providing language support according to the locale parameter.

JSON

{
    "ErrorCode": 0,
    "Result": true,
    "Message": "",
    "Body": {
        "Result": true,
        "PayoutTransactionId": 53,
        "MerchantUniqueCode": "123123s1a2da3",
        "UniqueCode": "db1780b8-682d-4274-a519-5b52a4988e51",
        "Amount": 0.1
    }
}