API Reference

Payment Detail

Request

[GET] /api/v1/payment/detail/:id
Content-Type: application/json
x-client-id: <client_id>
x-signature: <signature>
x-timestamp: <timestamp>

Body

Response

Content-Type: application/json

Body

NameTypeDescription
iduuid.UUIDID
business_iduint64Business identifier
account_idtime.Timeaccount ID
request_amountfloat64Requested payment amount
notestringNote or description of the payment
total_net_settled_amountfloat64Total amount settled after deductions
total_collecting_amountfloat64Amount currently being collected
total_paid_amountfloat64Total amount paid
total_fee_amountfloat64Total fee amount
codestringUnique code for the payment request
payment_methodstringPayment method used (e.g., Bank Transfer)
currency_codestringCurrency code (e.g., USD)
transactionstruct-TransactionHistory
accountstruct-BankAccountResponse

Transaction History

NameTypeMesssage
iduuid.UUIDUnique identifier for the transaction
account_iduuid.UUIDAccount identifier for the transaction
net_amountfloat64Net amount of the transaction
fee_amountfloat64Fee amount for the transaction
currency_codestringCurrency code of the transaction
typestringTransaction type (e.g., Credit, Debit)
txn_numberstringTransaction number

Bank Account

NameTypeMesssage
iduuid.UUIDSuccess
business_iduint64Unauthorized
account_iduuid.UUIDAccount identifier
request_amountfloat64Requested payment amount
notestringNote or description of the payment
total_net_settled_amountfloat64Total amount settled after deductions
total_collecting_amountfloat64Amount currently being collected
total_paid_amountfloat64Total amount paid
total_fee_amountfloat64Total fee amount
codestringUnique code for the payment request
payment_methodstringPayment method used (e.g., Bank Transfer)
currency_codestringCurrency code (e.g., USD)

Errors

StatusMesssage
200Success
401Unauthorized

Example

Request

[GET] /api/v1/payment/detail/:id

Response

{
  "message": {
    "content": "Thực thi API thành công"
  },
  "code": 102000,
  "request_id": "d5f72213-a078-4ab9-bebc-4ffa467c7860",
  "data": {
    "id": "f0a446c3-7d7f-46f3-9062-f005dc3718d3",
    "business_id": 123456,
    "account_id": "a5ab9910-cdc8-4b6b-a5aa-0d3ffd72f34e",
    "request_amount": 5000,
    "note": "Payment for services rendered",
    "total_net_settled_amount": 4900,
    "total_collecting_amount": 100,
    "total_paid_amount": 5000,
    "total_fee_amount": 100,
    "code": "PMT123456789",
    "payment_method": "Bank Transfer",
    "currency_code": "USD",
    "transaction": {
      "id": "8d64c7e3-9273-4a3c-9c8b-3e138979e8ea",
      "account_id": "05753553-9b3f-4c41-b664-463e0681e029",
      "net_amount": 4900,
      "fee_amount": 100,
      "currency_code": "USD",
      "type": "Credit",
      "txn_number": "TXN654321987"
    },
    "account": {
      "id": "937c4366-8102-47a7-b9c1-2733e4b01c0d",
      "business_id": 123456,
      "account_id": "f0bc03f5-5d94-46a4-8b85-54f1765da88a",
      "request_amount": 5000,
      "note": "Payment for services rendered",
      "total_net_settled_amount": 4900,
      "total_collecting_amount": 100,
      "total_paid_amount": 5000,
      "total_fee_amount": 100,
      "code": "ACC987654321",
      "payment_method": "Bank Transfer",
      "currency_code": "USD"
    }
  }
}