A PAYARC-hosted payment page that helps collect payments quickly. It works across devices and is designed to increase conversion. Checkout makes it easy to build a first-class payments experience.
One-Time Checkout
This checkout is valid for one time only. Provide the "payment_form_url" value from the response to the customers. The customers can use that URL to open the checkout page on any browser to make payments.
Payment Parameters
amount
-
Type:
integer -
Description: A positive integer in cents representing how much to charge.
-
Required: Yes
-
Format: Numeric (in cents)
-
Min Length: 1
-
Max Length: 8
-
Example:
9would be$0.0999999999would be$999,999.99
-
Note: The minimum amount is $0.50 USD when testing in the test environment.
surcharge_percent
-
Type:
integer -
Description: A positive integer representing the surcharge percentage to be added for the charge.
-
Required: Conditional
-
Format: Numeric
-
Min Length: 0
-
Max Length: 4
-
Note:
surcharge_fixedshould not be present withsurcharge_percent.
surcharge_fixed
-
Type:
integer -
Description: A positive integer in cents representing a flat surcharge fee to be added to the amount.
-
Required: Conditional
-
Format: Numeric
-
Min Length: 1
-
Max Length: 8
-
Example:
9would be$0.0999999999would be$999,999.99
-
Note:
surcharge_percentshould not be present withsurcharge_fixed.
payment_method
-
Type:
string -
Description: If the field is present in the input data, it must not be empty or null.
-
Required: Optional
-
Format: String
-
Min Length: 1
-
Max Length: 250
currency
-
Type:
string -
Description: Three-letter ISO currency code, in lowercase.
-
Required: Optional. If the field is present in the input data, it must not be empty and must be
usd. -
Format: Alphabetic
-
Enumeration: Allowed Values:
usd
dynamic_amount
-
Type:
integer -
Description: Determines from where the amount will be considered.
-
Required: Optional
-
Format: Boolean
-
Default: 0
cancel_url
-
Type:
string -
Description: Cancellation URL. If the field is present in the input data, it must not be empty and must be a valid URL.
-
Required: Optional
-
Format: URL
-
Min Length: 10
-
Max Length: N/A
multi_use
-
Type:
integer -
Description: Manage usability of a task.
-
Required: Optional
-
Format: Boolean
-
Default: 0
order_description
-
Type:
string -
Description: Short description of the order.
-
Required: Optional
-
Format: String
-
Min Length: 0
-
Max Length: 191
order_name
-
Type:
string -
Description: Short description of the order.
-
Required: Optional
-
Format: String
-
Min Length: 0
-
Max Length: 191
product_description
-
Type:
string -
Description: Brief product description.
-
Required: Optional
-
Format: String
-
Min Length: 0
-
Max Length: 250
product_images
-
Type:
string -
Description: Array of JSON product images.
-
Required: Optional
-
Format: String (JSON)
-
Min Length: 0
-
Max Length: 65k
product_name
-
Type:
string -
Description: Name of the product.
-
Required: Optional
-
Format: String
-
Min Length: 0
-
Max Length: 250
quantity
-
Type:
integer -
Description: Quantity.
-
Required: Optional
-
Format: String
-
Min Length: 0
-
Max Length: 12
send_via
-
Type:
string -
Description: Brief product description.
-
Required: Optional
-
Format: String
-
Min Length: 0
-
Max Length: 191
success_url
-
Type:
string -
Description: Success URL. If the field is present in the input data, it must not be empty and must be a valid URL.
-
Required: Optional
-
Format: URL
-
Min Length: 10
-
Max Length: N/A