Sign in

v1

latestOpenAPI 3.0.12026-07-264182324.3 KB
Payments

A dedicated endpoint for retrieving an order's payment history with explicit control over sorting, limiting, and pagination. This endpoint allows clients to retrieve a list of payments for a specific order directly via the <code>site_order_identifier</code> or the <code>pnm_order_identifier</code> or for a specific customer directly via the <code>pnm_customer_identifier</code> or the <code>site_customer_identifier</code>. This endpoint is only for returning regular consumer payments and not disbursements (use the /find_disbursements endpoint for push payments).

post/find_payments

Request body

OR
OR
OR

Example request

{
  "pnm_order_identifier": "84338052224"
}

Response

Payments Found

statusstring

Response status (e.g., 'ok')

Example response

{
  "status": "ok",
  "payments": {
    "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",
    "card_bin": "999992",
    "site_order_identifier": "10082024-01",
    "pnm_order_identifier": "87789791812",
    "site_customer_identifier": "10082024-01",
    "pnm_customer_identifier": "U4154475785",
    "site_payment_identifier": "SPI-123",
    "payment_authorization_memo": "2026-02-11 07:01:08 -0800",
    "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"
    }
  }
}