/create_push_order

post

https://api.paynearme-sandbox.com/json-api/create_push_order

Like orders, push_orders are a description of a payment obligation--the client's obligation to disburse funds to the consumer. Funds are disbursed to verified debit cards, bank accounts, or Paypal or Venmo wallets. Clients can opt to perform their own verification of the consumer or can use PayNearMe's verification services. The person who receives funds is known as a user and is identified with a push_user_identifier. Users can be created while creating the push_order or can be created in a separate /create_user call. Additionally, if you have the consumer/user's payment method information, you can use the send_payment option to immediately disburse the funds to his/her/their debit card, bank account, or mobile wallet.

Body Params

site_identifier

string

required

Identifies your client site.

timestamp

string

required

The Unix Epoch time of the call

version

string

required

Defaults to 3.0

The version of the API. This version must match the version associated with your API key pair.

signature

string

required

The HMAC signature that is calculated by running your API Secret Key and the alphabetized, concatenated parameters of the request payload through the SHA256 message digest algorithm.

order_amount

string

required

The decimal amount of the order.

order_currency

string

required

Defaults to USD

USD

site_customer_identifier

string

required

A unique, client-created string that identifies the customer.

site_order_identifier

string

A unique, client-created string that identifies the order.

push_user_identifier

string

required

A unique, client-created string that identifies the user receiving the disbursement funds.

site_order_annotation

string

Use this parameter to pass back additional information about the order. The values passed in this field are available in receipt text, macros, and the confirmation verbiage that displays in approve response.

site_order_notes

string

Contains text relevant to the order which displays in the Business Portal and Agent Interface when viewing the order.

site_customer_phone

string

The consumer’s mobile phone number.

site_customer_email

string

The consumer's email address.

site_customer_language

string

enum

Specifies whether the consumer’s preferred language is

en = English
sp = Spanish

Allowed:

push_first_name

string

The user's first name.

push_last_name

string

The user's last name.

push_year_of_birth

string

The user's four-digit year of birth (i.e., YYYY)

push_street

string

The user's street address from his/her billing address.

push_city

string

The user's city from his/her billing address.

push_postal_code

string

The user's ZIP code from his/her billing address.

push_country

string

The user's two-digit country code from his/her billing address.

payment_method_billing_name

string

The name of the account holder associated with the card or bank account.

payment_method_billing_phone

string

The phone number of the account holder associated with this card or bank account.

payment_method_year_of_birth

string

The user's four-digit year of birth (i.e., YYYY).

payment_method_billing_address

string

The billing street address associated with the card or bank account.

payment_method_billing_zipcode

string

The 5- or 9-digit billing ZIP code associated with the card or bank account.

payment_method_type

string

enum

The type of payment method where the funds for this push order will be disbursed. Supported options include the following:

ach
card
paypal
venmo

Allowed:

payment_method_card_number_pii

string

The PAN of the debit card.

payment_method_card_expiry_pii

string

The expiration date of the debit card in MM/YYYY format.

payment_method_cvv_pii

string

The card verification value (CVV) of the credit or debit card.

payment_method_ach_aba_pii

string

The routing number associated with this bank account.

payment_method_ach_account_pii

string

The account number associated with this bank account.

payment_method_account_type

string

enum

The type of bank account.

Allowed:

return_minimal_info

string

If set to true, PayNearMe will only return the pnm_order_identifier and pnm_customer_identifier.

send_payment

string

Set to true to make a payment for this order at the same time you are creating the payment method.

payment_amount

string

The payment amount you are making towards the specified order. Required if send_payment=true.

payment_currency

string

USD

pricing_schedule_name

string

Specifies the name of the pricing schedule (e.g.,agent, agent_recurring, consumer, consumer_recurring,consumer_ivr). Supported values can include site-configured pricing schedules.

notification_contact

string

The email or mobile number that PayNearMe will contact to confirm completion of the payment.

Response

201Push Order Created