Path/ordersnap/api/v1.0/debit/payment-host-to-host
HTTP MethodPOST
Versionv1.0
Service Code54

Request Header

Field NameField TypeMandatoryField Description
Content-typeStringMMedia type of the resource, i.e. application/json
AuthorizationStringMRepresents access_token of a request; string starts with keyword “Bearer ” followed by access_token. Can get this token from Access Token B2B response. Read here
X-TIMESTAMPStringMClient’s current local time in ISO-8601 format.
X-SIGNATUREStringMCreated using symmetric signature HMAC_SHA512 algorithm. Read here
X-PARTNER-IDStringMUnique identifier for caller.
X-EXTERNAL-IDStringMMerchant’s unique ID per transaction request
CHANNEL-IDStringMPJP’s channel id.
Content-typeapplication/json
AuthorizationBearer gp9HjjEj813Y9JGoqwOeOPWbnt4CupvIJbU1Mmu4a11MNDZ7Sg5u9a
X-TIMESTAMP2023-07-06T14:12:50+07:00
X-SIGNATUREqoda1fa417c72d6b91c257e01e54fac824
X-PARTNER-ID7fb118fb-2738-4886-9817-8a2c4de43001
X-EXTERNAL-ID41807553358950093184162180797837
CHANNEL-ID95221

Request Body

Field NameField TypeMandatoryField Description
partnerReferenceNoStringONomor identifikasi transaksi pada sistem layanan konsumen.
amountObjectMJumlah Transaksi.
amount.valueStringMNominal Transaksi.
amount.currencyStringMMata Uang.
urlParamObjectMParameter yang disertakan di url untuk mengirimkan pemberitahuan pembayaran.
urlParam.urlStringMTautan link url.
urlParam.typeStringMJenis url.
urlParam.isDeeplinkStringMPemberitahuan menggunakan deeplink atau tidak.
validUpToStringOWaktu berakhirnya pembayaran secara otomatis.
Format :
YYYY-MM-DDTHH:mm:ss+07:00
payOptionDetailsObjectODetail opsi pembayaran yang akan digunakan untuk melakukan pembayaran.
payOptionDetails.payMethodStringMMetode Pembayaran.
payOptionDetails.payOptionStringMOpsi pembayaran yang menunjukkan penyedia pembayaran.
additionalInfoObjectOInformasi tambahan.
additionalInfo.userNameStringMNama pengguna merchant.
additionalInfo.userEmailStringMAlamat email pengguna.
additionalInfo.userPhoneStringMNomor telepon pengguna.
{
    "partnerReferenceNo": "order01",
    "amount": {
        "value": "10000.00",
        "currency": "IDR"
    },
    "urlParam": {
        "url": "https://yourthankyoupage.com",
        "type": "PAY_RETURN",
        "isDeeplink": "N"
    }
    "validUpTo": "2024-08-23T07:44:11+07:00",
    "payOptionDetails": {
        "payMethod": "7",
        "payOption": ""
    },
    "additionalInfo": {
        "userName": "Agung Setiadi Putra",
        "userEmail": "[email protected]",
        "userPhone": "082231838297"
    }
}

Response Body

Field NameField TypeMandatoryField Description
dataObjectM
data.additional_infoObjectOAdditional Info
data.additional_info.messageStringOMessage info
data.additional_info.order_noStringMOrder number
data.additional_info.payment_numberStringMPayment number
data.additional_info.qr_valueStringMInformation QR Value
responseCodeString(7)MError code to specify the error returned
responseMessageString(150)MDebug message to provide more information.
virtualAccountDataObjectMObject Virtual Account Data
virtualAccountData.codeStringMCode
virtualAccountData.dataObjectMObject Data Virtual Account Data
virtualAccountData.data.additional_infoObjectOObject Additional Information Data
virtualAccountData.data.additional_info.messageStringOMessage info
virtualAccountData.data.payment_numberStringMPayment number
virtualAccountData.data.payment_urlStringMUrl payment
virtualAccountData.data.qr_valueStringMInformation QR Value
virtualAccountData.messageStringMMessage status response
virtualAccountData.statusStringMStatus response
{
    "data": {
        "additional_info": {
            "message": "Mohon selesaikan transaksi anda di aplikasi anda..."
        },
        "order_no": "T24060663798",
        "payment_number": "T24060663798",
        "payment_url": "https://dev-merchant.qoinhub.id/?data=&pc_code=linkaja",
        "qr_value": null
    },
    "responseCode": "20054000",
    "responseMessage": "Request has been processed successfully",
    "virtualAccountData": {
        "code": "200",
        "data": {
            "additional_info": {
                "message": "Mohon selesaikan transaksi anda di aplikasi anda..."
            },
            "order_no": "T24060663798",
            "payment_number": "T24060663798",
            "payment_url": "https://dev-merchant.qoinhub.id/?data=&pc_code=linkaja",
            "qr_value": null
        },
        "message": "success to update transaction payment",
        "status": "success"
    }
}


List Response Code

Response CodeHTTP StatusDescription
2002700200Successful
4002701400Invalid format