Payments

POST /make_payment

Changed on

Use either the <code>pnm_order_identifier</code> or the <code>site_order_identifier</code> to find the order and then include the following required parameters to make the payment:<ul><li><code>payment_amount</code></li><li><code>payment_currency</code></li><li><code>payment_method_identifier</code></li></ul>

Request

  • Base URL
    https://api.paynearme-sandbox.com/json-api
  • Auth
    • OAuth 2
      Client credentials
      Token URLhttps://login.paynearme.com/oauth/token
    • or API key in query parameter signature

Request body

OR

Example request

{
  "pnm_order_identifier": "84338052224"
}

Response

Payment Created

OR

Example response

{
  "status": "ok",
  "payment": {
    "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",
    "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"
    }
  }
}

Changes

    • breaking

      the request property timestamp became required

    • breaking

      removed the success response with the status

    • info

      api operation id make_payment was added

    4 more changes in this revision