Get a payment by ID
Scope: accounting:payments.read https://api.alladdin.com/api/v2/payments/{paymentId}
Retrieves the full details of a single payment record by its unique identifier.
The response includes amount, date, status, reconciliation status, and the linked contact and source document.
Parameters
Path parameters
paymentId string required
Payment ID (24-char hex ObjectId)
Request
import requests
url = "https://api.alladdin.com/api/v2/payments/{paymentId}"
headers = {
"Authorization": "Bearer YOUR_API_KEY",
"Accept": "application/json",
}
response = requests.get(url, headers=headers)
print(response.json())Responses
Response
{
"id": "507f1f77bcf86cd799439011",
"bank_account_id": "string",
"contact_id": "string",
"contact_name": "string",
"amount": "1500.50",
"description": "string",
"date": "2024-01-15T10:30:00+00:00",
"status": "no_paid",
"reconciliation_status": "pending",
"total_documents": "0.00",
"total_transactions": "0.00",
"total_advance": "0.00",
"document_type": "invoice",
"document_id": "507f1f77bcf86cd799439011"
}Success responses
200 Payment found application/json object id string
Payment unique identifier
bank_account_id string | null
Banking account identifier
contact_id string | null
Contact identifier
contact_name string | null
Contact display name
amount string
Payment amount as decimal string in the account's base currency (multi-currency invoices are pre-converted at recording time).
description string | null
Payment description
date string
Payment date in ISO 8601 format
status string
Payment status
Enum: no_paid paid partial_paid reconciliation_status string
Bank reconciliation status
Enum: pending reconciled partial_reconciled total_documents string
Total amount linked to documents
total_transactions string
Total amount linked to transactions
total_advance string
Total amount linked to advance payments
document_type string | null
Type of the linked source document. Legacy alias eg is normalized to entry before exposure.
Enum: invoice purchase creditnote salesreceipt estimate proform salesorder purchaseorder purchaserefund remittance payroll entry trans order receiptnote invoicingforecast expemployee `` document_id string | null
Identifier of the linked document
Error responses
401 Invalid or missing API key application/json 403 Insufficient permissions application/json 404 Payment not found application/json 429 Rate limit exceeded application/json