Main site
API Reference
Service status
Start typing to search…

Create a new session

post
https://api.sandbox.withreach.com/v1/session
Body Params

Session object that needs to be created.

string
required
length ≥ 1

Unique identifier provided by merchant.

string
required
length between 3 and 3

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

Items
array of objects
required

List of items to be paid. At least one Item must be supplied.

Items*
boolean
required

Indicator used to determine if an Order is auto captured after authorization.

string
required
length ≥ 1

Merchant URL to redirect a user to upon completion at a third party payment processor. This may contain "{SessionId}" anywhere in the string to have the SessionId embedded in the url.

string
required
length ≥ 1

Merchant URL to redirect a user to after cancelling on a third party payment processor. This may contain "{SessionId}" anywhere in the string to have the SessionId embedded in the url.

boolean

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

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.

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

ShippingDetails
object

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

number

Taxes for the entire order. Currency is defined by parent object.

Discounts
array of objects
Discounts
uuid
length between 36 and 36

The 36 character GUID for a guaranteed foreign exchange rate. If omitted, the rate will be determined at the time of settlement.

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.

boolean

Overrides the merchant AllowContract setting to permit users creation of a contract (used for recurring billing, subscriptions, stored payment options, etc.) when submitting their payment.

boolean

Flag to tell that the payment is to be used to start a subscription and if successful will automatically create a contract.

string
length ≥ 1

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

Responses

Updated 8 months ago

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