"EMAIL" if you want to send invoice through email. "SMS" if you want to send invoice through SMS. "WEB" if you don't want us to send invoice at all but you still need email or mobile_number. Example: ['EMAIL', 'SMS', 'WEB']

This will help you indentify a request. Example: "OO-1234-2020"

Customer email, required if request_methods is containing "EMAIL". Example: "john@doe.com"

Merchant mobile number that used to send SMS. You can buy the number in merchant dashboard. Example: "+1234567890"

Customer mobile number, required if request_methods is containing "SMS". Example: "+1234567890"

The amount of payment for this request Example: 3

The currency of this payment request in 3 digit ISO format Example: "USD"

Boolean value between true and false. If set to false, customer can specify the amount they would like to pay. Commonly used for donation payments.

Tax profile ID to calculate the tax amount for this payment. If it does not exist, the amount value will be tax free.

The Email or SMS template you would like to use with this payment. When empty, the payment request will be send using merchant's default template. If merchant does not set the default template, it will automatically send Paysley's default template.

Add optional payment_type by default it's filled with DB. Set it to "PA" to use Pre Authorization. You need to manually capture to accept the payment.

Add optional payment methods that can be used to pay this request. You can add "APPLE_PAY", "GOOGLE_PAY" in a single array

Enable MOTO card mode which have no additional authentication on payment widget

Add optional shipping information that can be filled for this request.

Use "true" if you want Paysley to help you send an invoice through MMS. (Only available for USA and Canada mobile carriers.) Other non-supported countries will send an extended SMS with an URL to download the respective invoice. You will be charged based on your MMS and SMS fee where applicable.

Use "true" if you want Paysley to attach an invoice as a file and send it through email.

The url of the invoice file. If it's not exist, the message template will be used as the invoice content.

Use "true" if you want Paysley to help you send a payment receipt through MMS or SMS. You will be charged on your MMS and SMS fee where applicable.

Use "true" if you want the payment receipt to be attached as a file and sent through email.

File type for payment receipt. Available value: "pdf/jpeg/png", default value pdf.

The expiry date for this payment request. Format = YYYY-MM-DD HH:MM

Customer ID used to update customer data if exist. Example: "h3xDi8"

Mr, Mrs, or Miss. Example: "Mr"

Customer first name. Example: "John"

Customer last name. Example: "Doe"

Use "true" if you want Paysley to help you send the confirmation sms/email after payment is succeed. Use "false" if you want to send the confirmation by yourself

Response_url is the url where customer will get the payment result. After the transaction is paid, the payment response will be posted to the response_url. Example: "http://mypaysleymerchant.com/response/"

The url where customer will redirected when customer click cancel button on payment page. Example: "https://mywebsite.com"

After payment we will redirect to this URL. If empty, we will show the receipt page instead. Example: "http://mypaysleymerchant.com/receipt/"

The frequency for the payment request. Available frequency are "ONE-TIME", "WEEKLY", "MONTHLY", "QUARTERLY", "YEARLY". The default value is ONE-TIME.

Payment start date , requested if payment_frequency is not "ONE-TIME". The value must follow the ISO8601 standard (ex:"2023-08-09T16:59:59.000Z"). Default value is empty

Initial payment amount, requested if payment_frequency is not "ONE-TIME". Default value is empty.

Total payments of recurring for customer, requested if payment_frequency is not "ONE-TIME". Default value is empty.

Additional cart items that will be created for this payment the parameter must be an array of objects with "name", "qty" and "sales_price" property.
* taxable only for the connected QuickBooks merchant, the tax_value, tax_type, tax_name will be overridden by the QuickBooks tax.. Example:

							
[
   {
       "product_service_id": "1",
       "name": "product_1",
       "sku": "p1",
       "unit": "per-item",
       "qty": 1,
       "sales_price": 5,
       "taxable": 1,
       "tax_value": 5,
       "tax_type": "fixed_amount",
       "tax_name": "Tax 5"
   },
   {
       "product_service_id": "2",
       "name": "product_2",
       "sku": "p2",
       "unit": "unit",
       "qty": 3,
       "sales_price": 2,
       "taxable": 0,
       "tax_value": 10,
       "tax_type": "percentage",
       "tax_name": "Tax 10"
    }
 ] 

						

