Create

Create

POST/api/v1/payment/createOrder

Submit a payout order to transfer funds to a payee account. This endpoint does not require authentication.

SDK methodcreate()

ParametersRequest body

orderTypestringrequired

Payout type (see payout type reference)

memberidstringrequired

Merchant ID

out_trade_nostringrequired

SDK property: outTradeNo. Unique merchant payout order ID

amountstringrequired

Payout amount

currencystringrequired

Currency code (USD, JPY, etc.)

notifyurlstringrequired

Webhook URL for payout completion

remarkstringrequired

Payout remark (cannot be empty)

signstringrequiredsign

MD5 signature (auto-generated when `apiKey` is configured)

firstnamestringrequired

Payee first name

payeeCountrystringrequired

Payee country (ISO 3166-1 alpha-2)

payeeaccountstringrequired

Bank card or wallet account number

bankcodestringrequired

Local bank code

banknamestringrequired

Bank name (Short code when country is VN)

lastnamestring

Payee last name (omitted from signing when blank)

Response

**200** — `ApiV1PaymentCreateOrderResponse` via `getResult()`.

POST/api/v1/payment/createOrder

use JPayApiLib\Models\Requests\Builders\CreatePayoutRequestBuilder;

$request = CreatePayoutRequestBuilder::init()
    ->orderType('BANK')
    ->memberid('10153')
    ->outTradeNo('PAYOUT20260101001')
    ->amount('100.00')
    ->currency('USD')
    ->notifyurl('https://yourdomain.com/payout/notify')
    ->remark('Salary payout')
    ->firstname('John')
    ->payeeCountry('VN')
    ->payeeaccount('1234567890')
    ->bankcode('970448')
    ->bankname('OCB')
    ->lastname('Doe')
    ->build();

$apiResponse = $client->getPayoutsApi()->create($request);

if ($apiResponse->isSuccess()) {
    /** @var \JPayApiLib\Models\ApiV1PaymentCreateOrderResponse $result */
    $result = $apiResponse->getResult();
    var_dump($result);
}