Orders

Retrieves the convenience fees associated with a <code>pnm_order_identifier</code> or a <code>site_order_identifier</code>. Results can be filtered by <code>payment_amount</code>, <code>payment_method_identifier</code>, <code>payment_type</code>, and <code>site_channel</code>.

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

Successful Operation

OR

Example response

{
  "status": "ok",
  "payment_methods": [
    {
      "consumer_fee_amount": 10,
      "consumer_fee_currency": "USD",
      "merchant_fee_currency": "USD",
      "total_fee_amount": 10,
      "total_fee_currency": "USD",
      "fee_amount": 3.99,
      "fee_currency": "USD",
      "accounts": [
        {
          "payment_method_identifier": "f9d5c9076006b",
          "name": "John Smith",
          "description": "Debit Card",
          "pull-enabled": "true",
          "push_enabled": "true",
          "number": "6666",
          "fee_amount": 3,
          "fee_currency": "USD",
          "expiration_date": "12/2025",
          "card_brand": "Visa",
          "pay_pal_account_id": "YB6935G4PHS92",
          "pay_pal_account_email": "buyer@paynearme.com"
        }
      ]
    }
  ]
}

Changes

    • breaking

      the request property timestamp became required

    • breaking

      added subschema #1 to the response body oneOf list for the response status

    • breaking

      the response's body type changed from object to no type for status

    14 more changes in this revision