The shipping amount for this payment request

The shipping tax for this payment request

Additional shipping address

• first_nameType: string
• last_nameType: string
• emailType: string
• mobile_noType: stringExample: +12011111111
• address_line_1Type: string
• address_line_2Type: string
• cityType: string
• stateType: string
• countryType: stringExample: US
• zipType: string

default will be always true if no payment_fee_enabled was added to parameter, set to false if you dont want payment fee added to the current payment request

default will be always true if no ach_fee_enabled was added to parameter, set to false if you dont want ach fee added to the current payment request

default will be always true if no surcharge_fee_enabled was added to parameter, set to false if you dont want surcharge fee added to the current payment request

Start search for payment history from the date entered into this parameter. The format is "YYYY-MM-DD"

You need to specify the end_date if you specify the start_date. It use the same format of "YYYY-MM-DD"

Select the payment history

Limit the amount of items fetched from payment history. The default value is 10

Search for a payment history that has the specified keyword in email, mobile number or reference number

The amount to be refunded to the customer

A refund receipt will be send to this email address if you add it.

A refund receipt will be send to this mobile number if you add it.

The amount to be captured, cannot more than the actual payment.

The currency of this payment request in 3 digit ISO format Example: ["USD","ZAR"]

After payment we will redirect to this URL. If empty, we will show the receipt page instead. Example: "http://mypaysleymerchant.com/receipt/"

Response_url is the url where customer will get the payment result. After the transaction is paid, the payment response will be posted to the response_url. Example: "http://mypaysleymerchant.com/response/"

The url where customer will redirected when customer click cancel button on payment page. Example: "https://mywebsite.com"

Tax profile ID to calculate the tax amount for this payment. If it does not exist, the amount value will be tax free.

Add additional notes for this payment.

Enable customer to input additional info using a text input.

Enable customer to input additional info by selecting an option from a select input.

Use "true" if you want the customer to be able to input tip amount.

Enable MOTO card mode which have no additional authentication on payment widget

Enable share button on payment page. Customer will be able to share the payment request to social media such as Facebook, Twitter, etc

Use "true" if you want the payment reference number to be auto generated. Else, customer will need to input reference number manually.

Add a suffix to reference number when reference number is auto generated.

Add a prefix to reference number when reference number is auto generated.

Add optional payment methods that can be used to pay this request. You can add "APPLE_PAY", "GOOGLE_PAY", or "AMEX" in a single array.

Use "true" if you want the customer to be able to make recurring payment.

The currency of this payment request in 3 digit ISO format Example: ["USD","ZAR"]

After payment we will redirect to this URL. If empty, we will show the receipt page instead. Example: "http://mypaysleymerchant.com/receipt/"

Response_url is the url where customer will get the payment result. After the transaction is paid, the payment response will be posted to the response_url. Example: "http://mypaysleymerchant.com/response/"

The url where customer will redirected when customer click cancel button on payment page. Example: "https://mywebsite.com"

Tax profile ID to calculate the tax amount for this payment. If it does not exist, the amount value will be tax free.

Add additional notes for this payment.

Enable customer to input additional info using a text input.

Enable customer to input additional info by selecting an option from a select input.

Use "true" if you want the customer to be able to input tip amount.

Enable MOTO card mode which have no additional authentication on payment widget

Enable share button on payment page. Customer will be able to share the payment request to social media such as Facebook, Twitter, etc

Use "true" if you want the payment reference number to be auto generated. Else, customer will need to input reference number manually.

Add a suffix to reference number when reference number is auto generated.

Add a prefix to reference number when reference number is auto generated.

