Paymentez Gateway Guide

Paymentez fact sheet

Additional notes
Availability of Authorization and Capture calls varies by country. Please refer to Paymentez for any confirmation of behavior. Also, please note that both `email` and `description` are required fields when interacting with Paymentez. For more information, please consult the Paymentez API documentation.

Adding a Paymentez gateway

To add a Paymentez gateway:

curl https://core.spreedly.com/v1/gateways.xml \
  -u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>paymentez</gateway_type>
        <application_code>Your application code</application_code>
        <app_key>Your app key</app_key>
      </gateway>'

<gateway>
  <token>3QX6UCRTFryslf31Ddws1d7uUAe</token>
  <gateway_type>paymentez</gateway_type>
  <name>Paymentez</name>
  <description nil="true"/>
  <merchant_profile_key nil="true"/>
  <sub_merchant_key nil="true"/>
  <application_code>Your application code</application_code>
  <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_3dsecure_purchase type="boolean">false</supports_3dsecure_purchase>
    <supports_3dsecure_authorize type="boolean">false</supports_3dsecure_authorize>
    <supports_3dsecure_2_mpi_purchase type="boolean">true</supports_3dsecure_2_mpi_purchase>
    <supports_3dsecure_2_mpi_authorize type="boolean">true</supports_3dsecure_2_mpi_authorize>
    <supports_store type="boolean">true</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">false</supports_populate_mit_fields>
  </characteristics>
  <credentials>
    <credential>
      <name>application_code</name>
      <value>Your application code</value>
    </credential>
  </credentials>
  <gateway_settings>
  </gateway_settings>
  <gateway_specific_fields>
    <gateway_specific_field>vat</gateway_specific_field>
    <gateway_specific_field>dev_reference</gateway_specific_field>
    <gateway_specific_field>user_id</gateway_specific_field>
    <gateway_specific_field>tax_percentage</gateway_specific_field>
    <gateway_specific_field>taxable_amount</gateway_specific_field>
    <gateway_specific_field>installments</gateway_specific_field>
    <gateway_specific_field>installments_type</gateway_specific_field>
    <gateway_specific_field>fiscal_number</gateway_specific_field>
    <gateway_specific_field>discount</gateway_specific_field>
    <gateway_specific_field>phone</gateway_specific_field>
    <gateway_specific_field>extra_params</gateway_specific_field>
    <gateway_specific_field>more_info</gateway_specific_field>
    <gateway_specific_field>billing_address</gateway_specific_field>
    <gateway_specific_field>otp_flow</gateway_specific_field>
    <gateway_specific_field>type</gateway_specific_field>
    <gateway_specific_field>value</gateway_specific_field>
  </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>
  <created_at type="dateTime">2022-02-09T07:54:16Z</created_at>
  <updated_at type="dateTime">2022-02-09T07:54:16Z</updated_at>
</gateway>

Gateway specific fields

Spreedly supports the following gateway specific fields when transacting with Paymentez:

vat (required)
user_id (required)
dev_reference (required)
fiscal_number
installments
installments_type
taxable_amount
tax_percentage
phone - This will override any phone associated with the payment method.
discount
extra_params
more_info - This flag may be passed on credit or verify transactions to request that Paymentez send more information in the response. Please consult the Paymentez API documentation for examples of the responses generated with this flag.
billing_address
otp_flow - This flag is passed in authorize request to indicate otp flow for extra verification.
type - This specifies the type of verification to be used.
value - To be sent in capture request to pass otp value.

You can specify custom fields in a JSON blob supplied via the extra_params field. These fields should first be created in your Paymentez merchant account.

