v1
latestOpenAPI 3.0.12026-07-264182324.3 KBPayments
A dedicated endpoint for retrieving disbursement (i.e., push) payment history. This endpoint allows clients to retrieve a list of disbursements for specific push orders (<code>pnm_order_identifier</code> or <code>site_order_identifier</code>) or the push orders associated with a specific customer (<code>pnm_customer_identifier</code> or <code>site_customer_identifier</code>). This endpoint is only for returning push payments and not regular consumer payments (use the /find_payments endpoint for regular consumer payments).
post/find_disbursements
Request body
Example request
{
"pnm_order_identifier": "84338052224"
}Response
Disbursements Found
Example response
{
"status": "ok",
"disbursements": {
"payment_amount": 25.5,
"payment_currency": "USD",
"payment_status": "approved",
"payment_account": "Bank of America, NA 6655",
"payment_method_identifier": "d041313f4c04c",
"net_payment_amount": 25,
"net_payment_currency": "USD",
"payment_processing_fee": 0.5,
"payment_processing_fee_currency": "USD",
"pnm_processing_fee": 0.5,
"pnm_processing_fee_currency": "USD",
"settled_to_site": "false",
"pnm_payment_identifier": "403443149419",
"retailer_identifier": "FM690776428",
"pricing_schedule_name": "consumer",
"site_channel": "consumer",
"payment_receipt_text": "Thank you for making your payment to\n Freehold Financial.\n\n\nPayment Ref: 12345678\n\nPayment Confirmation: 403443149419\n\n\nAmount of Payment: $25.00\n\n Convenience Fee: $0.50\n\n Total Cash Tendered: $25.50\n\n\nKeep this receipt as proof of payment.\n\n",
"site_order_identifier": "8364638453",
"pnm_order_identifier": "59529122058",
"site_customer_identifier": "543310000",
"pnm_customer_identifier": "U2882711893",
"merchant_settlements": {
"settlement_method_identifier": "SM736220738",
"settlement_type": "net_payment",
"settlement_amount": 450.23,
"settlement_currency": "USD"
},
"refund": {
"refund_amount": "210.99",
"refund_currency": "USD",
"unsettle_to_merchant_amount": "200",
"unsettle_to_merchant_currency": "USD",
"unsettled_from_collector_amount": "0"
}
}
}