Decidir Plus gateway guide
Additional notes |
---|
Decidir Plus does not support direct credit card payments; instead, merchants must tokenize a credit card with Decidir Plus gateway using the Spreedly store API and then use the third party token returned from the store call as the payment method with the Spreedly purchase API. |
Adding a Decidir Plus gateway
To add a Decidir Plus gateway:
curl https://core.spreedly.com/v1/gateways.xml \
-u 'C7cRfNJGODKh4Iu5Ox3PToKjniY:4UIuWybmdythfNGPqAqyQnYha6s451ri0fYAo4p3drZUi7q2Jf4b7HKg8etDtoKJ' \
-H 'Content-Type: application/xml' \
-d '<gateway>
<gateway_type>decidir_plus</gateway_type>
<public_key>Your api key</public_key>
<private_key>Your private key</private_key>
</gateway>'
<gateway>
<token>Gn5e4pbQz7n2RM8q1AfQtjuHT5l</token>
<gateway_type>decidir_plus</gateway_type>
<name>Decidir Plus</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">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">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>
</characteristics>
<credentials>
</credentials>
<gateway_settings>
</gateway_settings>
<gateway_specific_fields>
<gateway_specific_field>site_transaction_id</gateway_specific_field>
<gateway_specific_field>installments</gateway_specific_field>
<gateway_specific_field>payment_type</gateway_specific_field>
<gateway_specific_field>sub_payments</gateway_specific_field>
<gateway_specific_field>fraud_detection</gateway_specific_field>
<gateway_specific_field>customer</gateway_specific_field>
<gateway_specific_field>name_override</gateway_specific_field>
<gateway_specific_field>debit</gateway_specific_field>
<gateway_specific_field>payment_method_id</gateway_specific_field>
<gateway_specific_field>card_holder_identification_type</gateway_specific_field>
<gateway_specific_field>card_holder_identification_number</gateway_specific_field>
<gateway_specific_field>card_holder_door_number</gateway_specific_field>
<gateway_specific_field>card_holder_birthday</gateway_specific_field>
<gateway_specific_field>establishment_name</gateway_specific_field>
<gateway_specific_field>aggregate_data</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>
<mode>default</mode>
<created_at type="dateTime">2022-03-22T18:55:02Z</created_at>
<updated_at type="dateTime">2022-03-22T18:55:02Z</updated_at>
</gateway>
Gateway specific fields
When interacting with a Decidir Plus gateway to run transactions, there are a number of gateway specific fields you can specify. See below for usage notes for certain fields, and Decidir Plus’s documentation for more information.
payment_type
- type of payment, one ofsingle
ordistributed
; defaults tosingle
installments
- number of payment installments; defaults to 1site_transaction_id
- the specific merchant site for this transaction; for more information, see the Decidir Plus documentation.establishment_name
- business namesub_payments
- anarray
of the payment breakdowns for the given transactionsite_id
installments
amount
fraud_detection
- ahash
of key/value pairssend_to_cs
- boolean- channel
dispatch_mode
csmdds
- anarray
of hashed valuescode
description
aggregate_data
- a container for the fields required for payment aggregators. See the Decidir documentation for more information.indicator
identification_number
bill_to_pay
bill_to_refund
merchant_name
street
number
postal_code
category
channel
geographic_code
city
merchant_id
province
country
merchant_email
merchant_phone
The following fields are provided with Visa transactions for additional validation:
card_holder_identification_type
- the card holder’s national identification type;DNI
orCUIL
card_holder_identification_number
- the card holder’s national identification numbercard_door_number
- the card holder’s delivery address door numbercard_holder_birthday
- the card holder’s birthday; formatted asMMDDYYYY
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>
<decidir_plus>
<site_transaction_id>1234567</site_transaction_id>
<payment_type>single</payment_type>
<card_holder_identification_type>dni</card_holder_identification_type>
<card_holder_identification_number>44567890</card_holder_identification_number>
<card_holder_door_number>348</card_holder_door_number>
<card_holder_birthday>01012017</card_holder_birthday>
<establishment_name>Heavenly Buffaloes</establishment_name>
<installments>1</installments>
<sub_payments>
<site_id>1234568</site_id>
<installments>2</installments>
<amount>7600</amount>
</sub_payments>
<fraud_detection>
<send_to_cs>true</send_to_cs>
<channel>web</channel>
<dispatch_mode>store pickup</dispatch_mode>
<csmdds>
<code>17</code>
<description>Campo MDD17</description>
</csmdds>
</fraud_detection>
<aggregate_data>
<indicator>1</indicator>
<identification_number>308103480</identification_number>
<bill_to_pay>test1</bill_to_pay>
<bill_to_refund>test2</bill_to_refund>
<merchant_name>Heavenly Buffaloes</merchant_name>
<street>Sesame</street>
<number>123</number>
<postal_code>22001</postal_code>
<category>yum</category>
<channel>005</channel>
<geographic_code>C1234</geographic_code>
<city>Ciudad de Buenos Aires</city>
<merchant_id>dec_agg</merchant_id>
<province>Buenos Aires</province>
<country>Argentina</country>
<merchant_email>[email protected]</merchant_email>
<merchant_phone>2678433111</merchant_phone>
</aggregate_data>
</decidir_plus>
</gateway_specific_fields>
</transaction>'
<transaction>
<on_test_gateway type="boolean">true</on_test_gateway>
<created_at type="dateTime">2022-03-22T18:55:00Z</created_at>
<updated_at type="dateTime">2022-03-22T18:55:00Z</updated_at>
<succeeded type="boolean">true</succeeded>
<state>succeeded</state>
<token>T6rCFx54ah3bdiu5RP9gyudTrUz</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>
<decidir_plus>
<site_transaction_id>1234567</site_transaction_id>
<payment_type>single</payment_type>
<card_holder_identification_type>dni</card_holder_identification_type>
<card_holder_identification_number>44567890</card_holder_identification_number>
<card_holder_door_number>348</card_holder_door_number>
<card_holder_birthday>01012017</card_holder_birthday>
<establishment_name>Heavenly Buffaloes</establishment_name>
<installments>1</installments>
<sub_payments>
<site_id>1234568</site_id>
<installments>2</installments>
<amount>7600</amount>
</sub_payments>
<fraud_detection>
<send_to_cs>true</send_to_cs>
<channel>web</channel>
<dispatch_mode>store pickup</dispatch_mode>
<csmdds>
<code>17</code>
<description>Campo MDD17</description>
</csmdds>
</fraud_detection>
<aggregate_data>
<indicator>1</indicator>
<identification_number>308103480</identification_number>
<bill_to_pay>test1</bill_to_pay>
<bill_to_refund>test2</bill_to_refund>
<merchant_name>Heavenly Buffaloes</merchant_name>
<street>Sesame</street>
<number>123</number>
<postal_code>22001</postal_code>
<category>yum</category>
<channel>005</channel>
<geographic_code>C1234</geographic_code>
<city>Ciudad de Buenos Aires</city>
<merchant_id>dec_agg</merchant_id>
<province>Buenos Aires</province>
<country>Argentina</country>
<merchant_email>[email protected]</merchant_email>
<merchant_phone>2678433111</merchant_phone>
</aggregate_data>
</decidir_plus>
</gateway_specific_fields>
<gateway_specific_response_fields>
</gateway_specific_response_fields>
<gateway_transaction_id>55</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>
<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-03-22T18:55:00Z</created_at>
<updated_at type="dateTime">2022-03-22T18:55:00Z</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-03-22T09:10:50Z</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>
Please refer to using a payment method for more information on how to send GSFs
Gateway specific response fields
A response from Decidir Plus may contain the following fields:
card_authorization_code
ticket
customer_token
site_transaction_id
payment_method_id
bin
installments
payment_type
sub_payments
<transaction>
<token>LgpTNGjsWQs9DwdxcbreUVz0R8p</token>
<transaction_type>Store</transaction_type>
<gateway_specific_response_fields>
<decidir>
<card_authorization_code>123456</card_authorization_code>
<ticket>78902345</ticket>
<customer_token>abc123</customer_token>
<site_transaction_id>ecf63822310p401971ce712ed502637c</site_transaction_id>
<payment_method_id>1</payment_method_id>
<bin>123456</bin>
<installments>3</installments>
<payment_type>Single</payment_type>
<sub_payments>['A', 'B', 'C']<sub_payments>
</decidir>
</gateway_specific_response_fields>
</transaction>
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.
Updated 5 months ago