Initiate Collection (API)

POST

/api-pay/collection/order/create-api

API: On the merchant's own cashier page, available payment methods are displayed to the user, allowing the user to complete the payment directly on the merchant's cashier page.

H5 Cashier: Compared to the API, its main advantage is that it eliminates the need for the merchant to develop a payment page. Payjn provides a unified payment page, making it easier for merchants to guide users to complete the payment.

Both H5 Cashier and API order placement methods use exactly the same order status query interface and asynchronous order success notification interface (merchantNotifyUrl). Merchants can choose according to their actual needs.

Request

Header Params

Body Params application/json

Example

{
    "merchantCode": "258251",
    "paymentMethodCode": "QRIS",
    "merchantOrderId": "P2025062874595259999",
    "amount": 50000,
    "merchantNotifyUrl": "https://merchant-api.com/callback",
    "customer": {
        "name": "Citra Astutii",
        "phone": "08126788314",
        "email": "CitraAstuti43@gmail.com"
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api-pay/collection/order/create-api' \
--header 'sign: RSh5aa2HKh9M3MkxxsyhtWU8JDQB6WgSYUe/NwGPD9KA/LkxkWl3+EzxoNnZU5QRXssUonIL8VQUEgdQTI2xmQHS726FUDeZ9qyvDjV3lE8diCPqujbkm+fSz27cPutSDta1wGp8bVOMctysQziBk3OZsxvV17ipu6TD6EkFzJ8AMLDFOzztCxO3i6Z5RtTCQOabdqzj28sJsgQDDTVuiRDnO1fOC9QvBBfi+jqYBOULuNbUrcEGyd4QYXJZmxcyHJlV8V1Y7328+t7DmagZSKWuWtC78Zh75TCu35eimEEfuwEuFptVVDKIVveYvdf4Amt7Q/fptQS5CJB+bSXmpQ==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchantCode": "258251",
    "paymentMethodCode": "QRIS",
    "merchantOrderId": "P2025062874595259999",
    "amount": 50000,
    "merchantNotifyUrl": "https://merchant-api.com/callback",
    "customer": {
        "name": "Citra Astutii",
        "phone": "08126788314",
        "email": "CitraAstuti43@gmail.com"
    }
}'

Responses

🟢200成功

application/json

Body

Example

{
    "code": 200,
    "msg": "success",
    "data": {
        "merchantCode": "258251",
        "countryCode": "IDN",
        "platformOrderId": "C2582511751104335054607",
        "merchantOrderId": "P2025062874595259999",
        "amount": "50000.00",
        "status": "PROCESSING",
        "paymentMethodCode": "QRIS",
        "paymentInfo": {
            "content": "00020101021226660016ID.CO.MBAYAR.WWW01189360082901739151340213EP003310S00580303UME520458165303360540850000.005802ID5909AH Gaming6007Bandung6105401616236050917325902307062151350809AH Gaming63042B7D",
            "type": "code"
        },
        "returnUrl": "",
        "remark": "",
        "transFeeRate": "1.60",
        "transFee": "0.00",
        "totalTransFee": "800.00",
        "desc": "",
        "createTime": "2025-06-28 16:52:15"
    }
}

Modified at 2025-06-30 03:17:20

Attachment Code Table

Initiate Collection (H5 Cashier)