get_payment_details_m Sample Call and Response
This example queries for payments collected on a specific account through a specific payment processor since the start of the current year, based on the get_payment_details_m method defined in app_m_r73.yml for the Object Query API.
This example includes every required argument, along with a query_string built from queryable fields that narrows the search to one account, one processor, and a recent date range, and a representative pair of payment entries. It does not attempt to show every field this method can return.
Sample call
{
"rest_call": "get_payment_details_m",
"output_format": "json",
"client_no": 60214,
"auth_key": "3f9c2b7a-91de-4a2c-88fb-4e6d0a5c7f21",
"query_string": "acct_no = 30182034 AND processor_name = \"CyberSource\" AND payment_date >= \"2026-01-01\"",
"limit": 10,
"offset": 0
}
client_no and auth_key are required identifiers, and query_string is also required for this method, since the shared param_defaults definition marks it nullable false. The query_string in this example uses acct_no, processor_name, and payment_date, all of which carry queryable true directly under payment_details; other legal filter fields include payment_id, processor_payment_id, amount, method, and reference_num. output_format and rest_call are envelope fields added by the REST gateway rather than being part of the method's own documented arguments. limit and offset are optional paging controls.
Sample response
{
"error_code": 0,
"error_msg": "OK",
"starting_record": 0,
"total_records": 3,
"payment_details": [
{
"payment_id": 4471002,
"processor_payment_id": "CS-88213947",
"acct_no": 30182034,
"user_id": "jrivera_novara",
"currency_cd": "USD",
"payment_date": "2026-06-10",
"amount": 128.50,
"collection_status_cd": "S",
"collection_status_text": "Successful",
"processor_name": "CyberSource",
"method": "Credit card",
"reference_num": "REF-771234",
"last_updated": "2026-06-10"
},
{
"payment_id": 4432891,
"processor_payment_id": "CS-88190215",
"acct_no": 30182034,
"user_id": "jrivera_novara",
"currency_cd": "USD",
"payment_date": "2026-01-11",
"amount": 128.50,
"collection_status_cd": "S",
"collection_status_text": "Successful",
"processor_name": "CyberSource",
"method": "Credit card",
"reference_num": "REF-768840",
"last_updated": "2026-01-11"
}
]
}
An error_code of zero with an error_msg of "OK" indicates the query succeeded. total_records is set to three to show that this account has more payments through this processor within the queried date range than this example displays; only the first two entries are shown in payment_details, and the real array would continue with a third payment, most likely one collected between the two shown here. Both payments were collected successfully by the same credit card method against the same processor, matching the corresponding invoices from get_invoice_information_m. This example leaves out voiding_event_no, since neither payment shown was voided. The deprecated username and password arguments, which carry a deprecate_version of 5.6 in the shared param_defaults block, are also omitted, since a current integration should not rely on them.