These docs are for v4.0.2. Click to read the latest docs for v4.3.0.

Payment Options

👍

HTTPS POST / Server-to-Server

https://sandbox-pgw.2c2p.com/payment/4.1/paymentOption
https://pgw.2c2p.com/payment/4.1/paymentOption

📘

API Parameter

Payment Option Request Parameters
Payment Option Response Parameter

The Payment Options API allows merchants to get a list of their available payment options in a single request.

Payment Option Request


The sample code below illustrates the correct API request structure.

{
    "paymentToken": "kSAops9Zwhos8hSTSeLTUcCrwcnrndJUZanGJy3fBEsXCiYmynwxHvK5h7XPBadJqD0nG7v65t5N2jPVrnwX2jL4nu+KKSegjUjERKCyWPg=",
    "clientID": "E380BEC2BFD727A4B6845133519F3AD7",
    "locale": "en"
}
curl --location --request POST 'https://sandbox-pgw.2c2p.com/payment/4.1/paymentOption' \
--header 'Content-Type: application/json' \
--data-raw '{
    "paymentToken": "kSAops9Zwhos8hSTSeLTUcCrwcnrndJUZanGJy3fBEsXCiYmynwxHvK5h7XPBadJqD0nG7v65t5N2jPVrnwX2jL4nu+KKSegjUjERKCyWPg=",
    "clientID": "E380BEC2BFD727A4B6845133519F3AD7",
    "locale": "en"
}'

 

Payment Option Response


The sample code below illustrates the API response structure.

