Create payout with wallet token

post

https://gw.banxispay.com/direct/wallet-token

Provide either customer_token or customer_data. If both are supplied, customer_token takes precedence and customer_data is ignored. With customer_data, the customer is resolved using the brand and cid, then created or updated according to existing customer update and profile policies. Omitted optional fields follow those policies.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

customer_token

string

required

length ≤ 32

HASH value of customer's identity.

Note: Either customer_token or customer_data must be provided. If both are missing, the request will trigger a validation error.

merchant_id

string

required

length ≤ 50

Merchant API client account identifier.

application_key

string

required

length ≤ 32

Identifier of your application (website).

version

string

required

length ≤ 3

API version.

timestamp

integer

required

Request time (unix timestamp, seconds).

transaction_type

string

required

length ≤ 16

Transaction type.

wallet_token

string

required

length ≤ 32

HASH value of customer's wallet.

payment_method

string

length ≤ 50

Payment method.

The payment_method parameter allows for overriding the specific gateway parameter, when utilizing features such as Cascading (for sale) or WD Routing Rules (for payout), for payment methods that support these options.

If both parameters gateway and payment_method received, the gateway value will be selected for the processing.

gateway

string

length ≤ 32

Gateway doing the processing.

withdrawal_request_id

integer

Original transaction identifier from. Send the tid of withdrawal request if you want the payout amount to be deducted from withdrawal request as processed.

currency

string

required

length ≤ 10

Base Currency: The user's account currency on the merchant site.

amount

integer

required

Transaction amount in cents.

Note: For certain currencies there is a fraction other than 100 cents per unit, this is important if you multiply by 100 to send the amount in cents.

cid

string

required

length ≤ 50

Unique customer id in your system.

Note: Personally Identifiable Information (PII), such as email addresses, is strictly forbidden. If your user identifier contains any PII, you must hash or encrypt it before sending it to the API.

locale

string

enum

required

length ≤ 5

User locale, specified as a BCP 47 Language Tag (e.g., 'en-GB'). The first component is the ISO 639-1 language code, and the second is the ISO 3166-1 country code.

Note: Contact [email protected] to add new locale if not available in the list.

order_id

string

required

length ≤ 50

Transaction or session identifier in your system.

notification_url

string

required

length ≤ 256

URL to which the deposit status notification will be sent.

return_url

string

required

length ≤ 256

User will be redirected to a specified URL(relevant for cashier login, virtual terminal, 3D Secure and E-Wallet login redirect).

variable1

string

length ≤ 256

Your custom field to tag the transaction with some necessary information.

variable2

string

length ≤ 256

Your custom field to tag the transaction with some necessary information.

variable3

string

length ≤ 256

Your custom field to tag the transaction with some necessary information.

Headers

gt-authentication

string

required

Authentication HTTP header of your outgoing request to the API.
Below request parameters should be used for creating signature in request header.

merchant_id
application_key
timestamp
transaction_type
cid
order_id
currency
amount
gateway
notification_url
return_url
wallet_token

Responses

200OK - Successful response

400Bad request - Missing signature

403Forbidden request - IP address not whitelisted