Skip to content

Get Payment ​

Mengambil status dan rincian lengkap dari transaksi pembayaran yang sudah dibuat sebelumnya. Endpoint ini berguna untuk memeriksa status terbaru dari sebuah transaksi, misalnya untuk polling dari client jika belum ada webhook yang diterima.

http
GET /v1/payments/{payment_id}

Request Parameter ​

ParameterTipeLokasiRequiredDeskripsi
payment_idstring (UUID)URL Path✅ID pembayaran yang diterima pada saat memanggil /v1/payments/create

Request Headers ​

HeaderTipeRequiredDeskripsi
Authorizationstring✅Bearer {api_key} atau Bearer {jwt_token}

Response ​

Format response dari endpoint ini persis sama dengan response sukses saat pembuatan transaksi pada POST /v1/payments/create.

Contoh Request ​

bash
curl -X GET https://gerbang-pay-api.gai.co.id/v1/payments/550e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: ApiKey gp_live_xxxxxxxxxxxx"

Contoh Response (Status: Paid) ​

Perhatikan nilai pada field status, paid_at, dan amount_paid.

json
{
  "success": true,
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "tenant_id": "b6a3b2b8-f09d-4767-8fa0-68153c30a91f",
    "payment_code": "TEST-12345678",
    "idempotency_key": "order-123",
    "amount": 10000000,
    "currency": "IDR",
    "method_type": "virtual_account",
    "method_data": {
      "type": "virtual_account",
      "bank": "BCA",
      "va_number": "88880123456789"
    },
    "status": "paid",
    "provider": "winpay",
    "provider_payment_id": "WP-998877",
    "customer_name": "Budi Santoso",
    "customer_email": "[email protected]",
    "customer_phone": "081234567890",
    "items": [],
    "expires_at": "2026-07-21T12:00:00Z",
    "paid_at": "2026-07-21T11:05:32Z",
    "amount_paid": 10000000,
    "failure_reason": null,
    "created_at": "2026-07-21T11:00:00Z",
    "updated_at": "2026-07-21T11:05:32Z"
  }
}

Response Error ​

404 Not Found ​

Terjadi jika payment_id tidak ditemukan di database atau payment_id tersebut milik tenant lain (di luar akses API Key Anda).

json
{
  "success": false,
  "error": {
    "code": "NOT_FOUND",
    "message": "not found: payment 550e8400-e29b-41d4-a716-446655440000 not found"
  }
}

Gerbang Pay API Documentation