Create Order

post https://api.exactpaysandbox.com/orders

Create an order.

Body Params

amount

int32

required

0 to 999999999

Amount in smallest currency unit, eg: cents, including all fees, surcharges, taxes etc.

fee_amount

int32

0 to 999999999

This is assumed to already be included in the amount.

surcharge_amount

int32

0 to 999999999

This is assumed to already be included in the amount. (Available for Elavon processing only)

tax_amount

uint32

0 to 999999999

Tax value included in total amount. Sales tax in the US, or PST for Canadian merchants. In smallest currency units, eg: cents in USD. This is assumed to already be included in the amount.

capture

boolean

Set this to false if you only want to authorize for the amount. Defaults to true.

description

string

terminal

object

required

Which terminal to process the transaction through. The terminal determines currency and language.

reference

object

Merchant defined values which can be used to internally identify the transaction.

billing

object

Optional billing details for the customer. If you have enabled AVS filters on your terminal, this becomes mandatory and AVS checks will be performed on the address.

soft_descriptor

object

Override business information which would normally appear on a customer's statement, making it easier for customers to identify transactions.

level3

object

options

object

Responses

Response body

object

string

status

string

The current state of the order.

awaiting_payment cancelled paid

access_token

object

token

string

The token which grants temporary API access to ExactJS.

expires_at

date-time

When this access token expires, in ISO8601 format.

payment_id

string

amount

int32

0 to 999999999

Amount in smallest currency unit, eg: cents, including all fees, surcharges, taxes etc.

fee_amount

int32

0 to 999999999

This is assumed to already be included in the amount.

surcharge_amount

int32

0 to 999999999

This is assumed to already be included in the amount. (Available for Elavon processing only)

tax_amount

uint32

0 to 999999999

Tax value included in total amount. Sales tax in the US, or PST for Canadian merchants. In smallest currency units, eg: cents in USD. This is assumed to already be included in the amount.

capture

boolean

Set this to false if you only want to authorize for the amount. Defaults to true.

description

string

terminal

object

Which terminal to process the transaction through. The terminal determines currency and language.

gateway_id

string

required

reference

object

Merchant defined values which can be used to internally identify the transaction.

customer_ref

string

length ≤ 20

reference_no

string

length ≤ 25

This field is required to be submitted for Elavon Merchants. This field is truncated to 20 characters for Fiserv Merchants.

reference_3

string

length ≤ 30

Fiserv only

correlation_id

string

length ≤ 60

A merchant defined value that can be used to reverse a transaction which times out without returning a payment id.

order_tracking_number

string

length ≤ 22

Shipping carrier tracking ID. Fiserv only - passed through to Compass during settlement.

billing

object

Optional billing details for the customer. If you have enabled AVS filters on your terminal, this becomes mandatory and AVS checks will be performed on the address.

name

string

phone

string

length ≤ 20

phone_type

string

H = Home, W = Work, D = Day, N = Night. Phone type is required when a phone number is supplied.

H W N D

address

object

The customer's billing address. Will be used for AVS checks so postal/zip code is the minimum data required.

soft_descriptor

object

Override business information which would normally appear on a customer's statement, making it easier for customers to identify transactions.

dba_name

string

street

string

city

string

state

string

postal_code

string

country_code

string

3-character alphabetical country code according to ISO 3166-1, eg: USA, CAN etc.

mcc

string

merchant_contact_info

string

level_3

object

tax_amount

uint32

≥ 0

In smallest currency units, eg: cents in USD

tax_rate

float

≥ 0

alt_tax_amount

uint32

≥ 0

In smallest currency units, eg: cents in USD

alt_tax_id

string

duty_amount

uint32

≥ 0

In smallest currency units, eg: cents in USD

freight_amount

uint32

≥ 0

In smallest currency units, eg: cents in USD

discount_amount

uint32

≥ 0

In smallest currency units, eg: cents in USD

ship_from_zip

string

length ≤ 10

ship_to

object

line_items

array of objects

length between 1 and 98

line_items

object

commodity_code

string

description

string

required

discount_amount

uint32

≥ 0

In smallest currency units, eg: cents in USD

discount_indicator

boolean

gross_net_indicator

boolean

line_item_total

uint32

required

≥ 0

In smallest currency units, eg: cents in USD

product_code

string

length ≤ 12

quantity

float

required

If present, must be greater than zero

tax_amount

uint32

≥ 0

In smallest currency units, eg: cents in USD

tax_rate

float

≥ 0

tax_type

string

unit_cost

float

required

≥ 0

In smallest currency units, eg: cents in USD so 13.25 = 13 and one quarter cents

unit_of_measure

string

options

object

ecommerce_flag

string

length ≤ 1

Used to classify the style of transaction being performed. 2 = Recurring, 3 = Installment.

1 2 3 4 5 6 7 8 R I X

customer_ip

string

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
16
1
curl --request POST \
2
     --url https://api.exactpaysandbox.com/orders \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "level3": {
8
    "line_items": [
9
      {
10
        "discount_indicator": true,
11
        "gross_net_indicator": true
12
      }
13
    ]
14
  }
15
}
16
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Payment created.

400Bad Request When there are errors in the payload

403Access Denied Credentials supplied do not grant access to the requested resource.

defaultUnspecified error.