For archived content, access the previous documentation here or the previous API reference here.

Get Payment Detail

  • Updated on Aug 8, 2025
  • Published on Aug 8, 2025
Prev Next
Get
/bill-payments/v1/payment/{id}

This endpoint retrieves detailed information about a specific payment, including its current status and fulfillment results if available.

Security
HTTP
Type Basic
Path parameters
id
stringRequired

Payment transaction ID from post payment response

Exampletrx-98765
Responses
200

Payment details retrieved successfully

plnPrepaidSuccess

PLN Prepaid Payment - Success

{
  "data": {
    "business_id": "5f27a14a9bf05c73dd040bc8",
    "type": "payment",
    "id": "trx-98765",
    "properties": {
      "reference_id": "tx-pln-001",
      "product_id": "PLN_PREPAID_50K",
      "customer_number": "12345678910",
      "admin_amount": 3200,
      "base_amount": 50000,
      "total_amount": 53200,
      "currency": "IDR",
      "status": "SUCCEEDED",
      "fulfilled_at": "2024-01-23T08:15:30Z",
      "failure_code": null,
      "failure_reason": null,
      "customer_details": [
        {
          "key": "Nama Pelanggan",
          "value": "John Doe"
        },
        {
          "key": "Nomor Pelanggan",
          "value": "12345678910"
        }
      ],
      "product_details": [
        {
          "key": "Tarif/Daya",
          "value": "R2/000003500"
        }
      ],
      "bill_details": [
        {
          "key": "Admin",
          "value": "3200"
        }
      ],
      "payment_details": [
        {
          "key": "Token",
          "value": "1234-5678-9012-3456-7890"
        },
        {
          "key": "Serial Number",
          "value": "PLN987654321"
        }
      ]
    }
  }
}
Expand All
object
data
object
business_id
string

Xendit's Business ID

type
string

Type of response, always "payment"

Valid values[ "payment" ]
id
string

Unique payment transaction ID

properties
object
reference_id
string

Partner's transaction reference

product_id
string

Product identifier

customer_number
string

Customer's account/service number

admin_amount
number

Administrative fee amount

base_amount
number

Base product amount

total_amount
number

Total amount including admin fee

currency
string

Currency of the product

status
string

Payment status

Valid values[ "PENDING", "SUCCEEDED", "FAILED" ]
fulfilled_at
string (date-time) | null

ISO8601 timestamp when payment completed (null when pending)

failure_code
string | null

Error code in case of FAILED status

failure_reason
string | null

Error message in case of FAILED status

customer_details
Array of object (BillPaymentDetailKeyValue)

Array of customer information key-value pairs

object
key
string

Name of the detail field

value
string

Value of the detail field

product_details
Array of object (BillPaymentDetailKeyValue)

Array of product information key-value pairs

object
key
string

Name of the detail field

value
string

Value of the detail field

bill_details
Array of object (BillPaymentDetailKeyValue)

Array of billing information key-value pairs

object
key
string

Name of the detail field

value
string

Value of the detail field

payment_details
Array of object (BillPaymentDetailKeyValue)

Array of payment information key-value pairs

object
key
string

Name of the detail field

value
string

Value of the detail field

404

The provided id does not exist. Please review the id and try again

object
error_code
string
Valid values[ "RATE_LIMIT_EXCEEDED" ]
message
string
errors
Array
OneOf
string
string
object
object