Status

API ini digunakan untuk mengecek status transaksi yang telah dibuat melalui API.

URL Endpoint

Gunakan metode POST untuk mengakses endpoint berikut:

/custom/status

Headers

Pastikan untuk menyertakan header berikut pada request:

Key	Value
Content-Type	application/x-www-form-urlencoded

Body Request

Field	Type	Wajib	Deskripsi
key	string	Ya	API Key yang digunakan untuk autentikasi.
sign	string	Ya	Signature MD5 dengan format `md5(uid.key)`.
trx_id	string	Ya	ID transaksi yang ingin diperiksa.
limit	string	Tidak	Jumlah yang akan ditampilkan

Contoh Request

<?php

$key = "YOUR_API_KEY";
$uid = "YOUR_UID";

$postdata = [
    "key" => $key,
    "sign" => md5($uid.$key),
    "trx_id" => "INV202606230001"
];

$ch = curl_init();

curl_setopt_array($ch, [
    CURLOPT_URL => "https://yobistore.com/api/custom/status",
    CURLOPT_POST => true,
    CURLOPT_POSTFIELDS => http_build_query($postdata),
    CURLOPT_RETURNTRANSFER => true
]);

$response = curl_exec($ch);

curl_close($ch);

echo $response;

Contoh Response Berhasil

{
    "status": true,
    "message": "TRANSACTION_DETAIL_OBTAINED",
    "data": {
        "trx_id": "API202606230001XX",
        "trx_status": "Pending | Processing | Success | Error",
        "trx_note": "Catatan pesanan dari Admin"
    }
}

Contoh Response Gagal

{
    "status": false,
    "message": "API_KEY_NOT_FOUND"
}

{
    "status": false,
    "message": "USER_NOT_FOUND"
}

{
    "status": false,
    "message": "API_DEVELOPMENT"
}

{
    "status": false,
    "message": "API_SIGNATURE_NOT_VALID"
}

{
    "status": false,
    "message": "IP_NOT_WHITELISTED"
}

{
    "status": false,
    "message": "TRANSACTION_NOT_FOUND"
}

Field Response

Data

Field	Type	Deskripsi
trx_id	string	ID transaksi.
trx_status	string	Status transaksi.
trx_note	object	Catatan pesanan dari Admin

Status Transaksi

Status	Keterangan
Pending	Transaksi masuk ke sistem.
Processing	Transaksi sedang diproses.
Success	Transaksi berhasil.
Error	Transaksi gagal diproses.

[!TIP]

Signature wajib menggunakan format:
md5(uid.key)
Endpoint ini hanya dapat mengecek transaksi yang dibuat melalui API dan dimiliki oleh akun API yang sama.

On this page