Autopay Schedules

POST /schedule_auto_pay

Changed on

Use either the <code>pnm_order_identifier</code> or the <code>site_order_identifier</code> to find the order for which you want to create a schedule of recurring transactions, or an autopay schedule. Only one autopay schedule can be defined for an order. Autopay schedules can be configured for the following frequencies:<ul><li><code>weekly</code> - Payments are made every week on the same day as the <code>auto_pay_start_date</code> (e.g., every Wednesday)</li><li><code>bi-weekly</code> - Payments are made every other week on the same day as the <code>auto_pay_start_date</code> (e.g., every other Wednesday)</li><li><code>monthly</code> - Payments are made each month on the same date as the <code>auto_pay_start_date</code> (e.g., the 20th of every month) or, if configured, a preferred week and day of the month using the <code>auto_pay_first_nth_weekday</code> (e.g., the last Friday of every month)</li><li><code>twice_monthly</code> - Payments are made twice a month on the dates specified in the <code>auto_pay_multi_first</code> and <code>auto_pay_multi_last</code> parameters, which are required for this autopay frequency (e.g., the 15th and 28th of every month). If configured, payments can also be made on preferred days and weeks of the month using the <code>auto_pay_first_nth_weekday</code> and <code>auto_pay_second_nth_weekday</code> parameters (e.g., first and last Fridays of the month).</li><li><code>end_of_month</code> - Payments are made on the last day of every month or the preferred weekday in the last week of every month using the <code>auto_pay_first_nth_weekday</code> parameter. (e.g., last friday of the month)</li><li><code>due_date_monthly</code> - Payments are made on the due date provided by the client in their Consumer Account File</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

{
  "auto_pay_amount": "100",
  "auto_pay_start_date": "10/25/2023",
  "pnm_order_identifier": "85073414521"
}

Response

Autopay Schedule Created

OR

Example response

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

Changes

    • breaking

      removed the success response with the status

    • info

      api operation id schedule_auto_pay was added

    • info

      the request property site_identifier with a default value became required

    4 more changes in this revision