### Order Validation Callback GET Request Example Source: https://apidocs.paynearme.com/devdocs/docs/understanding-the-order-validation-callback An example of an Order Validation callback using a GET request. This shows how parameters are appended to the URL. It includes validation fields and required callback parameters. ```http https://www.merchantdomain.com/order_validation?origin=buynow&signature=4d05ddb426f492fe99999999999&site_customer_email=user%2B8326%40paynearme.com&site_customer_identifier=123488888&site_customer_language=en&site_customer_last_name=Smith&site_identifier=S1575119257&site_order_description=1970&site_order_identifier=123488888&timestamp=1449252553&version=3.0 ``` -------------------------------- ### Create a User Example Source: https://apidocs.paynearme.com/devdocs/reference/post_create-user This example demonstrates how to create a user for disbursement orders. It shows the expected JSON response structure, including user details and status. ```json { "status": "ok", "user": { "user_type": "push", "push_user_identifier": 89652341, "pnm_user_identifier": "U2021809909", "push_user_status": "ok_to_receive", "push_first_name": "Raul", "push_middle_name": "Diego", "push_last_name": "Sanchez", "push_full_name": "Raul Diego Sanchez", "push_street": "123 Fake Street", "push_city": "Allen", "push_state": "TX", "push_postal_code": 75013, "push_country": "US", "push_year_of_birth": 1977, "push_pre_verified": false, "push_manually_verified": false } } ``` -------------------------------- ### Create Monthly Autopay Schedule Example Source: https://apidocs.paynearme.com/devdocs/reference/post_schedule-auto-pay This example demonstrates how to create a monthly autopay schedule using the PayNearMe API. It includes details such as the payment amount, frequency, start date, and associated payment method. ```json { "status": "ok", "order": { "site_name": "Readme API", "site_logo_url": "https://www.paynearme-sandbox.com", "site_order_identifier": 535750000, "site_identifier": "S2411573363", "require_auth_tracker": false, "pnm_order_crid": "iPcIYV", "pnm_customer_language": "en", "pnm_order_identifier": 85073414521, "pnm_order_short_identifier": "I9CSMZ", "site_order_key": 535750000, "order_created": "2023-10-18 14:27:45 -0700", "order_status": "open", "order_amount": 15000, "order_currency": "USD", "minimum_payment_amount": 0, "minimum_payment_currency": "USD", "order_type": "any", "order_is_standing": true, "secure_smart_token": "T7LxwDhYr2pfb0WKNhi$0zBJPodSQRMZfv2SYYvTCBi3T3BEWLCXywCiMPq8iJFV", "secure_smart_link": "https://www.paynearme-sandbox.com/ssl/T7LxwDhYr2pfb0WKNhi$0zBJPodSQRMZfv2SYYvTCBi3T3BEWLCXywCiMPq8iJFV", "order_tracking_url": "https://www.paynearme-sandbox.com/85073414521", "auto_pay": { "auto_pay_identifier": 378865941675879, "auto_pay_description": "the 19th of every month", "auto_pay_frequency": "monthly", "auto_pay_start_date": "2023-10-19T00:00:00.000Z", "auto_pay_duration_type": "paid_in_full", "auto_pay_status": "pending", "auto_pay_number_of_recurrences_done": 0, "auto_pay_next_date": "2023-10-19T00:00:00.000Z", "auto_pay_amount": 100, "auto_pay_payment_method_identifier": "b705067a8fdd4", "auto_pay_payment_method_description": "Safeamerica Credit Union 2634" }, "electronic_payments": { "embedded_js_url": "https://www.paynearme-sandbox.com/api/embedded/MERCx8D4hVMXacjBUSdzhA/script.js", "payment_methods": [ { "type": "card", "card_type": "visa", "last_four": "1234", "expiration_month": 12, "expiration_year": 2025, "payment_method_identifier": "b705067a8fdd4", "payment_method_description": "Safeamerica Credit Union 2634" } ] } } } ``` -------------------------------- ### Find User Example Source: https://apidocs.paynearme.com/devdocs/reference/post_get-user Provides an example of a successful response when finding a user. It includes the user's status and a detailed User object with populated fields. ```json { "status": "ok", "user": { "user_type": "push", "push_user_identifier": 10101010, "pnm_user_identifier": "U6454139362", "push_user_status": "ok_to_receive", "push_first_name": "Bertha", "push_middle_name": "Nadine", "push_last_name": "Green", "push_full_name": "Bertha Nadine Green", "push_street": "5201 Great America Pkwy", "push_city": "Santa Clara", "push_state": "CA", "push_postal_code": 95054, "push_country": "US", "push_year_of_birth": 1965, "push_pre_verified": false, "push_manually_verified": false } } ``` -------------------------------- ### Create Order Example (JSON) Source: https://apidocs.paynearme.com/devdocs/reference/post_create-order An example JSON payload demonstrating the structure of a successful order creation response. This includes details about the order itself, payment methods, and associated fees. ```json { "status": "ok", "orders": { "site_name": "Readme API", "site_logo_url": "https://www.paynearme-sandbox.com", "site_identifier": "S2411573363", "require_auth_tracker": false, "pnm_order_crid": "cyu9Qg", "pnm_customer_language": "en", "pnm_order_identifier": 85237034088, "pnm_order_short_identifier": "LSN19S", "site_order_key": 567060000, "order_created": "2023-09-20 21:36:15 -0700", "order_status": "open", "order_amount": 500, "order_currency": "USD", "minimum_payment_amount": 0, "minimum_payment_currency": "USD", "order_type": "any", "order_is_standing": true, "secure_smart_token": "xjgMf$pmFsoz!PETcMdkgKYN97yiSECqeT!aUzPM5rEWqOWt6hBwmpf2V$RsYN2n", "secure_smart_link": "https://www.paynearme-sandbox.com/ssl/xjgMf$pmFsoz!PETcMdkgKYN97yiSECqeT!aUzPM5rEWqOWt6hBwmpf2V$RsYN2n", "order_tracking_url": "https://www.paynearme-sandbox.com/85237034088", "electronic_payments": { "embedded_js_url": "https://www.paynearme-sandbox.com/api/embedded/fxeEbPpbTVhgg5GZLIdafg/script.js", "payment_methods": [ { "type": "apple_pay_debit", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "apple_pay_credit", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "gpay", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "paypal", "fee_amount": "2.99", "fee_currency": "USD", "accounts": [] }, { "type": "venmo", "fee_amount": "2.99", "fee_currency": "USD", "accounts": [] } ] } } } ``` -------------------------------- ### Get Smart Token Response Example Source: https://apidocs.paynearme.com/devdocs/reference/post_get-smart-token This example demonstrates the structure of a successful response when retrieving a 'smart token' for an order. It includes the order status and details such as the PayNearMe order identifier, site order identifier, secure smart token, secure smart link, and order tracking URL. ```json { "status": "ok", "orders": { "pnm_order_identifier": "84338052224", "site_order_identifier": "993720000", "secure_smart_token": "UIfa4Yj4tqFOAsWRcQqDB08k3vgP9qQkS1Gy$IXmWwdl1qcd1nRLi49U$SOZ5OGd", "secure_smart_link": "https://www.paynearme-sandbox.com/ssl/UIfa4Yj4tqFOAsWRcQqDB08k3vgP9qQkS1Gy$IXmWwdl1qcd1nRLi49U$SOZ5OGd", "order_tracking_url": "https://www.paynearme-sandbox.com/84338052224" } } ``` -------------------------------- ### Get Convenience Fees Example Source: https://apidocs.paynearme.com/devdocs/reference/post_get-fees An example JSON response demonstrating how convenience fees are structured for different payment methods (ACH, Credit, Debit). It includes consumer, merchant, and total fee amounts and currencies. ```json { "status": "ok", "payment_methods": [ { "type": "ach", "fees": { "consumer_fee_amount": 10, "consumer_fee_currency": "USD", "merchant_fee_amount": 0, "merchant_fee_currency": "USD", "total_fee_amount": 10, "total_fee_currency": "USD" } }, { "type": "credit", "fees": { "consumer_fee_amount": 0, "merchant_fee_amount": 0.4, "merchant_fee_currency": "USD", "total_fee_amount": 0.4, "total_fee_currency": "USD" } }, { "type": "debit", "fees": { "consumer_fee_amount": 0, "merchant_fee_amount": 0.4, "merchant_fee_currency": "USD", "total_fee_amount": 0.4, "total_fee_currency": "USD" } } ] } ``` -------------------------------- ### Cancel an Order Example Source: https://apidocs.paynearme.com/devdocs/reference/post_cancel-order Provides an example of how to cancel an existing order. This includes the expected response structure with a status and order details. ```json { "status": "ok", "orders": { "site_name": "Readme API", "site_logo_url": "https://www.paynearme-sandbox.com" } } ``` -------------------------------- ### Create Push Order Example Source: https://apidocs.paynearme.com/devdocs/reference/post_create-push-order This example demonstrates how to create a 'Push Order' using the PayNearMe API. It includes details about the order amount, currency, payment methods, and customer information. The response shows the status of the order and its associated details. ```json { "status": "ok", "order": { "site_name": "Readme API", "site_logo_url": "https://www.paynearme-sandbox.com", "type": "push_order", "site_identifier": "S2411573363", "require_auth_tracker": false, "pnm_order_crid": "ye6Yo1", "pnm_customer_language": "en", "pnm_order_identifier": 58920461602, "pnm_order_short_identifier": "0XGSEH", "site_order_key": 44455588, "disbursement_status": "queried_user", "order_created": "2023-11-13 11:52:43 -0800", "order_status": "open", "order_amount": 500, "order_currency": "USD", "minimum_payment_amount": 500, "minimum_payment_currency": "USD", "order_type": "exact", "order_is_standing": false, "pnm_balance_due_amount": 500, "pnm_balance_due_currency": "USD", "order_tracking_url": "https://www.paynearme-sandbox.com/add_card/7aPbPPIpGVWtuUxqam1vV5Y4bKtCKkH!", "electronic_payments": { "embedded_js_url": "https://www.paynearme-sandbox.com/api/embedded/AgpNEgQLF9h2BmduUf6UBg/script.js", "payment_methods": [ { "type": "ach_push", "payment_type_identifier": "FM354385305", "description": "Evolve ACH Push", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "push_debit", "payment_type_identifier": "FM914669222", "description": "TabaPay Push Debit", "fee_amount": "0.50", "fee_currency": "USD", "accounts": [] }, { "type": "paypal_push", "payment_type_identifier": "FM342650939", "description": "PayPal Push", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "venmo_push", "payment_type_identifier": "FM634801251", "description": "Venmo Push", "fee_amount": "0.00", "fee_currency": "USD" } ], "customer": { "pnm_customer_identifier": "U8226685647", "site_customer_identifier": 44455588, "pnm_customer_phone": 2145555897, "pnm_customer_addressee": 2145555897, "pnm_customer_street": "5550 Saint Marge Street", "pnm_customer_city": "Frisco", "pnm_customer_state": "TX", "pnm_customer_postal_code": 75035, "pnm_customer_language": "en" }, "users": { "user_type": "push" } } } } ``` -------------------------------- ### Update an Autopay Schedule Example Source: https://apidocs.paynearme.com/devdocs/reference/post_update-auto-pay An example demonstrating how to update an autopay schedule, including the request and the expected response structure. ```APIDOC ## Update an Autopay Schedule ### Description This example shows a successful request to update an existing autopay schedule and the corresponding response. ### Request Example ```json { "status": "ok", "order": { "site_name": "Readme API", "site_logo_url": "https://www.paynearme-sandbox.com/photos/emit_image/vSCu11nS9x", "site_order_identifier": 919390000, "type": "order", "site_identifier": "S2411573363", "require_auth_tracker": false, "pnm_order_crid": "dhoH3z", "pnm_customer_language": "en", "pnm_order_identifier": 85754997031, "pnm_order_short_identifier": "IRFSCV", "site_order_key": 919390000, "order_created": "2024-05-13 20:26:14 -0700", "order_status": "open", "order_amount": 15000, "order_currency": "USD", "minimum_payment_amount": 0, "minimum_payment_currency": "USD", "order_type": "any", "order_is_standing": true, "secure_smart_token": "zXCx0rJf1MYJ9WQYiuyopKkwnAcX6cl8DbJiuFnGUXStzQmWNJFSqpHkVX!jiDBT", "secure_smart_link": "https://www.paynearme-sandbox.com/ssl/zXCx0rJf1MYJ9WQYiuyopKkwnAcX6cl8DbJiuFnGUXStzQmWNJFSqpHkVX!jiDBT", "order_tracking_url": "https://www.paynearme-sandbox.com/85754997031", "auto_pay": { "auto_pay_identifier": 48670354419134, "auto_pay_description": "the 14th of every month", "auto_pay_frequency": "monthly", "auto_pay_start_date": "2024-05-14T00:00:00.000Z", "auto_pay_duration_type": "number_of_recurrences", "auto_pay_status": "active", "auto_pay_number_of_recurrences_planned": 15, "auto_pay_number_of_recurrences_done": 0, "auto_pay_next_date": "2024-05-14T00:00:00.000Z", "auto_pay_amount": 150, "auto_pay_payment_method_identifier": "42f3942a5d4c5", "auto_pay_payment_method_description": "Debit Card 5206" }, "electronic_payments": { "embedded_js_url": "https://www.paynearme-sandbox.com/api/embedded/ipZc2EliOQtNInZAQzFTVQ/script.js", "payment_methods": [ { "type": "apple_pay_debit", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "apple_pay_credit", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "gpay", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "paypal", "fee_amount": "2.99", "fee_currency": "USD" } ] } } } ``` ### Response Example (Success) ```json { "status": "ok", "order": { "site_name": "Readme API", "site_logo_url": "https://www.paynearme-sandbox.com/photos/emit_image/vSCu11nS9x", "site_order_identifier": 919390000, "type": "order", "site_identifier": "S2411573363", "require_auth_tracker": false, "pnm_order_crid": "dhoH3z", "pnm_customer_language": "en", "pnm_order_identifier": 85754997031, "pnm_order_short_identifier": "IRFSCV", "site_order_key": 919390000, "order_created": "2024-05-13 20:26:14 -0700", "order_status": "open", "order_amount": 15000, "order_currency": "USD", "minimum_payment_amount": 0, "minimum_payment_currency": "USD", "order_type": "any", "order_is_standing": true, "secure_smart_token": "zXCx0rJf1MYJ9WQYiuyopKkwnAcX6cl8DbJiuFnGUXStzQmWNJFSqpHkVX!jiDBT", "secure_smart_link": "https://www.paynearme-sandbox.com/ssl/zXCx0rJf1MYJ9WQYiuyopKkwnAcX6cl8DbJiuFnGUXStzQmWNJFSqpHkVX!jiDBT", "order_tracking_url": "https://www.paynearme-sandbox.com/85754997031", "auto_pay": { "auto_pay_identifier": 48670354419134, "auto_pay_description": "the 14th of every month", "auto_pay_frequency": "monthly", "auto_pay_start_date": "2024-05-14T00:00:00.000Z", "auto_pay_duration_type": "number_of_recurrences", "auto_pay_status": "active", "auto_pay_number_of_recurrences_planned": 15, "auto_pay_number_of_recurrences_done": 0, "auto_pay_next_date": "2024-05-14T00:00:00.000Z", "auto_pay_amount": 150, "auto_pay_payment_method_identifier": "42f3942a5d4c5", "auto_pay_payment_method_description": "Debit Card 5206" }, "electronic_payments": { "embedded_js_url": "https://www.paynearme-sandbox.com/api/embedded/ipZc2EliOQtNInZAQzFTVQ/script.js", "payment_methods": [ { "type": "apple_pay_debit", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "apple_pay_credit", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "gpay", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "paypal", "fee_amount": "2.99", "fee_currency": "USD" } ] } } } ``` ``` -------------------------------- ### Example: Find All Customer Payment Methods Source: https://apidocs.paynearme.com/devdocs/reference/post_find-payment-methods This example demonstrates how to retrieve all payment methods associated with a specific customer. It returns a JSON object containing the status and an array of account objects, each detailing a payment method. ```json { "status": "ok", "account": [ { "payment_method_identifier": "a958bf1779193", "status": "active", "name": "Dusty Vazquez", "description": "Norstar Federal Credit Union", "account_type": "Personal Checking", "number": "2471", "fee_amount": "10.00", "fee_currency": "USD" }, { "payment_method_identifier": "c687f6f0baa23", "status": "active", "name": "Carlee Crawford", "description": "Debit Card", "account_type": "Debit", "number": "0725", "fee_amount": "4.99", "fee_currency": "USD" }, { "payment_method_identifier": "af781aa3c8200", "status": "active", "name": "Tristan Diaz", "description": "Credit Card", "account_type": "Credit", "number": "0655", "fee_amount": "10.99", "fee_currency": "USD" } ] } ``` -------------------------------- ### Example: Find All Order Payment Methods Source: https://apidocs.paynearme.com/devdocs/reference/post_find-payment-methods This example shows how to retrieve all payment methods associated with a specific order. The response includes the status and an array of account objects, detailing each payment method linked to the order. ```json { "status": "ok", "account": [ { "payment_method_identifier": "10af09718d2c0", "status": "active", "name": "Ethan Clark", "description": "Credit Card", "account_type": "Credit", "number": "4135", "fee_amount": "10.99", "fee_currency": "USD" } ] } ``` -------------------------------- ### Schedule a Payment Example Source: https://apidocs.paynearme.com/devdocs/reference/post_schedule-payment This example demonstrates how to schedule a payment using the Paynearme API. It includes the necessary fields for a one-time payment, such as date, amount, currency, payment method, and origin. ```json { "status": "ok", "scheduled_payment": { "pnm_scheduled_payment_identifier": "466410151625253", "scheduled_payment_date": "2023-10-19T00:00:00.000Z", "scheduled_payment_amount": "250.00", "scheduled_payment_currency": "USD", "scheduled_payment_status": "active", "scheduled_payment_pricing_schedule_name": "agent", "scheduled_payment_payment_method": "Bank of Glen Ullin 6816", "scheduled_payment_service_fee": "0.00", "scheduled_payment_origin": "merchant", "scheduled_payment_created_by": "Merchant", "scheduled_payment_type": "one_time", "scheduled_payment_retry_pending": false } } ``` -------------------------------- ### Reverse Full Payment Amount Example Source: https://apidocs.paynearme.com/devdocs/reference/post_reverse-payment This example demonstrates the API response for reversing a payment in full, including cases where the payment has been settled. It shows the 'refunded' status and details of the refund. ```json { "status": "ok", "payment": { "payment_made": "2023-10-03 13:19:59 -0700", "payment_amount": "60.99", "payment_currency": "USD", "payment_status": "refunded", "payment_type": "credit", "payment_account": "Credit Card 4411", "payment_method_identifier": "60955901bd92d", "net_payment_amount": "50.00", "net_payment_currency": "USD", "payment_processing_fee": "10.99", "payment_processing_fee_currency": "USD", "pnm_processing_fee": "10.99", "pnm_processing_fee_currency": "USD", "settled_to_site": "true", "date_settled_to_merchant": "2023-10-11T00:00:00.000Z", "pnm_payment_identifier": "890194387244", "retailer_identifier": "FM941470905", "pricing_schedule_name": "consumer", "site_channel": "consumer", "merchant_settlements": { "merchant_settlement": { "settlement_method_identifier": "SM397064850", "settlement_type": "net_payment", "settlement_amount": "50.00", "settlement_currency": "USD" } }, "refund": { "refund_status": "started", "refund_amount": "60.99", "refund_currency": "USD", "unsettle_to_merchant_amount": "50.00", "unsettle_to_merchant_currency": "USD", "unsettled_from_collector_amount": "0.00" } } } ``` -------------------------------- ### Example Payment Response Source: https://apidocs.paynearme.com/devdocs/reference/post_make-payment Provides an example of a successful payment response. It includes details about the payment status, amount, currency, type, and associated fees, as well as settlement and identifier information. ```json { "status": "ok", "payment": { "payment_made": "2023-08-22 13:41:31 -0700", "payment_amount": "504.99", "payment_currency": "USD", "payment_status": "approved", "payment_type": "debit", "payment_account": "Debit Card 3136", "payment_method_identifier": "c5f2addb3aa90", "net_payment_amount": "500.00", "net_payment_currency": "USD", "payment_processing_fee": "4.99", "payment_processing_fee_currency": "USD", "pnm_processing_fee": "4.99", "pnm_processing_fee_currency": "USD", "settled_to_site": "false", "date_settled_to_merchant": "", "pnm_payment_identifier": "962919403677", "retailer_identifier": "FM346217710", "site_payment_identifier": "0123456789", "pricing_schedule_name": "consumer", "site_channel": "consumer" } } ``` -------------------------------- ### Revalidation Callback Setup Details Source: https://apidocs.paynearme.com/devdocs/docs/understanding-the-order-validation-callback Details on setting up the Revalidation callback, including revalidation window, error handling, and order suspension behavior. ```APIDOC ## Revalidation Callback Setup Details ### Description Provides specific configuration options for the Revalidation callback, such as the revalidation frequency, error handling strategy, and support for order suspension. ### Method POST (implied by callback mechanism) ### Endpoint Configured within the PayNearMe Business Portal under Callbacks > Configure > Status. ### Parameters #### Query Parameters * **Revalidation window** (integer) - Required - The time in seconds PayNearMe will wait before making a subsequent Revalidation callback to refresh data. Minimum recommended is 300 seconds. * **Behavior regarding callback errors/exceptions** (boolean) - Required - If enabled, callback errors will suspend the customer account. If disabled, non-error responses are treated as approval. * **Do you want to support order suspension from RVC?** (boolean) - Required - If enabled, returning `STOP` in the approval field will suspend the customer account. If disabled (auto-pilot mode), all non-error responses are treated as approval (`GO`). ### Request Example (No direct request example as this is a configuration setting within the PayNearMe portal) ### Response #### Success Response (200) (Callback responses are handled by the configured Order Validation URL) #### Response Example (Callback responses are handled by the configured Order Validation URL) ``` -------------------------------- ### Reverse an Unsettled Payment Example Source: https://apidocs.paynearme.com/devdocs/reference/post_reverse-payment This example shows the API response when an unsettled payment is reversed. It includes details of the original payment and confirms the cancellation. ```json { "status": "ok", "payment": { "payment_made": "2023-10-16 12:16:24 -0700", "payment_amount": "504.99", "payment_currency": "USD", "payment_status": "canceled", "payment_type": "debit", "payment_account": "Dredit Card 3867", "payment_method_identifier": "6d527f53e18e2", "net_payment_amount": "500.00", "net_payment_currency": "USD", "payment_processing_fee": "4.99", "payment_processing_fee_currency": "USD", "pnm_processing_fee": "4.99", "pnm_processing_fee_currency": "USD", "settled_to_site": "false", "date_settled_to_merchant": "", "pnm_payment_identifier": "369734463517", "retailer_identifier": "FM346217710", "pricing_schedule_name": "consumer", "site_channel": "consumer", "merchant_settlements": { "merchant_settlement": { "settlement_method_identifier": "SM397064850", "settlement_type": "net_payment", "settlement_amount": "500.00", "settlement_currency": "USD" } } } } ``` -------------------------------- ### Set Up Error - Merchant Source: https://apidocs.paynearme.com/devdocs/docs/paypalvenmo-decline-codes Depending on your region, this response could indicate a connectivity or setup issue. ```APIDOC ## Set Up Error - Merchant ### Description Depending on your region, this response could indicate a connectivity or setup issue. ### Method N/A (This is a decline reason, not an API endpoint) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Decline Reason (Example) - **Reason**: Set Up Error - Merchant - **Description**: Depending on your region, this response could indicate a connectivity or setup issue. #### Response Example N/A ``` -------------------------------- ### Send Notification Example (JSON) Source: https://apidocs.paynearme.com/devdocs/reference/post_send-notification Example of sending a notification via the Paynearme API. This payload is used to confirm orders or payments, or to initiate a disbursement query. ```json { "status": "ok", "order": { "disbursement_query_url": "https://www.paynearme-sandbox.com/add_card/P!GZqioXu3kLJqm21NvPOB$uXW7sZuUu", "disbursement_status": "queried_user" } } ``` -------------------------------- ### Suspend Order Response Example (JSON) Source: https://apidocs.paynearme.com/devdocs/reference/post_suspend-order Provides an example of a successful response when an order is suspended via the PayNearMe API. It includes a status field and the identifier of the suspended order. ```json { "status": "ok", "order_suspended": 83965029698 } ``` -------------------------------- ### Create an ACH Payment Method Source: https://apidocs.paynearme.com/devdocs/reference/post_create-payment-method This example demonstrates how to create an ACH payment method for an order. It includes details about the order, available electronic payment methods, and associated fees. ```APIDOC ## POST /api/orders ### Description Creates a new order and provides details on available payment methods, including ACH. ### Method POST ### Endpoint /api/orders ### Parameters #### Query Parameters - **site_identifier** (string) - Required - The unique identifier for the site. - **site_order_identifier** (string) - Required - The identifier for the order on the site. - **order_amount** (string) - Required - The total amount of the order. - **order_currency** (string) - Required - The currency of the order (e.g., USD). #### Request Body (This endpoint typically does not require a request body for basic order creation, but may accept additional parameters for specific configurations.) ### Request Example ```json { "site_name": "Freehold Financial", "site_logo_url": "https://www.paynearme-sandbox.com/photos/emit_image/Xjnig1fZEz", "site_order_identifier": "517740000", "site_identifier": "S1534916073", "require_auth_tracker": false, "pnm_customer_language": "en", "order_amount": "500.00", "order_currency": "USD", "order_type": "any", "order_is_standing": true } ``` ### Response #### Success Response (200) - **status** (string) - The status of the operation (e.g., "ok"). - **order** (object) - Contains detailed information about the created order, including payment methods and links. - **site_name** (string) - The name of the site. - **site_logo_url** (string) - The URL of the site's logo. - **site_order_identifier** (string) - The identifier for the order on the site. - **site_identifier** (string) - The unique identifier for the site. - **require_auth_tracker** (boolean) - Indicates if authentication tracking is required. - **pnm_order_crid** (string) - PayNearMe's internal order reference ID. - **pnm_customer_language** (string) - The customer's preferred language. - **pnm_order_identifier** (string) - PayNearMe's unique order identifier. - **pnm_order_short_identifier** (string) - A shorter version of PayNearMe's order identifier. - **site_order_key** (string) - The key for the order on the site. - **order_created** (string) - The timestamp when the order was created. - **order_status** (string) - The current status of the order (e.g., "open"). - **order_amount** (string) - The total amount of the order. - **order_currency** (string) - The currency of the order. - **minimum_payment_amount** (string) - The minimum payment amount accepted. - **minimum_payment_currency** (string) - The currency of the minimum payment amount. - **order_type** (string) - The type of order. - **order_is_standing** (boolean) - Indicates if the order is a standing order. - **secure_smart_token** (string) - A security token for smart payments. - **secure_smart_link** (string) - A link for secure smart payments. - **order_tracking_url** (string) - The URL for tracking the order. - **electronic_payments** (object) - Details about available electronic payment methods. - **embedded_js_url** (string) - URL for embedded JavaScript for payment processing. - **payment_methods** (array) - A list of available payment methods. - **type** (string) - The type of payment method (e.g., "apple_pay_debit", "paypal"). - **fee_amount** (string) - The fee associated with the payment method. - **fee_currency** (string) - The currency of the fee. - **accounts** (array) - List of associated accounts (if any). #### Response Example ```json { "status": "ok", "order": { "site_name": "Freehold Financial", "site_logo_url": "https://www.paynearme-sandbox.com/photos/emit_image/Xjnig1fZEz", "site_order_identifier": "517740000", "site_identifier": "S1534916073", "require_auth_tracker": false, "pnm_order_crid": "i3wgOF", "pnm_customer_language": "en", "pnm_order_identifier": "83994195516", "pnm_order_short_identifier": "IC7E87", "site_order_key": "517740000", "order_created": "2023-08-21 14:56:45 -0700", "order_status": "open", "order_amount": "500.00", "order_currency": "USD", "minimum_payment_amount": "0.00", "minimum_payment_currency": "USD", "order_type": "any", "order_is_standing": true, "secure_smart_token": "sPTz7DSiB8t49agPLnIZzgvdGESQwT41odc5Bt9xVPj$xkHOICfsVibgBujdsFfF", "secure_smart_link": "https://www.paynearme-sandbox.com/ssl/sPTz7DSiB8t49agPLnIZzgvdGESQwT41odc5Bt9xVPj$xkHOICfsVibgBujdsFfF", "order_tracking_url": "https://www.paynearme-sandbox.com/83994195516\", "electronic_payments": { "embedded_js_url": "https://www.paynearme-sandbox.com/api/embedded/QMdab6SYWkhv9TGDRQSVGw/script.js", "payment_methods": [ { "type": "apple_pay_debit", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "apple_pay_credit", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "gpay", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "paypal", "fee_amount": "2.99", "fee_currency": "USD", "accounts": [] }, { "type": "venmo", "fee_amount": "2.99", "fee_currency": "USD", "accounts": [] }, { "type": "debit", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] } ] } } } ``` ``` -------------------------------- ### Reverse Partial Settled Payment Example Source: https://apidocs.paynearme.com/devdocs/reference/post_reverse-payment This example illustrates the API response when a settled payment is reversed for a partial amount. It details the original payment and the partial refund initiated. ```json { "status": "ok", "payment": { "payment_made": "2023-08-22 13:41:31 -0700", "payment_amount": "504.99", "payment_currency": "USD", "payment_status": "refunded", "payment_type": "debit", "payment_account": "Debit Card 3136", "payment_method_identifier": "c5f2addb3aa90", "net_payment_amount": "500.00", "net_payment_currency": "USD" } } ``` -------------------------------- ### Cancel Autopay Schedule Example Source: https://apidocs.paynearme.com/devdocs/reference/post_cancel-auto-pay This example demonstrates how to cancel an existing autopay schedule. It shows the expected JSON response structure, including order details and autopay status. ```json { "status": "ok", "order": { "site_name": "Readme API", "site_logo_url": "https://www.paynearme-sandbox.com", "site_order_identifier": 535750000, "site_identifier": "S2411573363", "require_auth_tracker": false, "pnm_order_crid": "iPcIYV", "pnm_customer_language": "en", "pnm_order_identifier": 85073414521, "pnm_order_short_identifier": "I9CSMZ", "site_order_key": 535750000, "order_created": "2023-10-18 14:27:45 -0700", "order_status": "open", "order_amount": 15000, "order_currency": "USD", "minimum_payment_amount": 0, "minimum_payment_currency": "USD", "order_type": "any", "order_is_standing": true, "secure_smart_token": "T7LxwDhYr2pfb0WKNhi$0yjgB8QkuFx0nZlamUxVW9UBYPUbvYF4GpFcuRZ8sA65", "secure_smart_link": "https://www.paynearme-sandbox.com/ssl/T7LxwDhYr2pfb0WKNhi$0yjgB8QkuFx0nZlamUxVW9UBYPUbvYF4GpFcuRZ8sA65", "order_tracking_url": "https://www.paynearme-sandbox.com/85073414521", "auto_pay": { "auto_pay_identifier": 378865941675977, "auto_pay_description": "every Wednesday - SCHEDULE SUSPENDED", "auto_pay_frequency": "weekly", "auto_pay_start_date": "2024-04-03T00:00:00.000Z", "auto_pay_duration_type": "indefinite", "auto_pay_status": "disabled", "auto_pay_number_of_recurrences_done": 0, "auto_pay_next_date": "2024-04-03T00:00:00.000Z", "auto_pay_amount": 100 }, "electronic_payments": { "embedded_js_url": "https://www.paynearme-sandbox.com/api/embedded/n5BN_naz5TL1UZhveEpPZQ/script.js", "payment_methods": [ { "type": "apple_pay_debit", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "apple_pay_credit", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "gpay", "fee_amount": "0.00", "fee_currency": "USD", "accounts": [] }, { "type": "paypal", "fee_amount": "2.99", "fee_currency": "USD", "accounts": [] }, { "type": "venmo", "fee_amount": "2.99", "fee_currency": "USD", "accounts": [] }, { "type": "debit", "fee_amount": "4.99", "fee_currency": "USD", "accounts": [] }, { "type": "credit", "fee_amount": "10.99", "fee_currency": "USD", "accounts": { "payment_method_identifier": "4592b8cce0c04", "status": "active" } } ] } } } ``` -------------------------------- ### Set-Up Error - Hierarchy Source: https://apidocs.paynearme.com/devdocs/docs/paypalvenmo-decline-codes This error code indicates a setup issue related to transaction hierarchy. ```APIDOC ## Set-Up Error - Hierarchy ### Description This error code indicates a setup issue related to transaction hierarchy. ### Method N/A (This is a decline reason, not an API endpoint) ### Endpoint N/A ### Parameters N/A ### Request Example N/A ### Response #### Decline Reason (Example) - **Reason**: Set-Up Error - Hierarchy - **Description**: Indicates a setup issue related to transaction hierarchy. #### Response Example N/A ```