Payment Ledger

Endpoint ini digunakan untuk mengambil riwayat buku besar (ledger) yang terkait secara spesifik dengan satu ID pembayaran.

Setiap pembayaran yang berhasil (paid) akan mencetak entri ledger tipe credit (uang masuk) ke dalam saldo (balance) tenant Anda. Sistem ledger bersifat append-only (hanya tambah), artinya entri tidak pernah dihapus atau diubah untuk menjaga integritas finansial.

GET /v1/payments/{payment_id}/ledger

Request Parameter

Parameter	Tipe	Lokasi	Required	Deskripsi
payment_id	string (UUID)	URL Path	✅	ID pembayaran

Request Headers

Header	Tipe	Required	Deskripsi
Authorization	string	✅	Bearer {api_key} atau Bearer {jwt_token}

Response

Endpoint mengembalikan daftar log ledger dalam bentuk array.

Contoh Request

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

Contoh Response (200 OK)

{
  "success": true,
  "data": [
    {
      "id": "771e8400-e29b-41d4-a716-446655440000",
      "payment_id": "550e8400-e29b-41d4-a716-446655440000",
      "tenant_id": "b6a3b2b8-f09d-4767-8fa0-68153c30a91f",
      "entry_type": "credit",
      "amount": 10000000,
      "balance_after": 25000000,
      "reference_id": "PAY-123",
      "reason": "Payment received from provider",
      "created_at": "2026-07-21T11:05:32Z"
    }
  ]
}

Penjelasan Field Array

Field	Tipe	Deskripsi
entry_type	string	credit (saldo bertambah) atau debit (saldo berkurang, contoh saat refund/fee)
amount	integer	Jumlah pergerakan dana (dalam sen)
balance_after	integer	Total saldo akhir tenant setelah pergerakan ini terjadi (dalam sen)
reason	string	Catatan mengenai mengapa pergerakan dana ini terjadi
created_at	string	Waktu entri ledger dicatat