Card Payment

Card Payment

POST/pay_index

Initiate a card payment transaction via `POST /pay_index`. Card payments are initiated through `create()`. **Card number, expiration date, and CVV are required**. The endpoint returns `PaymentResponse`:

SDK methodcreate()

ParametersRequest body

pay_memberidstringrequired

SDK property: payMemberid. Merchant ID

pay_orderidstringrequired

SDK property: payOrderid. Unique merchant order ID

pay_applydatestringrequired

SDK property: payApplydate. Order submission timestamp

pay_bankcodestringrequired

SDK property: payBankcode. Payment bank code (card: typically `901`)

pay_notifyurlstringrequired

SDK property: payNotifyurl. Server-side webhook URL (POST)

pay_callbackurlstringrequired

SDK property: payCallbackurl. Customer redirect URL after payment (GET)

pay_amountstringrequired

SDK property: payAmount. Transaction amount

pay_md5signstringrequiredsign

SDK property: payMd5Sign. MD5 signature

pay_currencystringrequired

SDK property: payCurrency. ISO 4217 currency code (e.g. `USD`)

pay_urlstringrequired

SDK property: payUrl. Merchant website URL

pay_methodstringrequired

SDK property: payMethod. Payment method name (see payment methods reference)

pay_cardnostringrequired

SDK property: payCardno. Card number (PAN)

pay_cardmonthstringrequired

SDK property: payCardmonth. Expiration month (e.g. `12`)

pay_cardyearstringrequired

SDK property: payCardyear. Expiration year (e.g. `2027`)

pay_cardcvvstringrequired

SDK property: payCardcvv. CVV

pay_firstnamestringrequired

SDK property: payFirstname. Cardholder first name

pay_lastnamestringrequired

SDK property: payLastname. Cardholder last name

pay_country_iso_code_2stringrequired

SDK property: payCountryIsoCode2. Billing country (ISO 3166-1 alpha-2)

pay_email_addressstringrequired

SDK property: payEmailAddress. Billing email

pay_telephonestringrequired

SDK property: payTelephone. Billing phone

pay_ipstringrequired

SDK property: payIp. Customer IP address

pay_useragentstringrequired

SDK property: payUseragent. Browser User-Agent

pay_typestring

SDK property: payType. Billing type (card payments do not use `apm`)

pay_street_address1string

SDK property: payStreetAddress1. Billing address line 1

pay_street_address2string

SDK property: payStreetAddress2. Billing address line 2

pay_citystring

SDK property: payCity. Billing city

pay_postcodestring

SDK property: payPostcode. Billing postal code

pay_statestring

SDK property: payState. Billing state or province

pay_languagestring

SDK property: payLanguage. Preferred language

systemstring

E-commerce platform name

Response

**200**: Successful response — `PaymentResponse` via `getResult()`.

POST/pay_index

use JPayApiLib\Models\Requests\Builders\PaymentRequestBuilder;

$request = PaymentRequestBuilder::init()
        ->payMemberid('10153')
        ->payOrderid('O' . time())
        ->payNotifyurl('https://yourdomain.com/notify')
        ->payCallbackurl('https://yourdomain.com/callback')
        ->payAmount('100.00')
        ->payCurrency('USD')
        ->payUrl('https://yourdomain.com')
        ->payFirstname('John')
        ->payLastname('Doe')
        ->payCountryIsoCode2('US')
        ->payEmailAddress('[email protected]')
        ->payTelephone('1234567890')
        ->build();

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

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

    switch ($result->getStatus()) {
        case 0:
            echo 'Payment succeeded: ' . $result->getMsg();
            break;
        case 1:
            // Redirect customer to 3DS page
            header('Location: ' . $result->getUrl());
            break;
        default:
            echo 'Payment failed: ' . $result->getMsg();
    }
}