Versapay Gateway Guide
| Additional notes |
|---|
Versapay billing data is a required request parameter. If no related data is stored with the payment method token or included in the transaction billing_address the gateway will return a fund_address_unspecified error. This could change according to your account configuration Create an order |
Adding a Versapay gateway
To add a Versapay gateway:
curl https://core.spreedly.com/v1/gateways.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<gateway>
<gateway_type>Versapay</gateway_type>
<api_key>api_key</api_key>
<api_token>api_token</api_token>
</gateway>'
<gateway>
<token>5P3VHME5AX8BBVR611SEWNRGPJ</token>
<gateway_type>versa_pay</gateway_type>
<name>VersaPay</name>
<description nil="true"/>
<merchant_profile_key nil="true"/>
<sub_merchant_key nil="true"/>
<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">true</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">true</supports_store>
<supports_remove type="boolean">true</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">false</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>
</characteristics>
<credentials>
</credentials>
<gateway_settings>
</gateway_settings>
<gateway_specific_fields>
</gateway_specific_fields>
<payment_methods>
<payment_method>credit_card</payment_method>
<payment_method>third_party_token</payment_method>
</payment_methods>
<state>retained</state>
<redacted type="boolean">false</redacted>
<sandbox type="boolean">false</sandbox>
<mode>default</mode>
<created_at type="dateTime">2024-11-01T13:18:42Z</created_at>
<updated_at type="dateTime">2024-11-01T13:18:42Z</updated_at>
</gateway>
Purchase
curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<transaction>
<payment_method_token>Igay4hFZr3mIFqHp9YCQCnPrUGq</payment_method_token>
<amount>10000</amount>
<currency_code>USD</currency_code>
<email>[email protected]</email>
<order_id>98765432199</order_id>
</transaction>'
<transaction>
<on_test_gateway type="boolean">true</on_test_gateway>
<created_at type="dateTime">2024-11-01T13:38:08Z</created_at>
<updated_at type="dateTime">2024-11-01T13:38:15Z</updated_at>
<succeeded type="boolean">true</succeeded>
<state>succeeded</state>
<token>Stg4vVdMV220ysYYx7hUPPwOxXB</token>
<transaction_type>Purchase</transaction_type>
<order_id>98765432199</order_id>
<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 nil="true"/>
<gateway_specific_response_fields>
</gateway_specific_response_fields>
<gateway_transaction_id>1TY1TC8VR2F2||</gateway_transaction_id>
<sub_merchant_key nil="true"/>
<gateway_latency_ms type="integer">3195</gateway_latency_ms>
<warning nil="true"/>
<application_id nil="true"/>
<risk_data nil="true"/>
<merchant_metadata nil="true"/>
<customer_data nil="true"/>
<order_data nil="true"/>
<workflow_key nil="true"/>
<amount type="integer">10000</amount>
<local_amount nil="true"/>
<currency_code>USD</currency_code>
<retain_on_success type="boolean">false</retain_on_success>
<payment_method_added type="boolean">false</payment_method_added>
<smart_routed type="boolean">false</smart_routed>
<stored_credential_initiator nil="true"/>
<stored_credential_reason_type nil="true"/>
<stored_credential_alternate_gateway nil="true"/>
<populate_mit_fields type="boolean">false</populate_mit_fields>
<message key="messages.transaction_succeeded">Succeeded!</message>
<gateway_token>74KEYQ9JRD8E39SYC4T8EXCE8N</gateway_token>
<gateway_type>versa_pay</gateway_type>
<shipping_address>
<name>Antonette Willms</name>
<address1>823 Torp Road</address1>
<address2>05294 Lesley Overpass</address2>
<city>South Vivafort</city>
<state>NJ</state>
<zip>31331</zip>
<country>US</country>
<phone_number>+16175551212</phone_number>
</shipping_address>
<response>
<success type="boolean">true</success>
<message>Succeeded</message>
<avs_code>Y</avs_code>
<avs_message>Street address and 5-digit postal code match.</avs_message>
<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">2024-11-01T13:38:12Z</created_at>
<updated_at type="dateTime">2024-11-01T13:38:15Z</updated_at>
</response>
<api_urls>
</api_urls>
<payment_method>
<token>Igay4hFZr3mIFqHp9YCQCnPrUGq</token>
<created_at type="dateTime">2024-11-01T13:37:51Z</created_at>
<updated_at type="dateTime">2024-11-01T13:37:51Z</updated_at>
<email>[email protected]</email>
<data nil="true"/>
<storage_state>cached</storage_state>
<test type="boolean">false</test>
<metadata nil="true"/>
<callback_url nil="true"/>
<last_four_digits>0006</last_four_digits>
<first_six_digits>489528</first_six_digits>
<card_type>visa</card_type>
<first_name>Antonette</first_name>
<last_name>Willms</last_name>
<month type="integer">12</month>
<year type="integer">2025</year>
<address1>85419 Peyton Points</address1>
<address2>94602 Schamberger Ports</address2>
<city>Covina</city>
<state>NJ</state>
<zip>31331</zip>
<country>US</country>
<phone_number>+16175551212</phone_number>
<company>Hintz Group</company>
<full_name>Antonette Willms</full_name>
<eligible_for_card_updater type="boolean">true</eligible_for_card_updater>
<shipping_address1>823 Torp Road</shipping_address1>
<shipping_address2>05294 Lesley Overpass</shipping_address2>
<shipping_city>South Vivafort</shipping_city>
<shipping_state>NJ</shipping_state>
<shipping_zip>31331</shipping_zip>
<shipping_country>US</shipping_country>
<shipping_phone_number>+16175551212</shipping_phone_number>
<issuer_identification_number>48952810</issuer_identification_number>
<click_to_pay type="boolean">false</click_to_pay>
<managed type="boolean">true</managed>
<payment_method_type>credit_card</payment_method_type>
<errors>
</errors>
<verification_value>XXX</verification_value>
<number>XXXX-XXXX-XXXX-0006</number>
<bin_metadata>
<message>BIN metadata not found.</message>
</bin_metadata>
<fingerprint nil="true"/>
</payment_method>
<attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>
Updated about 7 hours ago