{
    "paymentToken": "kSAops9Zwhos8hSTSeLTUcCrwcnrndJUZanGJy3fBEsXCiYmynwxHvK5h7XPBadJqD0nG7v65t5N2jPVrnwX2jL4nu+KKSegjUjERKCyWPg=",
    "merchantDetails": {
        "id": "JT01",
        "name": "HAPPY SHOP",
        "address": "#03-00 Tras street 089997",
        "email": "[email protected]",
        "logoUrl": "https://img.2c2p.com/merchant/jt01.png",
        "bannerUrl": "https://img.2c2p.com/merchant/banner/jt01.png"
    },
    "channelCategories": [{
        "sequenceNo": 1,
        "name": "Global Card Payment",
        "code": "GCARD",
        "iconUrl": "https://img.2c2p.com/pgw/gcard.png",
        "default": true,
        "groups": [{
            "sequenceNo": 1,
            "name": "Credit Card",
            "code": "CC",
            "iconUrl": "https://img.2c2p.com/pgw/cc.png",
            "default": true
        }, {
            "sequenceNo": 2,
            "name": "Installment Plan Payment",
            "code": "IPP",
            "iconUrl": "https://img.2c2p.com/pgw/ipp.png",
            "default": false
        }, {
            "sequenceNo": 3,
            "name": "Global 3 Party Payment",
            "code": "GTPTY",
            "iconUrl": "https://img.2c2p.com/pgw/gtpty.png",
            "default": false
        }]
    }, {
        "sequenceNo": 2,
        "name": "Local Card Payment",
        "code": "LCARD",
        "iconUrl": "https://img.2c2p.com/pgw/lcard.png",
        "default": false,
        "groups": [{
            "sequenceNo": 1,
            "name": "Proprietary / Loan Card",
            "code": "PCC",
            "iconUrl": "https://img.2c2p.com/pgw/pcc.png",
            "default": false
        }, {
            "sequenceNo": 2,
            "name": "Local 3 Party Payment",
            "code": "LTPTY",
            "iconUrl": "https://img.2c2p.com/pgw/ltpty.png",
            "default": false
        }]
    }, {
        "sequenceNo": 3,
        "name": "Web pay / Direct Debit",
        "code": "WEBPAY",
        "iconUrl": "https://img.2c2p.com/pgw/webpay.png",
        "default": false,
        "groups": [{
            "sequenceNo": 1,
            "name": "Web pay / Direct Debit",
            "code": "WEBPAY",
            "iconUrl": "https://img.2c2p.com/pgw/webpay.png",
            "default": true
        }]
    }, {
        "sequenceNo": 4,
        "name": "Internet / Mobile Banking",
        "code": "IMBANK",
        "iconUrl": "https://img.2c2p.com/pgw/imbank.png",
        "default": false,
        "groups": [{
            "sequenceNo": 1,
            "name": "Internet / Mobile Banking",
            "code": "IMBANK",
            "iconUrl": "https://img.2c2p.com/pgw/imbank.png",
            "default": true
        }]
    }, {
        "sequenceNo": 5,
        "name": "Pay at Counter",
        "code": "COUNTER",
        "iconUrl": "https://img.2c2p.com/pgw/counter.png",
        "default": false,
        "groups": [{
            "sequenceNo": 1,
            "name": "Bank Counter",
            "code": "BCTR",
            "iconUrl": "https://img.2c2p.com/pgw/bcounter.png",
            "default": true
        }, {
            "sequenceNo": 2,
            "name": "Over The Counter",
            "code": "OTCTR",
            "iconUrl": "https://img.2c2p.com/pgw/otcounter.png",
            "default": false
        }]
    }, {
        "sequenceNo": 6,
        "name": "Self Service Machines",
        "code": "SSM",
        "iconUrl": "https://img.2c2p.com/pgw/ssm.png",
        "default": false,
        "groups": [{
            "sequenceNo": 1,
            "name": "Automatic Teller Machine",
            "code": "ATM",
            "iconUrl": "https://img.2c2p.com/pgw/atm.png",
            "default": true
        }, {
            "sequenceNo": 2,
            "name": "Kiosk Machine",
            "code": "KIOSK",
            "iconUrl": "https://img.2c2p.com/pgw/kiosk.png",
            "default": false
        }]
    }, {
        "sequenceNo": 7,
        "name": "Digital Payment",
        "code": "DPAY",
        "iconUrl": "https://img.2c2p.com/pgw/dpay.png",
        "default": false,
        "groups": [{
            "sequenceNo": 1,
            "name": "E-Wallet Payment",
            "code": "EWALLET",
            "iconUrl": "https://img.2c2p.com/pgw/ewallet.png",
            "default": true
        }, {
            "sequenceNo": 2,
            "name": "Master Pass",
            "code": "MPASS",
            "iconUrl": "https://img.2c2p.com/pgw/mpass.png",
            "default": false
        }, {
            "sequenceNo": 2,
            "name": "Samsung Pay",
            "code": "SSPAY",
            "iconUrl": "https://img.2c2p.com/pgw/sspay.png",
            "default": false
        }]
    }, {
        "sequenceNo": 8,
        "name": "Scan QR Payment",
        "code": "QR",
        "iconUrl": "https://img.2c2p.com/pgw/qr.png",
        "default": false,
        "groups": [{
            "sequenceNo": 1,
            "name": "QR Code Payment",
            "code": "QRC",
            "iconUrl": "https://img.2c2p.com/pgw/qrc.png",
            "default": true
        }, {
            "sequenceNo": 2,
            "name": "Card Scheme QR Payment",
            "code": "CSQR",
            "iconUrl": "https://img.2c2p.com/pgw/csqr.png",
            "default": false
        }, {
            "sequenceNo": 3,
            "name": "Thai QR Payment",
            "code": "THQR",
            "iconUrl": "https://img.2c2p.com/pgw/thqr.png",
            "default": false
        }, {
            "sequenceNo": 4,
            "name": "Singapore QR Payment",
            "code": "SGQR",
            "iconUrl": "https://img.2c2p.com/pgw/sgqr.png",
            "default": false
        }]
    },{
        "sequenceNo": 9,
        "name": "Local Card IPP",
        "code": "LCARDIPP",
        "iconUrl": "https://img.2c2p.com/pgw/lcard.png",
        "default": false,
        "groups": [{
            "sequenceNo": 1,
            "name": "Installment Plan Payment Loan Card",
            "code": "LIPP",
            "iconUrl": "https://img.2c2p.com/pgw/ipploan.png",
            "default": false
        }]
    }],
    "transactionDetails": {
        "amount": "1000.00",
        "currencyCode": "SGD",
        "invoiceNo": "1523953661",
        "description": "item 1",
        "recurring": {
            "amount": "2500.00",
            "interval": 1,
            "count": 4,
            "chargeNextDate": "12122019",
            "chargeOnDate": ""
        }
    },
    "configuration": {
    },
    "respCode": "0000",
    "respDesc": "success"
}

Run test with Swagger Editor