v1

latestOpenAPI 3.1.02026-07-24170121.2 MB

Create an Order

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.

post/v1/orders/

Headers

Acceptstring required

Indicates which content types, expressed as MIME types, the client is able to understand.

Content-Typestring required

Indicates the media type of the resource sent in the HTTP message body. Possible Values: application/json application/x-www-form-urlencoded

Request body

amountinteger required

A positive integer in cents representing how much to charge.

surcharge_percentinteger

A positive integer representing surcharge percentage to be added for charge.

surcharge_fixedinteger

A positive integer in cents representing flat surcharge fee to be added to amount.

payment_methodstring

If the field is present in the input data, it must not be empty or null.

currencystring

Three-letter ISO currency code, in lowercase.

dynamic_amountinteger

Determines from-where the amount will be considered.

failure_urlstring

Cancellation URL. If the field is present in the input data, it must not be empty and must be valid URL

multi_useinteger

Manage usability of a task.

order_descriptionstring

Short description to order.

order_namestring

Short description of the order.

product_descriptionstring

Brief product description.

product_imagesstring

Array of json product images.

product_namestring

Name of the product.

quantityinteger

Quantity.

send_viastring

Brief product description.

success_urlstring

Success URL. If the field is present in the input data, it must not be empty and must be valid URL

Response

200

idstring

payment_form_urlstring

tokenstring

Example response

{
  "id": "P4R6gBzP4qMBq1zM",
  "payment_form_url": "https://testcheckout.payarc.net/pay/order/P4R6gBzP4qMBq1zM?orderToken=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlhcmMiLCJhdWQiOiJleUpwZGlJNkltbENPSGh4V1hKVllYUnJZelZXV0RWQlpHWnNPSGM5UFNJc0luWmhiSFZsSWpvaVdFaG1RVzlJYWpOYU5tWjFTR05NZDBSeFdsWk9jVTEzZEVvMFkyUnhkVE5SZVVGcVRVbGpWbFpIWlRONkwyWk9kMU1yWVV4NlVGTnVaMUZWY1ZSUFZpSXNJbTFoWXlJNklqbGxOMlk1TVdRellqazBZMlk0TW1VNFltSTJZV0kzTURSbU1UYzJOemhtTWpKbU1UY3pNV0ppWTJRMU16UXpObU0zWXpSak0ySXdaamM0TXpSa05qRWlMQ0owWVdjaU9pSWlmUT09IiwiaWF0IjoxNzI0NTg2Mjk5LCJuYmYiOjE3MjQ1ODYyOTksImV4cCI6MTcyNDU4ODA5OX0.1GHaycZSQObN_1Vx5VVUIGZcGreWSXGQe6A98LxOGvg",
  "token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJQYXlhcmMiLCJhdWQiOiJleUpwZGlJNkltbENPSGh4V1hKVllYUnJZelZXV0RWQlpHWnNPSGM5UFNJc0luWmhiSFZsSWpvaVdFaG1RVzlJYWpOYU5tWjFTR05NZDBSeFdsWk9jVTEzZEVvMFkyUnhkVE5SZVVGcVRVbGpWbFpIWlRONkwyWk9kMU1yWVV4NlVGTnVaMUZWY1ZSUFZpSXNJbTFoWXlJNklqbGxOMlk1TVdRellqazBZMlk0TW1VNFltSTJZV0kzTURSbU1UYzJOemhtTWpKbU1UY3pNV0ppWTJRMU16UXpObU0zWXpSak0ySXdaamM0TXpSa05qRWlMQ0owWVdjaU9pSWlmUT09IiwiaWF0IjoxNzI0NTg2Mjk5LCJuYmYiOjE3MjQ1ODYyOTksImV4cCI6MTcyNDU4ODA5OX0.1GHaycZSQObN_1Vx5VVUIGZcGreWSXGQe6A98LxOGvg"
}