Orders

POST /cancel_order

Changed on

Use either the <code>pnm_order_identifier</code> or the <code>site_order_identifier</code> to find the active order you want to cancel immediately. Consumers cannot make payments against cancelled orders. After cancelling, the <code>order_status</code> will display as <code>closed</code> and the <code>order_closed_reason</code> displays as <code>canceled</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

Order Canceled

OR

Example response

{
  "status": "ok",
  "orders": {
    "site_name": "Freehold Financial",
    "site_logo_url": "https://www.paynearme-sandbox.com/photos/emit_image/H3NopCqX5n",
    "site_order_identifier": "987654321",
    "site_identifier": "S2411573363",
    "pnm_order_crid": "e042bw",
    "pnm_order_identifier": "83517813169",
    "pnm_order_short_identifier": "LSHCP9",
    "site_order_key": "12345678910",
    "payment_types": "ach, credit, debit",
    "order_amount": 450.23,
    "minimum_payment_amount": 450.23,
    "order_is_standing": "true",
    "secure_smart_token": "qsueWbbb2bpoefPq2X3aQr04nx80GrkrtwlHAAWosi5gx4q44ELSmVbUDWpkjU!1",
    "secure_smart_link": "https://www.paynearme-sandbox.com/ssl/qsueWbbb2bpoefPq2X3aQr04nx80GrkrtwlHAAWosi5gx4q44ELSmVbUDWpkjU!1",
    "order_tracking_url": "https://www.paynearme-sandbox.com/83517813169",
    "site_order_annotation": "MarchUtility",
    "auto_pay": {
      "auto_pay_identifier": "378865941675977",
      "auto_pay_description": "every Saturday",
      "auto_pay_number_of_recurrences_planned": "19",
      "auto_pay_multi_first": "1",
      "auto_pay_multi_last": "15",
      "auto_pay_number_of_recurrences_done": "2",
      "auto_pay_amount": 25,
      "auto_pay_payment_method_identifier": "d041313f4c04c",
      "auto_pay_payment_method_description": "Bank of America, NA 6655"
    },
    "electronic_payments": {
      "embedded_js_url": "https://www.paynearme-sandbox.com/api/embedded/O_ieEu6moDhUWOCLU1sngw/script.js",
      "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"
            }
          ]
        }
      ]
    },
    "customer": {
      "pnm_customer_identifier": "U9745174469",
      "site_customer_identifier": "12345678",
      "pnm_customer_name": "Bobby Smith",
      "pnm_customer_email": "bobby.smith@mail.com",
      "pnm_customer_phone": "2145555590",
      "pnm_customer_addressee": "Bobby Smith",
      "pnm_customer_street": "123 Fake Street",
      "pnm_customer_street2": "Suite 200",
      "pnm_customer_city": "Allen",
      "pnm_customer_state": "TX",
      "pnm_customer_postal_code": "75013"
    },
    "users": {
      "user": {
        "user_type": "push",
        "push_user_identifier": "88885555",
        "push_user_status": "ok_to_receive",
        "push_first_name": "John",
        "push_middle_name": "Diego",
        "push_last_name": "Smith",
        "push_full_name": "John Smith",
        "push_street": "123 Fake Street",
        "push_city": "Allen",
        "push_state": "TX",
        "push_postal_code": "75013",
        "push_country": "US",
        "push_year_of_birth": "1980",
        "push_pre_verified": "false",
        "push_manually_verified": "false"
      }
    },
    "locations": {
      "latitude": "39.7719",
      "longitude": "-75.4946",
      "map_url": "https://maps-api-ssl.google.com/maps/api/staticmap?&size=250x250&maptype=roadmap&markers=color:orange%7Clabel:1%7C39.75529,-75.49923&markers=color:orange%7Clabel:2%7C39.75283,-75.50919&markers=color:green%7Clabel:3%7C39.76701,-75.53637&markers=color:orange%7Clabel:4%7C39.81701,-75.50679&markers=color:orange%7Clabel:5%7C39.74346,-75.53575&format=png8&client=gme-kweditinc&sensor=false&signature=U7KI5B78JDMdc1yWt31HotwVoik=",
      "location": [
        {
          "retailer": "7-Eleven",
          "street": "486 Gov. Printz Blvd.",
          "city": "DE",
          "latitude": "39.75529",
          "longitude": "-75.49923",
          "distance": "1.17",
          "phone": "302-764-5180",
          "pnm_retailer_identifier": "7-Eleven"
        }
      ]
    },
    "retailers": [
      {
        "retailer_name": "7-Eleven",
        "retailer_identifier": "7-Eleven",
        "retailer_logo": "https://www.paynearme-sandbox.com/assets/retailers/CVS/logo.png",
        "retailer_mapkey": "orange",
        "retailer_icon": "https://www.paynearme-sandbox.com/assets/retailers/7-Eleven/icon.jpg",
        "retailer_nickname": "7-Eleven",
        "retailer_mobile_barcode": "true",
        "fees": {
          "order_has_pos_fee": "true",
          "tiers": [
            {
              "amounts_up_to": "2000",
              "processing_fee": "1.99"
            }
          ]
        },
        "slip": {
          "slip_url": "https://api.paynearme-sandbox.com/pslip/79809876628",
          "slip_pdf_url": "https://api.paynearme-sandbox.com/pslip/79809876628.pdf",
          "slip_id": "79809876628",
          "retailer_name": "7-Eleven"
        },
        "mobile": {
          "barcode_url": "https://www.paynearme-sandbox.com/bc/629964000000000000800000000000",
          "retailer_name": "7-Eleven"
        }
      }
    ],
    "universal_slip": {
      "slip_url": "https://api.paynearme-sandbox.com/pslip/79809876628",
      "slip_pdf_url": "https://api.paynearme-sandbox.com/pslip/79809876628.pdf"
    },
    "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",
        "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 cancel_order was added

    4 more changes in this revision