REST RPC APIPlacement Logs

Get Placement Logs Responses

View as Markdown

Authentication

x-api-keystring
API Key authentication via header

Query parameters

start_datedatetimeOptional

Filter by log records created on or after a specific date/time. Expected format is YYYY-MM-DD HH:mm:ss

end_datedatetimeOptional

Filter by log records created on or before a specific date/time. Expected format is YYYY-MM-DD HH:mm:ss

page_sizeintegerOptionalDefaults to 10
Number of results to be retrieved in each page. Default value is 10, Maximum allowed is 1000

Response

public_idstringDefaults to
Unique identifier for this billing attempt
merchantstring
Merchant public ID
orderstring
Order public ID
customerstring

Customer ID (merchant user ID)

response_codestring

Normalized status code (e.g. “000” = success, “140” = payment failure, “999” = error)

response_messagestring
Error message extracted from the platform response, if any
response_order_idstring

Order ID returned by the e-commerce platform if the billing attempt was successful

createddatetimeDefaults to 2026-03-22 12:07:00

When the billing attempt occurred (YYYY-MM-DD HH:MM:SS) in CST

response_payloadstring

Order placement response (XML)

transaction_responsestring

The raw transaction payload from the payment processor. It is currently Shopify only — null for all other platforms.