Understanding API Endpoints

Each endpoint in PayNearMe’s API performs a unique function to support your business operations. Even though the API supports over thirty-five endpoints, typical integrations primarily only use a few calls. The following table displays the other endpoints you can use in your payment and business flows.

Endpoint	Description
/create_order	Creates an order for the specified consumer.
/find_orders	Retrieves all orders for a specified consumer or finds a specific order using its `pnm_order_identifier`.
/get_fees	Retrieves the convenience fees associated with each payment method allowed for a specified order.
/get_smart_token	Retrieves the unique token used to initialize the PayNearMe JS Library in Embedded Client integrations.
/change_order	Gives you the ability to change an order’s specific parameters. These can include the following (see the Orders object for specific name values): Minimum Amount and Currency Order Amount and Currency Order Duration and Expiration Date Customer Attributes Order Description and Annotation Suspension Status and Reason
/suspend_order	Puts the order in a suspended status so that payments cannot be made against it.
/create_push_order	Creates a disbursement order for the specified consumer.
/unsuspend_order	Places suspended orders back into an active status so that payments can be made against it.
/cancel_order	Cancels the order.
/uncancel_order	Re-activates an order so that payments can be made against it.
/create_payment_method	Creates a payment method and returns a `payment_method_identifier`.
/find_payment_methods	Retrieves all payment methods associated with either a specified order or customer.
/update_payment_method	Gives you the ability to retire a specified payment method by passing in `retire_payment_method=true`. Payments attempted with retired payment methods are automatically declined.
/make_payment	Creates a transaction using a specified `payment_method_identifier`.
/simulate_payment	Creates a simulated cash transaction. Use this call for testing and troubleshooting.
/find_payment	Retrieves a specific payment associated with a `pnm_payment_identifier`.
/refund_payment	Returns funds to the consumer for transactions that have already been processed. For ACH payments, this is after the daily batch transfer to the bank. For cards, the cutoff time is based on the card processing network.
/reverse_payment	This call will either cancel or refund a payment. The payment will be canceled if it is within the cancellation window; otherwise, it will be refunded.
/cancel_payment	Cancels a payment that has not yet been processed. For ACH payments, this is before the daily batch transfer to the bank. For cards, the cutoff time is based on the card processing network.
/schedule_payment	Creates a one-time, future-dated transaction using a specified `payment_method_identifier`.
/cancel_scheduled_payment	Cancels a scheduled payment that has not yet been processed. Cancellation must be made prior to the `payment_date`.
/find_scheduled_payments	Retrieves the next scheduled payment for an order. These payments can include recurring payments from an autopay schedule or a future-dated, one-time payment.
/cancel_scheduled_retry	Cancels the scheduled payment retry for a specified order. This call works for both recurring autopay schedules and future-dated, one-time payment schedules.
/schedule_auto_pay	Creates a schedule of recurring payments using a specified `payment_method_identifier`.
/skip_auto_pay	Skips the next scheduled payment in an autopay schedule.
/update_auto_pay	Updates the amount of each auto payment in the schedule.
/cancel_autopay	Cancels the autopay schedule for the specified order.
/get_retailer_locations	Retrieves a list of retailer locations near the specified coordinates or address. This list can be filtered by the `retailer_identifier`.
/send_mail	Creates a customized email for the specified email address(es).
/send_notification	Creates a specific type of email and/or text notification to the specified user email address or mobile number. Required parameters include the `pnm_order_identifier` (or `site_order_identifier`) and one of the following notification types: `order_confirmation` `paid_confirmation` `user_disbursement_query`
/send_sms	Creates a customized text message for the specified mobile number(s).
/report_orders	Generates a report of orders created during a specified timeframe.
/create_user	Create a user record for disbursement orders.
/get_user	Find a user record for a disbursement order.
/change_user	Change the details of an unverified user record.
/agent_sso	Returns an authenticating token and the SSO URL where the agent can access the Business Portal and/or the specific order.