Sign in

v1

latestOpenAPI 3.0.02026-07-246335313.6 KB
Payout APIs

Create Payout

post/api/payout/transaction

Headers

Content-Typestring
Cookiestring
X-Portone-Client-Keystring
Authorizationstring

The Authorization header is used to include the JWT for authenticating API requests; learn how to generate the token <a href="/docs/jwt-authentication" target="_blank">in this guide</a>

Request body

keystring required

The unique PortOne key for merchant

channel_keystring required

The Payment Channel Key listed in PortOne docs

signature_hashstring required

The SignatureHash generated for the specific payload data

environment'live' | 'sandbox' required

The environment of the transaction is either live OR sandbox

split_payoutsboolean

Indicates if split payouts are enabled

Example request

{
  "key": "dzcylAVbbBkhkSeg",
  "channel_key": "GBPRIMEPAY_PAYOUT",
  "signature_hash": "abc@123",
  "environment": "sandbox",
  "split_payouts": false,
  "txn_details": {
    "virtual_acc_no": "dzcylAVbbBkhkSeg-12345678911_sandbox",
    "amount": 100,
    "currency": "THB",
    "txn_ref": "txnref_78C57474A06E278",
    "remarks": "Test remarks",
    "user_message": "Test User Message",
    "send_email": false,
    "send_sms": false,
    "recipient_emails": [
      "test@test.com",
      "johndoe@gmail.com"
    ],
    "bank_details": {
      "account_no": "7771000241",
      "account_type": "BANK",
      "account_name": "John Doe",
      "bank_no": "025",
      "bank_name": "Bank of Ayudhya Public Company Limited",
      "email": "johndoe@gmail.com",
      "phone": "+919876543210",
      "address": "123 Example Street, City",
      "country": "TH"
    }
  }
}

Response

Successful response

is_successboolean

The boolean value indicating whether Payout transaction was created successfully.