Pin Payments Gateway Guide

close

Services and Compatibility

Payment Gateway Company Name:
Pin Payments
Services that work with Spreedly:
  • Pin Payments
Supported operations:
Purchase, Authorize, Capture, Refund
Unsupported operations:
Void
Regions:
Asia Pacific

Authentication and Security

Specific names for credentials:
Api Key

Onboarding Merchants in:

Additional Notes

You may use metadata gateway specific field to pass through custom name value pairs to Pin Payments gateway. Example: Gateway does not support order_id at present. This may be passed through via metadata instead.

Adding

To add a Pin Payments gateway:


curl https://core.spreedly.com/v1/gateways.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -H 'Content-Type: application/xml' \
  -d '<gateway>
        <gateway_type>pin</gateway_type>
        <api_key>YourAPIKey</api_key>
      </gateway>'

<gateway>
  <token>V59pZrxUrnI4a5lon4fuPQzjF7z</token>
  <gateway_type>pin</gateway_type>
  <name>Pin Payments</name>
  <description 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">false</supports_general_credit>
    <supports_void type="boolean">false</supports_void>
    <supports_verify type="boolean">false</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_store type="boolean">false</supports_store>
    <supports_remove type="boolean">false</supports_remove>
    <supports_fraud_review type="boolean">false</supports_fraud_review>
    <supports_disburse type="boolean">false</supports_disburse>
  </characteristics>
  <credentials>
  </credentials>
  <gateway_specific_fields>
  </gateway_specific_fields>
  <payment_methods>
    <payment_method>credit_card</payment_method>
  </payment_methods>
  <state>retained</state>
  <redacted type="boolean">false</redacted>
  <created_at type="dateTime">2016-08-11T17:15:42Z</created_at>
  <updated_at type="dateTime">2016-08-11T17:15:42Z</updated_at>
</gateway>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.add_gateway(:pin, api_key: "Your api_key")


#<Spreedly::Gateway:0x007fbf1a866bc8
 @created_at="2016-08-11T17:15:43Z",
 @credentials={},
 @gateway_type="pin",
 @name="Pin Payments",
 @state="retained",
 @token="AdPo8AHJivOzPKHLThzz6gFg8fg",
 @updated_at="2016-08-11T17:15:43Z">

Gateway specific request fields

When interacting with Pin Payments gateway, you can specify below listed gateway specific fields when making the transaction call.

METADATA


curl https://core.spreedly.com/v1/gateways/LlkjmEk0xNkcWrNixXa1fvNoTP4/purchase.xml \
  -u 'Ll6fAtoVSTyVMlJEmtpoJV8S:RKOCG5D8D3fZxDSg504D0IxU2XD4Io5VXmyzdCtTivHFTTSy' \
  -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>
          <pin>
            <metadata>
              <order_id>Z00B33</order_id>
              <purchase_number>123456</purchase_number>
            </metadata>
          </pin>
        </gateway_specific_fields>
      </transaction>'

