Main site
API Reference
Service status

Create a new order

post
https://api.sandbox.withreach.com/v1/orders
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Order to be created

string
required
length ≥ 1

Unique identifier provided by merchant.

BillingProfile
object

Billing details associated with the payment. Some fields may be required or optional depending on the Country in BillingProfile.Address. See: https://docs.withreach.com/reference/country-specific-fields-1

uuid
length between 36 and 36

Corresponds to the BillingProfileId returned in a BillingProfile. Can be passed in to reference an existing billing profile instead of creating a new one. Exactly one of BillingProfile, BillingProfileId or BillingprofileReference are required.

string
length ≥ 1

Merchant supplied reference that uniquely maps to a BillingProfile. Can be passed in to reference an existing BillingProfile. Exactly one of BillingProfile, BillingProfileId or BillingprofileReference are required.

string
length between 3 and 3

Three-character ISO-4217 currency code used to process the payment.

Items
array of objects

List of items to be paid. At least one Item must be supplied in requests. The sum total of the item amounts will be added to the TotalAmount

Items
Payment
object

Object representing the payment information for an order

uuid
length between 36 and 36

Reach-generated ID of an existing contract. Can be supplied in lieu of a Payment object. Will be returned in the response if OpenContract is set to true.

string
length ≥ 1

Device fingerprint - see https://docs.withreach.com/reference/fingerprint-1

Discounts
array of objects

List of discounts. The sum of the discounts amounts will be subtracted from the TotalAmount

Discounts
ShippingDetails
object

Customer's shipping details. This is required if physical goods are shipped along with the order.

number

Tax to be applied to the order. In the consumer currency, max precision of 2 digits. TaxAmount will be added to the TotalAmount.

boolean

Indicates that this order is being made by an agent, and not the end consumer. If false or not present, the order is assumed to be placed by the end consumer.

boolean

If true, the merchant accepts financial liability for this order.

boolean

If true or the payment method used by the consumer does not support pre-authorization, the payment will be completed. If false or not present, and the payment method supports pre-authorization, the order will be left in the PaymentAuthorized state and the merchant must capture the order using a capture request.

boolean

If true, a contract (used for recurring billing, subscriptions, stored payment options, etc.) will be opened if possible. If false or not present, the order will not open a contract.

string
length ≥ 1

Unique Tax Quote Id provided by merchant, Id recieved from calling the Reach Quote API.

Meta
object

Any optional metadata to be included. Can be a simple reference ID or some complex object containing multiple values, as long as it is valid JSON.

Responses

Updated 8 months ago

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 8 months ago