Example

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>
          <paymentez>
            <vat>5</vat>
            <dev_reference>DNI</dev_reference>
            <user_id>22222222</user_id>
            <installments>3</installments>
            <installments_type>0</installments_type>
            <taxable_amount>100</taxable_amount>
            <tax_percentage>0.07</tax_percentage>
            <fiscal_number>12345</fiscal_number>
            <phone>123-456-7890</phone>
            <discount>.10</discount>
            <extra_params><![CDATA[
              {
                "configuration1": "value1",
                "configuration2": "value2"
              }
            ]]></extra_params>
            <more_info>true</more_info>
            <otp_flow>true</otp_flow>
            <type>BY_OTP</type>
            <value>012345</value>
            <billing_address>
              <name>ABC</name>
              <address1>456 My Street</address1>
              <address2>Apt 1</address2>
              <company>Widgets Inc</company>
              <city>Ottawa</city>
              <state>ON</state>
              <zip>K1C2N6</zip>
              <country>CA</country>
              <phone>(555)555-5555</phone>
              <fax>(555)555-6666</fax>
            </billing_address>
          </paymentez>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2022-02-09T07:14:50Z</created_at>
  <updated_at type="dateTime">2022-02-09T07:14:50Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>FJJcqd6DbVQ0VH4Ul6Z39DW0kKS</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>
    <paymentez>
      <vat>5</vat>
      <dev_reference>DNI</dev_reference>
      <user_id>22222222</user_id>
      <installments>3</installments>
      <installments_type>0</installments_type>
      <taxable_amount>100</taxable_amount>
      <tax_percentage>0.07</tax_percentage>
      <fiscal_number>12345</fiscal_number>
      <phone>123-456-7890</phone>
      <discount>.10</discount>
      <extra_params>
              {
                "configuration1": "value1",
                "configuration2": "value2"
              }
            </extra_params>
      <more_info>true</more_info>
      <otp_flow>true</otp_flow>
      <type>BY_OTP</type>
      <value>012345</value>
      <billing_address>
        <name>ABC</name>
        <address1>456 My Street</address1>
        <address2>Apt 1</address2>
        <company>Widgets Inc</company>
        <city>Ottawa</city>
        <state>ON</state>
        <zip>K1C2N6</zip>
        <country>CA</country>
        <phone>(555)555-5555</phone>
        <fax>(555)555-6666</fax>
      </billing_address>
    </paymentez>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>53</gateway_transaction_id>
  <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>
  <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-02-09T07:14:50Z</created_at>
    <updated_at type="dateTime">2022-02-09T07:14:50Z</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-02-09T07:14:49Z</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"/>
    <payment_method_type>credit_card</payment_method_type>
    <errors>
    </errors>
    <verification_value></verification_value>
    <number>XXXX-XXXX-XXXX-1111</number>
    <fingerprint>e3cef43464fc832f6e04f187df25af497994</fingerprint>
  </payment_method>
  <attempt_3dsecure type="boolean">false</attempt_3dsecure>
</transaction>

Gateway specific response fields

Paymentez authorization_code

A response from Paymentez may include an authorization_code, carrier_code or transaction_message:

<transaction>
    <token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
    <transaction_type>Purchase</transaction_type>
    <gateway_specific_response_fields>
      <paymentez>
        <authorization_code>AMNA123</authorization_code>
        <carrier_code>54</carrier_code>
        <transaction_message>Response by mock</transaction_message>
      </paymentez>
    </gateway_specific_response_fields>
  </transaction>

transaction_message is mapped from transaction.message in the response.

To request any gateway_specific_fields or gateway_specific_response_fields, please contact Support with your request and the gateway documentation for the fields of interest.

Third Party 3DS

Below are the Spreedly 3DS authentication fields with the corresponding Paymentez fields.

Spreedly Field	Paymentez Field
`cavv`	`auth_data.cavv`
`xid`	`auth_data.xid`
`eci`	`auth_data.eci`
`version`	`auth_data.version`
`directory_server_transaction_id`	`auth_data.reference_id`
`authentication_response_status`/`directory_response_status`	`auth_data.status`

See the Third Party 3DS2 guide for more information.

Syncing transactions

Spreedly supports updating the status of transactions that have been initiated at the Paymentez gateway using the gateway_transaction_id.