<transaction>
  <on_test_gateway type="boolean">true</on_test_gateway>
  <created_at type="dateTime">2017-03-14T20:24:17Z</created_at>
  <updated_at type="dateTime">2017-03-14T20:24:17Z</updated_at>
  <succeeded type="boolean">true</succeeded>
  <state>succeeded</state>
  <token>A28TR5q5k4ha1mE4H4OkJnW0xbP</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"/>
  <gateway_specific_fields>
    <pin>
      <metadata>
        <order_id>Z00B33</order_id>
        <purchase_number>123456</purchase_number>
      </metadata>
    </pin>
  </gateway_specific_fields>
  <gateway_specific_response_fields>
  </gateway_specific_response_fields>
  <gateway_transaction_id>57</gateway_transaction_id>
  <gateway_latency_ms type="integer">0</gateway_latency_ms>
  <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>
  <message key="messages.transaction_succeeded">Succeeded!</message>
  <gateway_token>LDAsrvRY2EDhtiGG950AAdAm5PJ</gateway_token>
  <shipping_address>
    <name>Elmo Mayert</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></error_code>
    <error_detail nil="true"/>
    <cancelled type="boolean">false</cancelled>
    <fraud_review nil="true"/>
    <created_at type="dateTime">2017-03-14T20:24:17Z</created_at>
    <updated_at type="dateTime">2017-03-14T20:24:17Z</updated_at>
  </response>
  <api_urls>
  </api_urls>
  <payment_method>
    <token>X35rj217lxtpc8vK548jqkMqRlY</token>
    <created_at type="dateTime">2017-02-28T17:28:33Z</created_at>
    <updated_at type="dateTime">2017-03-14T20:20:28Z</updated_at>
    <email nil="true"/>
    <data nil="true"/>
    <storage_state>retained</storage_state>
    <test type="boolean">true</test>
    <last_four_digits>1111</last_four_digits>
    <first_six_digits>411111</first_six_digits>
    <card_type>visa</card_type>
    <first_name>Elmo</first_name>
    <last_name>Mayert</last_name>
    <month type="integer">4</month>
    <year type="integer">2020</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>Elmo Mayert</full_name>
    <eligible_for_card_updater nil="true"/>
    <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 nil="true"/>
  </payment_method>
</transaction>


env = Spreedly::Environment.new('Ll6fAtoVSTyMlJEm', 'RKcG5D8D3fZxDSg504U2XD4Io5VXz')
env.purchase_on_gateway("LlkjmEk0xNkcWrNixXa1fvNoTP4", "56wyNnSmuA6CWYP7w0MiYCVIbW6", 1985,
  gateway_specific_fields: {
    pin: {
      metadata: {
        order_id: "Z00B33",
        purchase_number: "123456"
      }
    }
  }
)


#<Spreedly::Purchase:0x007fb2a90d1c00
 @amount="1985",
 @created_at="2017-03-14T20:20:28Z",
 @currency_code="USD",
 @description="",
 @email="",
 @gateway_specific_fields=
  {:pin=>{:metadata=>"\n        Z00B33\n        123456\n      "}},
 @gateway_token="LDAsrvRY2EDhtiGG950AAdAm5PJ",
 @gateway_transaction_id="49",
 @ip="",
 @merchant_location_descriptor="",
 @merchant_name_descriptor="",
 @message="Succeeded!",
 @on_test_gateway="true",
 @order_id="",
 @payment_method=
  #<Spreedly::CreditCard:0x007fb2a8ac0438
   @address1="",
   @address2="",
   @card_type="visa",
   @city="",
   @company="",
   @country="",
   @created_at="2017-02-28T17:28:33Z",
   @data="",
   @eligible_for_card_updater="",
   @email="",
   @errors=[],
   @fingerprint="",
   @first_name="Elmo",
   @first_six_digits="411111",
   @full_name="Elmo Mayert",
   @last_four_digits="1111",
   @last_name="Mayert",
   @month="4",
   @number="XXXX-XXXX-XXXX-1111",
   @phone_number="",
   @state="",
   @storage_state="retained",
   @token="X35rj217lxtpc8vK548jqkMqRlY",
   @updated_at="2017-03-14T20:20:27Z",
   @verification_value="",
   @year="2020",
   @zip="">,
 @response=
  #<Spreedly::Response:0x007fb2a8b0aab0
   @avs_code="",
   @avs_message="",
   @cancelled="false",
   @created_at="2017-03-14T20:20:28Z",
   @cvv_code="",
   @cvv_message="",
   @error_code="",
   @error_detail="",
   @fraud_review="",
   @message="Successful purchase",
   @pending="false",
   @success="true",
   @updated_at="2017-03-14T20:20:28Z">,
 @shipping_address=
  #<Spreedly::ShippingAddress:0x007fb2a8ae2650
   @address1="",
   @address2="",
   @city="",
   @country="",
   @name="Elmo Mayert",
   @phone_number="",
   @state="",
   @zip="">,
 @state="succeeded",
 @succeeded="true",
 @token="H2FOY1UcjBHzRXyOx7hZxf2F17F",
 @updated_at="2017-03-14T20:20:28Z">