Reach gateway guide
Adding a Reach gateway
To add a Reach gateway:
curl https://core.spreedly.com/v1/gateways.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<gateway>
<gateway_type>reach</gateway_type>
<merchant_id>your merchant id</merchant_id>
<secret>your secret key</secret>
</gateway>'
<gateway>
<token>1783VJmxki3FEcBVQyzIfzgFYAN</token>
<gateway_type>reach</gateway_type>
<name>reach</name>
<description nil="true"/>
<merchant_profile_key nil="true"/>
<sub_merchant_key nil="true"/>
<merchant_id>your merchant id</merchant_id>
<characteristics>
<supports_purchase type="boolean">true</supports_purchase>
<supports_authorize type="boolean">true</supports_authorize>
<supports_capture type="boolean">true</supports_capture>
<supports_credit type="boolean">true</supports_credit>
<supports_general_credit type="boolean">false</supports_general_credit>
<supports_void type="boolean">true</supports_void>
<supports_adjust type="boolean">false</supports_adjust>
<supports_verify type="boolean">true</supports_verify>
<supports_reference_purchase type="boolean">false</supports_reference_purchase>
<supports_purchase_via_preauthorization type="boolean">false</supports_purchase_via_preauthorization>
<supports_offsite_purchase type="boolean">false</supports_offsite_purchase>
<supports_offsite_authorize type="boolean">false</supports_offsite_authorize>
<supports_offsite_synchronous_purchase type="boolean">false</supports_offsite_synchronous_purchase>
<supports_offsite_synchronous_authorize type="boolean">false</supports_offsite_synchronous_authorize>
<supports_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
<supports_3dsecure_authorize type="boolean">false</supports_3dsecure_authorize>
<supports_3dsecure_2_mpi_purchase type="boolean">false</supports_3dsecure_2_mpi_purchase>
<supports_3dsecure_2_mpi_authorize type="boolean">false</supports_3dsecure_2_mpi_authorize>
<supports_store type="boolean">false</supports_store>
<supports_remove type="boolean">false</supports_remove>
<supports_fraud_review type="boolean">false</supports_fraud_review>
<supports_network_tokenization type="boolean">false</supports_network_tokenization>
<supports_populate_mit_fields type="boolean">true</supports_populate_mit_fields>
<supports_inquire_by_gateway_transaction_id type="boolean">false</supports_inquire_by_gateway_transaction_id>
<supports_inquire_by_order_id type="boolean">false</supports_inquire_by_order_id>
<supports_transaction_retry type="boolean">false</supports_transaction_retry>
<supports_stored_stored_credentials type="boolean">false</supports_stored_stored_credentials>
<supports_stored_credentials type="boolean">true</supports_stored_credentials>
</characteristics>
<credentials>
<credential>
<name>merchant_id</name>
<value>your merchant id</value>
</credential>
</credentials>
<gateway_settings>
</gateway_settings>
<gateway_specific_fields>
<gateway_specific_field>device_fingerprint</gateway_specific_field>
<gateway_specific_field>rate_offer_id</gateway_specific_field>
<gateway_specific_field>items</gateway_specific_field>
<gateway_specific_field>taxes</gateway_specific_field>
<gateway_specific_field>duty</gateway_specific_field>
<gateway_specific_field>price</gateway_specific_field>
<gateway_specific_field>consignee_name</gateway_specific_field>
<gateway_specific_field>consignee_address</gateway_specific_field>
<gateway_specific_field>consignee_city</gateway_specific_field>
<gateway_specific_field>consignee_country</gateway_specific_field>
<gateway_specific_field>reference_id</gateway_specific_field>
</gateway_specific_fields>
<payment_methods>
<payment_method>credit_card</payment_method>
</payment_methods>
<state>retained</state>
<redacted type="boolean">false</redacted>
<sandbox type="boolean">false</sandbox>
<mode>default</mode>
<created_at type="dateTime">2022-12-28T17:37:06Z</created_at>
<updated_at type="dateTime">2022-12-28T17:37:07Z</updated_at>
</gateway>
Gateway specific fields
When interacting with a Reach gateway to run transactions, there are many gateway specific fields you can specify when making a call:
device_fingerprint: The return value of the fingeprint request, is value that identifies a particular device on customer initiated transactions, it should be first requested and passed with the transaction. See docs.
rate_offer_id: Optional - an UUID that identifies your offer id and guaranteed foreign exchange rate, if you want to know more about rate offers, check docs.
Shipping data
If physical shipping of goods is required for this order, Shipping must be specified before authorization, if specified this are the minimum needed fields:
taxes: Taxes incurred for the entire order..
duty: Duty incurred for the entire order.
price: The amount, including all service fees, surcharges, etc, but excluding taxes and duty, associated with the physical shipping option.
Consignee
A consignee is the person receiving an order. This is sometimes referred to as the shipping contact. Consignee must be specified if Shipping is present, if specified these are the minimum needed fields:
consignee_name: The consignee’s full name.
consignee_address: The consignee’s street address.
consignee_city: The city associated with the consignee’s address.
consignee_country: The upper-case ISO 3166 alpha-2 country code associated with the consignee’s address.
curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<transaction>
<billing_address>
<zip>31331</zip>
<state>NJ</state>
<phone_number>919.331.3313</phone_number>
<name>Francisca Torphy</name>
<country>US</country>
<city>Wanaque</city>
<address2>Apartment 4</address2>
<address1>33 Lane Road</address1>
</billing_address>
<email>[email protected]</email>
<credit_card>
<first_name>Joe</first_name>
<last_name>Smith</last_name>
<number>4444333322221111</number>
<verification_value>737</verification_value>
<month>3</month>
<year>2030</year>
</credit_card>
<amount>100</amount>
<currency_code>USD</currency_code>
<gateway_specific_fields>
<reach>
<rate_offer_id>6568f352-b7c1-4187-a5a2-883a40a768fc</rate_offer_id>
<device_fingerprint>5b43c26a-ba08-4762-b5e5-d1aa0c16616b</device_fingerprint>
<taxes>0.2</taxes>
<duty>1.01</duty>
<price>1.01</price>
<consignee_name>John Doe</consignee_name>
<consignee_address>1670 NW 82ND STR</consignee_address>
<consignee_city>Houston</consignee_city>
<consignee_country>US</consignee_country>
</reach>
</gateway_specific_fields>
</transaction>'
<transaction>
<on_test_gateway type="boolean">true</on_test_gateway>
<created_at type="dateTime">2022-12-10T14:14:52Z</created_at>
<updated_at type="dateTime">2022-12-10T14:14:58Z</updated_at>
<succeeded type="boolean">true</succeeded>
<state>succeeded</state>
<token>Q6RCwNfyTBYwGeIC968xFCAX996</token>
<transaction_type>Purchase</transaction_type>
<order_id nil="true"/>
<ip nil="true"/>
<description nil="true"/>
<email>[email protected]</email>
<merchant_name_descriptor nil="true"/>
<merchant_location_descriptor nil="true"/>
<merchant_profile_key nil="true"/>
<gateway_specific_fields>
<reach>
<rate_offer_id>6568f352-b7c1-4187-a5a2-883a40a768fc</rate_offer_id>
<device_fingerprint>5b43c26a-ba08-4762-b5e5-d1aa0c16616b</device_fingerprint>
<taxes>0.2</taxes>
<duty>1.01</duty>
<price>1.01</price>
<consignee_name>John Doe</consignee_name>
<consignee_address>1670 NW 82ND STR</consignee_address>
<consignee_city>Houston</consignee_city>
<consignee_country>US</consignee_country>
</reach>
</gateway_specific_fields>
<gateway_specific_response_fields>
</gateway_specific_response_fields>
<gateway_transaction_id>01c46042-3096-4506-9cd6-98ffd6eef16f</gateway_transaction_id>
<sub_merchant_key nil="true"/>
<gateway_latency_ms type="integer">2147</gateway_latency_ms>
<stored_credential_initiator nil="true"/>
<stored_credential_reason_type nil="true"/>
<populate_mit_fields type="boolean">false</populate_mit_fields>
<warning nil="true"/>
<application_id nil="true"/>
<amount type="integer">100</amount>
<local_amount nil="true"/>
<currency_code>USD</currency_code>
<retain_on_success type="boolean">false</retain_on_success>
<payment_method_added type="boolean">true</payment_method_added>
<smart_routed type="boolean">false</smart_routed>
<message key="messages.transaction_succeeded">Succeeded!</message>
<gateway_token>Mhcb9Z8EHeQiUoKaYcv15cgLpVS</gateway_token>
<gateway_type>reach</gateway_type>
<billing_address>
<name>Francisca Torphy</name>
<address1>33 Lane Road</address1>
<address2>Apartment 4</address2>
<city>Wanaque</city>
<state>NJ</state>
<zip>31331</zip>
<country>US</country>
<phone_number>919.331.3313</phone_number>
</billing_address>
<shipping_address>
<name>Joe Smith</name>
<address1 nil="true"/>
<address2 nil="true"/>
<city nil="true"/>
<state nil="true"/>
<zip nil="true"/>
<country nil="true"/>
<phone_number nil="true"/>
</shipping_address>
<response>
<success type="boolean">true</success>
<message></message>
<avs_code nil="true"/>
<avs_message nil="true"/>
<cvv_code nil="true"/>
<cvv_message nil="true"/>
<pending type="boolean">false</pending>
<result_unknown type="boolean">false</result_unknown>
<error_code nil="true"/>
<error_detail nil="true"/>
<cancelled type="boolean">false</cancelled>
<fraud_review nil="true"/>
<created_at type="dateTime">2022-12-10T14:14:55Z</created_at>
<updated_at type="dateTime">2022-12-10T14:14:58Z</updated_at>
</response>
<api_urls>
</api_urls>
<payment_method>
<token>N4VKokkiuKTskOjVd8QKf9bazlF</token>
<created_at type="dateTime">2022-12-10T14:14:51Z</created_at>
<updated_at type="dateTime">2022-12-10T14:14:53Z</updated_at>
<email nil="true"/>
<data nil="true"/>
<storage_state>cached</storage_state>
<test type="boolean">false</test>
<metadata nil="true"/>
<callback_url nil="true"/>
<last_four_digits>1111</last_four_digits>
<first_six_digits>444433</first_six_digits>
<card_type>visa</card_type>
<first_name>Joe</first_name>
<last_name>Smith</last_name>
<month type="integer">3</month>
<year type="integer">2030</year>
<address1 nil="true"/>
<address2 nil="true"/>
<city nil="true"/>
<state nil="true"/>
<zip nil="true"/>
<country nil="true"/>
<phone_number nil="true"/>
<company nil="true"/>
<full_name>Joe Smith</full_name>
<eligible_for_card_updater type="boolean">true</eligible_for_card_updater>
<shipping_address1 nil="true"/>
<shipping_address2 nil="true"/>
<shipping_city nil="true"/>
<shipping_state nil="true"/>
<shipping_zip nil="true"/>
<shipping_country nil="true"/>
<shipping_phone_number nil="true"/>
<issuer_identification_number>44443333</issuer_identification_number>
<click_to_pay type="boolean">false</click_to_pay>
<payment_method_type>credit_card</payment_method_type>
<errors>
</errors>
<verification_value>XXX</verification_value>
<number>XXXX-XXXX-XXXX-1111</number>
<fingerprint nil="true"/>
</payment_method>
<attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>
Additional notes
- In order to offer Reach processing you will need to modify the checkout to display the Reach Processor Disclosure and Location Declaration Badge
- To get avs and cvv data returned in your response from Reach, the feature needs to be enabled on your Reach account. Please note when this is enabled, the Merchant (you) will own liability for chargebacks and fraudulent orders
Updated 5 months ago