Plexo Gateway Guide

Plexo fact sheet

Adding a Plexo gateway

To add a Plexo gateway:

curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>plexo</gateway_type>
        <client_id>Your client id</client_id>
        <api_key>Your api key</api_key>
        <merchant_id>Your merchant id</merchant_id>
      </gateway>'

<gateway>
  <token>CQYAQSXDkKMhQh2oANmoJXeH8Fx</token>
  <gateway_type>plexo</gateway_type>
  <name>Plexo</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <client_id>Your client id</client_id>
  <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">true</supports_network_tokenization>
    <supports_populate_mit_fields type="boolean">false</supports_populate_mit_fields>
  </characteristics>
  <credentials>
    <credential>
      <name>client_id</name>
      <value>Your client id</value>
    </credential>
    <credential>
      <name>merchant_id</name>
      <value>Your merchant id</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>items</gateway_specific_field>
    <gateway_specific_field>metadata</gateway_specific_field>
    <gateway_specific_field>installments</gateway_specific_field>
    <gateway_specific_field>statement_descriptor</gateway_specific_field>
    <gateway_specific_field>customer_id</gateway_specific_field>
    <gateway_specific_field>amount</gateway_specific_field>
    <gateway_specific_field>reason</gateway_specific_field>
    <gateway_specific_field>verify_amount</gateway_specific_field>
    <gateway_specific_field>cardholder_birthdate</gateway_specific_field>
    <gateway_specific_field>identification_type</gateway_specific_field>
    <gateway_specific_field>identification_value</gateway_specific_field>
    <gateway_specific_field>finger_print</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-09-20T06:43:38Z</created_at>
  <updated_at type="dateTime">2022-09-20T06:43:38Z</updated_at>
</gateway>

Gateway specific fields

Spreedly supports the following gateway specific fields when transacting with a Plexo gateway:

items
metadata
installments
statement_descriptor
customer_id
amount
reason
verify_amount
cardholder_birthdate
identification_type
identification_value
finger_print
invoice_number

The items field is required field when performing authorize and purchase transactions. The reason field is required when performing void and refund transactions.

curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<transaction>
        <payment_method_token>56wyNnSmuA6CWYP7w0MiYCVIbW6</payment_method_token>
        <amount>100</amount>
        <currency_code>USD</currency_code>
        <gateway_specific_fields>
          <plexo>
            <items>
              <reference_id>09132fhesfabcd123</reference_id>
              <name>preuba</name>
              <description>preuba desc</description>
              <quantity>1</quantity>
              <price>100</price>
              <discount>0</discount>
            </items>
            <amount>
              <tip_amount>5</tip_amount>
              <taxed_amount>1</taxed_amount>
              <discount_amount>3</discount_amount>
              <taxable_amount>1</taxable_amount>
              <tax>
                <type>17934</type>
                <amount>0.05</amount>
                <rate>20</rate>
              </tax>
            </amount>
            <installments>1</installments>
            <statement_descriptor>Plexo * Test</statement_descriptor>
            <customer_id>Customer 1</customer_id>
            <cardholder_birthdate>1999-08-18T19:49:37.023Z</cardholder_birthdate>
            <identification_type>1</identification_type>
            <identification_value>123456</identification_value>
            <finger_print>USABJHABSFASNJKN123532</finger_print>
            <invoice_number>12345</invoice_number>
            <metadata>
                <custom>my custom field</custom>
            </metadata>
          </plexo>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2022-09-20T06:43:37Z</created_at>
  <updated_at type="dateTime">2022-09-20T06:43:37Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>67BFUOy3fVJoKXRVlujsvzic5xK</token>
  <transaction_type>Purchase</transaction_type>
  <order_id nil="true"/>
  <ip nil="true"/>
  <description nil="true"/>
  <email nil="true"/>
  <merchant_name_descriptor nil="true"/>
  <merchant_location_descriptor nil="true"/>
  <merchant_profile_key nil="true"/>
  <gateway_specific_fields>
    <plexo>
      <items>
        <reference_id>09132fhesfabcd123</reference_id>
        <name>preuba</name>
        <description>preuba desc</description>
        <quantity>1</quantity>
        <price>100</price>
        <discount>0</discount>
      </items>
      <amount>
        <tip_amount>5</tip_amount>
        <taxed_amount>1</taxed_amount>
        <discount_amount>3</discount_amount>
        <taxable_amount>1</taxable_amount>
        <tax>
          <type>17934</type>
          <amount>0.05</amount>
          <rate>20</rate>
        </tax>
      </amount>
      <installments>1</installments>
      <statement_descriptor>Plexo * Test</statement_descriptor>
      <customer_id>Customer 1</customer_id>
      <cardholder_birthdate>1999-08-18T19:49:37.023Z</cardholder_birthdate>
      <identification_type>1</identification_type>
      <identification_value>123456</identification_value>
      <finger_print>USABJHABSFASNJKN123532</finger_print>
      <invoice_number>12345</invoice_number>
      <metadata>
        <custom>my custom field</custom>
      </metadata>
    </plexo>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>67</gateway_transaction_id>
  <sub_merchant_key nil="true"/>
  <gateway_latency_ms type="integer">0</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">false</payment_method_added>
  <smart_routed type="boolean">false</smart_routed>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>T11bJAANtTWnxl36GYjKWvbNK0g</gateway_token>
  <gateway_type>test</gateway_type>
  <shipping_address>
    <name>Newfirst Newlast</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>Successful purchase</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-09-20T06:43:37Z</created_at>
    <updated_at type="dateTime">2022-09-20T06:43:37Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>1rpKvP8zOUhj4Y9EDrIoIYQzzD5</token>
    <created_at type="dateTime">2017-06-26T17:04:38Z</created_at>
    <updated_at type="dateTime">2022-09-15T07:15:34Z</updated_at>
    <email>[email protected]</email>
    <data>
      <my_payment_method_identifier>448</my_payment_method_identifier>
      <extra_stuff>
        <some_other_things>Can be anything really</some_other_things>
      </extra_stuff>
    </data>
    <storage_state>retained</storage_state>
    <test type="boolean">true</test>
    <metadata>
      <key>string value</key>
    </metadata>
    <callback_url nil="true"/>
    <last_four_digits>1111</last_four_digits>
    <first_six_digits>411111</first_six_digits>
    <card_type>visa</card_type>
    <first_name>Newfirst</first_name>
    <last_name>Newlast</last_name>
    <month type="integer">3</month>
    <year type="integer">2032</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>Newfirst Newlast</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 nil="true"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
    <stored_credential_usage>
      <test>
        <original_network_transaction_id>37be5367d6dbe4a88c9d</original_network_transaction_id>
        <network_transaction_id>37be5367d6dbe4a88c9d</network_transaction_id>
      </test>
    </stored_credential_usage>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

Gateway specific fields

A response from Plexo may contain ticket, and authorization fields, which you can find in the gateway_specific_response_fields.

For example, a transaction could have something like this:

<transaction>
  <token>XVqroAeclu5j8Q3qRJiVXBiqAvf</token>
  <transaction_type>Purchase</transaction_type>
  <gateway_specific_response_fields>
     <plexo>
       <ticket>77636dd3958e4f88a9554a23f03c8688</ticket>
       <authorization>123456</authorization>
     </plexo>
  </gateway_specific_response_fields>
</transaction>