Add optional payment methods that can be used to pay this request. You can add "APPLE_PAY", "GOOGLE_PAY" or "AMEX" in a single array.

Use "true" if you want the customer to be able to make recurring payment.

The currency of this payment request in 3 digit ISO format Example: "USD"

The payment amount for this payment link.

The tip amount for this payment link.

The payment type of this POS link. You can select between "PA" and "DB"

You can input reference number for this link

The url where customer will redirected when customer click cancel button on payment page. Example: "https://mywebsite.com"

response_url is the url where customer will get the payment result. After the transaction is paid, the payment response will be posted to the response_url. Example: "http://mypaysleymerchant.com/response/"

The URL that will be set for "return to shop" button.

After payment we will redirect to this URL. If empty, we will show the receipt page instead. Example: "http://mypaysleymerchant.com/receipt/"

Additional text input generated for this link.

Additional select input for this link.

Additional cart items that will be created for this payment the parameter must be an array of objects with "name" and "qty" property. Example:

						
[
   {
       "name": "product_1",
       "sku": "p1",
       "qty": 1,
       "unit_price": 5,
       "tax_value": 5,
       "tax_type": "fixed_amount",
       "tax_name": "Tax 5"
   },
   {
       "name": "product_2",
       "sku": "p2",
       "qty": 3,
       "unit_price": 2,
       "tax_value": 10,
       "tax_type": "percentage",
       "tax_name": "Tax 10"
    }
 ] 

					

Payment frequency to be set as recurring payment. Available option are "WEEKLY","MONTHLY""QUARTERLY","YEARLY" . Leave it if you decide to set as non recurring payment

Date when payment to be started. Required if payment_frequency not empty

Customer email. Example: "john@doe.com"

The shipping amount for this payment link.

Additional shipping address

• first_name Type: string
• last_name Type: string
• email Type: string
• mobile_no Type: string Example: +12011111111
• address_line_1 Type: string
• address_line_2 Type: string
• city Type: string
• state Type: string
• country Type: string Example: US
• zip Type: string

default will be always true if no payment_fee_enabled was added to parameter, set to false if you dont want payment fee added to the current payment request

default will be always true if no ach_fee_enabled was added to parameter, set to false if you dont want ach fee added to the current payment request

default will be always true if no surcharge_fee_enabled was added to parameter, set to false if you dont want surcharge fee added to the current payment request

Customer's email. You must fill either email or mobile_no field. Example : "john@doe.com".

Customer's mobile number. You must fill either email or mobile_no field. Example : "+1234567890".

Customer's group id. Example : "K1Z2J2Zl".

Customer's salutation. for example you can put "Mr.","Mrs.","Ms.".

Customer's first name.

Customer's last name.

Customer's company name.

Customer's ein code.

Customer's listing type. Available option are "individual" and "company".

Customer's address line 1.

Customer's address line 2.

Customer's specific description.

Customer's country ISO. Example : "US".

Customer's state. Example : "CA".

Customer's city. Example : "Los Angeles".

Customer's postal code. Example : "12345".

Customer's reference number. Example : "12345".

Customer's additional value. Example : {"age": 20, "gender": "male"}.

Profile picture for customer, Example : "base64string_image"

required

Customer group's name.

Customer group's specific description.

required

Product or Service name. Example : "Item 1".

Product or Service description.

Product or Service sku. Example : "BRW-LAR-B678-HNM".

required

Product or Service category_id. Example : 1.

required

Product or Service type. Example : "product","service".

Use "1" if you want manage your inventory stock.

Product or Service unit_in_stock. Example : 1.

Product or Service unit_low_stock. Example : 1.

Product or Service unit_type. Example : "flat-rate","per-hour","per-item".

Tax profile ID to calculate the tax amount for this product and service.

Product or Service cost. Example : 1.

required

Product or Service sales_price. Example : 1.

required

Category name. Example : "Product Category".