4. Registered Member's IBAN

You can send money to your registered sub-merchant accounts (Members) in PayWall using their merchant identification information (MemberId).

To the registered Member IBAN

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

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

Important: In order to use the Payout - Registered Member 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).

MemberId

int

Yes

Sub-member identification information registered in Paywall. Returned in the response during registration with Paywall.

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

{
    "PayoutProviderKey": "ProviderKey",
    "MerchantUniqueCode": "42222",
    "MemberId": 209021,
    "Description": "test açıklaması",
    "Amount": 1,
    "CurrencyId": 1
}

Response returned from the service:

Parameter
Type
Explanation

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.

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

Last updated