Reach - The Query API
The Query API allows you to query order information from the Reach system i.e. Orders that are processed through the Reach Payment system. If the order is not found, an HTTP 404 response will be returned. If there is a system problem with querying the order, an HTTP 503 response will be returned and the request should be tried again
Request Structure
| Field | Type | Required | Notes |
|---|---|---|---|
| MerchantId | uuid | Yes | The 36 character GUID which identifies the merchant to the Reach system |
| OrderId / ReferenceId / ContractId | uuid* | Yes | The Reach order identifier returned in the checkout response, or a ReferenceId specified by the merchant in the checkout request, or a ContractId returned when a Reach contract has been created. |
- If ReferenceId is specified, this is an unconstrained string.
Where do I get the OrderId?
The OrderId to be used in the Reach query API call can be seen in the Shopify order timeline. The Authorization key value is the OrderId
Using the Reach Test Tool
The Reach api test tool available at https://checkout.rch.how/ allows developers to test the Reach api calls easily and also gives insight into how it works.
Parameters
Request Type: /query
API URL:
https://checkout.rch.how/v2.18 [Sandbox]
https://checkout.rch.io/v2.18 [Production]
Merchant Id: Your Reach MerchantId [Ask your Reach Success Manager]
Insert Latest Order Id is optional
Secret - Given to you by your Reach Success Manager
{
"MerchantId": "2a144a21-066a-42fe-a553-736a777e39e2",
"OrderId": "c04f5b2f-d181-45e3-bba7-0cdd997fe136"
}
How do I calculate Signature for my Request?
Find documentation on how to calculate your request signature here https://docs.withreach.com/docs/signature-calculation
Query JSON Response
{
"MerchantId": "juI4106f-30b8-45df-b62f-b649fc80eafd",
"ReferenceId": "3222526666154048",
"OrderId": "c04f5b2f-d181-45e3-bba7-0cdd997fe136",
"TransactionId": "9ll4f61f5-c118-43f9-0036-f687092556b9",
"ContractId": null,
"RateOfferId": "0c964f0a-00de-40d4-b23d-e4a997228de5",
"Rate": 1.341,
"UnderReview": false,
"Chargeback": false,
"OrderState": "Processed",
"Reason": null,
"Expiry": "2020-08-11T21:17:59.933498Z",
"Action": null,
"Times": {
"Created": "2020-08-04T21:17:58.860360Z",
"Authorized": "2020-08-04T21:17:59.933498Z",
"Processed": "2020-08-04T21:19:01.789677Z"
},
"ConsumerCurrency": "CAD",
"Consumer": {
"Name": " Cheung",
"Email": "[email protected]",
"Address": "456 Glen Green SouthWest",
"City": "Calgary",
"Region": "AB",
"PostalCode": "T3R 999",
"Country": "CA",
"IpAddress": "66.122.146.215",
"EffectiveIpAddress": "66.122.146.215"
},
"Consignee": {
"Name": " Cheung",
"Address": "456 Glen Green SouthWest",
"City": "Calgary",
"Region": "AB",
"PostalCode": "T3R 999",
"Country": "CA"
},
"Payment": {
"Method": "VISA",
"Class": "Card",
"Expiry": "2030-03",
"AccountIdentifier": "760062******0017"
},
"Items": [
{
"Sku": "31518756896832",
"Quantity": 1,
"MerchantPrice": 76.44,
"ConsumerPrice": 102.5
}
],
"Shipping": {
"Reference": null,
"Service": null,
"MerchantBreakdown": {
"Price": 0,
"Taxes": 0,
"Duty": 0
},
"ConsumerBreakdown": {
"Price": 0,
"Taxes": 0,
"Duty": 0
}
},
"Charges": null,
"Discounts": null,
"Financing": null,
"MerchantTotal": 76.44,
"ConsumerTotal": 102.5,
"Store": "Reach StoreFront",
"Refunds": [
{
"RefundId": "c2d587f3-f8df-4ed1-9b86-0bc64291df8b",
"ConsumerAmount": 102.5,
"MerchantAmount": 76.44,
"State": "Succeeded",
"ReferenceId": "3222526666154048;75.00",
"StartTime": "2020-08-04T21:29:51.548707Z",
"ProcessedTime": "2020-08-04T21:30:49.955116Z"
}
],
"Meta": {
"capture_amt": "75.00",
"capture_ref": 5647701160000,
"cart": "{}",
"checkout_token": "fff442cbf21487d0275f332b0b35a4ea",
"x_amount": "75.00",
"x_currency": "USD",
"x_test": "true",
"x_url_callback": "",
"x_url_cancel": "",
"x_url_complete": ""
}
}
Need More Support?
For more information on Reach API, visit https://withreach.com/docs/GoInterpayCheckoutAPIGuide-v2r020.pdf. pg. 41
Reach out to us at [email protected]
Updated over 4 years ago