first_data_gateway 1.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +7 -0
- data/README.md +123 -0
- data/Rakefile +8 -0
- data/docs/AccessTokenResponse.md +11 -0
- data/docs/Address.md +14 -0
- data/docs/Airline.md +21 -0
- data/docs/AirlineAncillaryServiceCategory.md +8 -0
- data/docs/AirlineTravelRoute.md +16 -0
- data/docs/Amount.md +10 -0
- data/docs/AmountComponents.md +14 -0
- data/docs/AuthenticationApi.md +68 -0
- data/docs/AuthenticationResponseVerification.md +10 -0
- data/docs/BasketItem.md +11 -0
- data/docs/Billing.md +13 -0
- data/docs/CarRental.md +15 -0
- data/docs/CarRentalExtraCharges.md +8 -0
- data/docs/CardVerificationsTransaction.md +9 -0
- data/docs/ClientLocale.md +9 -0
- data/docs/Contact.md +11 -0
- data/docs/Error.md +10 -0
- data/docs/ErrorDetails.md +9 -0
- data/docs/ErrorResponse.md +11 -0
- data/docs/Expiration.md +9 -0
- data/docs/Frequency.md +9 -0
- data/docs/IndustrySpecificExtensions.md +10 -0
- data/docs/InstallmentOptions.md +10 -0
- data/docs/Lodging.md +12 -0
- data/docs/LodgingExtraCharges.md +8 -0
- data/docs/Order.md +10 -0
- data/docs/OrderApi.md +148 -0
- data/docs/PayPal.md +8 -0
- data/docs/PaymentApi.md +345 -0
- data/docs/PaymentCard.md +15 -0
- data/docs/PaymentCardAuthenticationRequest.md +8 -0
- data/docs/PaymentCardAuthenticationResult.md +12 -0
- data/docs/PaymentMethod.md +11 -0
- data/docs/PaymentSchedulesRequest.md +21 -0
- data/docs/PaymentSchedulesResponse.md +11 -0
- data/docs/PaymentUrlRequest.md +11 -0
- data/docs/PaymentUrlResponse.md +13 -0
- data/docs/PrimaryTransaction.md +18 -0
- data/docs/PrimaryTransactionAdditionalDetails.md +14 -0
- data/docs/ProcessorData.md +10 -0
- data/docs/ResponseType.md +7 -0
- data/docs/SecondaryTransaction.md +9 -0
- data/docs/Sepa.md +12 -0
- data/docs/SepaMandate.md +11 -0
- data/docs/Shipping.md +10 -0
- data/docs/SplitShipment.md +9 -0
- data/docs/StoredCredential.md +11 -0
- data/docs/TransactionErrorResponse.md +28 -0
- data/docs/TransactionResponse.md +27 -0
- data/docs/TransactionResponseAuthenticationRedirect.md +10 -0
- data/docs/TransactionResponseAuthenticationRedirectParams.md +10 -0
- data/docs/TransactionType.md +7 -0
- data/first_data_gateway.gemspec +45 -0
- data/git_push.sh +55 -0
- data/lib/simple/client_context.rb +15 -0
- data/lib/simple/gateway.rb +155 -0
- data/lib/simple/merchant_credentials.rb +10 -0
- data/lib/simple/signature.rb +52 -0
- data/lib/simple_client.rb +4 -0
- data/lib/swagger_client.rb +91 -0
- data/lib/swagger_client/api/authentication_api.rb +111 -0
- data/lib/swagger_client/api/order_api.rb +229 -0
- data/lib/swagger_client/api/payment_api.rb +517 -0
- data/lib/swagger_client/api_client.rb +390 -0
- data/lib/swagger_client/api_error.rb +38 -0
- data/lib/swagger_client/configuration.rb +202 -0
- data/lib/swagger_client/models/access_token_response.rb +252 -0
- data/lib/swagger_client/models/address.rb +361 -0
- data/lib/swagger_client/models/airline.rb +487 -0
- data/lib/swagger_client/models/airline_ancillary_service_category.rb +221 -0
- data/lib/swagger_client/models/airline_travel_route.rb +406 -0
- data/lib/swagger_client/models/amount.rb +217 -0
- data/lib/swagger_client/models/amount_components.rb +242 -0
- data/lib/swagger_client/models/authentication_response_verification.rb +239 -0
- data/lib/swagger_client/models/basket_item.rb +218 -0
- data/lib/swagger_client/models/billing.rb +282 -0
- data/lib/swagger_client/models/car_rental.rb +317 -0
- data/lib/swagger_client/models/car_rental_extra_charges.rb +221 -0
- data/lib/swagger_client/models/card_verifications_transaction.rb +203 -0
- data/lib/swagger_client/models/client_locale.rb +209 -0
- data/lib/swagger_client/models/contact.rb +279 -0
- data/lib/swagger_client/models/error.rb +211 -0
- data/lib/swagger_client/models/error_details.rb +199 -0
- data/lib/swagger_client/models/error_response.rb +218 -0
- data/lib/swagger_client/models/expiration.rb +207 -0
- data/lib/swagger_client/models/frequency.rb +270 -0
- data/lib/swagger_client/models/industry_specific_extensions.rb +206 -0
- data/lib/swagger_client/models/installment_options.rb +259 -0
- data/lib/swagger_client/models/lodging.rb +245 -0
- data/lib/swagger_client/models/lodging_extra_charges.rb +221 -0
- data/lib/swagger_client/models/order.rb +206 -0
- data/lib/swagger_client/models/pay_pal.rb +213 -0
- data/lib/swagger_client/models/payment_card.rb +294 -0
- data/lib/swagger_client/models/payment_card_authentication_request.rb +222 -0
- data/lib/swagger_client/models/payment_card_authentication_result.rb +336 -0
- data/lib/swagger_client/models/payment_method.rb +254 -0
- data/lib/swagger_client/models/payment_schedules_request.rb +398 -0
- data/lib/swagger_client/models/payment_schedules_response.rb +267 -0
- data/lib/swagger_client/models/payment_url_request.rb +232 -0
- data/lib/swagger_client/models/payment_url_response.rb +286 -0
- data/lib/swagger_client/models/primary_transaction.rb +298 -0
- data/lib/swagger_client/models/primary_transaction_additional_details.rb +244 -0
- data/lib/swagger_client/models/processor_data.rb +216 -0
- data/lib/swagger_client/models/response_type.rb +37 -0
- data/lib/swagger_client/models/secondary_transaction.rb +197 -0
- data/lib/swagger_client/models/sepa.rb +321 -0
- data/lib/swagger_client/models/sepa_mandate.rb +321 -0
- data/lib/swagger_client/models/shipping.rb +222 -0
- data/lib/swagger_client/models/split_shipment.rb +201 -0
- data/lib/swagger_client/models/stored_credential.rb +290 -0
- data/lib/swagger_client/models/transaction_error_response.rb +445 -0
- data/lib/swagger_client/models/transaction_response.rb +436 -0
- data/lib/swagger_client/models/transaction_response_authentication_redirect.rb +239 -0
- data/lib/swagger_client/models/transaction_response_authentication_redirect_params.rb +206 -0
- data/lib/swagger_client/models/transaction_type.rb +36 -0
- data/lib/swagger_client/version.rb +15 -0
- data/spec/api/authentication_api_spec.rb +51 -0
- data/spec/api/order_api_spec.rb +73 -0
- data/spec/api/payment_api_spec.rb +126 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/access_token_response_spec.rb +64 -0
- data/spec/models/address_spec.rb +78 -0
- data/spec/models/airline_ancillary_service_category_spec.rb +46 -0
- data/spec/models/airline_spec.rb +124 -0
- data/spec/models/airline_travel_route_spec.rb +94 -0
- data/spec/models/amount_components_spec.rb +78 -0
- data/spec/models/amount_spec.rb +54 -0
- data/spec/models/authentication_response_verification_spec.rb +58 -0
- data/spec/models/basket_item_spec.rb +60 -0
- data/spec/models/billing_spec.rb +76 -0
- data/spec/models/car_rental_extra_charges_spec.rb +46 -0
- data/spec/models/car_rental_spec.rb +84 -0
- data/spec/models/card_verifications_transaction_spec.rb +48 -0
- data/spec/models/client_locale_spec.rb +48 -0
- data/spec/models/contact_spec.rb +60 -0
- data/spec/models/error_details_spec.rb +48 -0
- data/spec/models/error_response_spec.rb +60 -0
- data/spec/models/error_spec.rb +54 -0
- data/spec/models/expiration_spec.rb +48 -0
- data/spec/models/frequency_spec.rb +52 -0
- data/spec/models/industry_specific_extensions_spec.rb +54 -0
- data/spec/models/installment_options_spec.rb +54 -0
- data/spec/models/lodging_extra_charges_spec.rb +46 -0
- data/spec/models/lodging_spec.rb +66 -0
- data/spec/models/order_spec.rb +54 -0
- data/spec/models/pay_pal_spec.rb +42 -0
- data/spec/models/payment_card_authentication_request_spec.rb +46 -0
- data/spec/models/payment_card_authentication_result_spec.rb +78 -0
- data/spec/models/payment_card_spec.rb +88 -0
- data/spec/models/payment_method_spec.rb +64 -0
- data/spec/models/payment_schedules_request_spec.rb +124 -0
- data/spec/models/payment_schedules_response_spec.rb +64 -0
- data/spec/models/payment_url_request_spec.rb +60 -0
- data/spec/models/payment_url_response_spec.rb +76 -0
- data/spec/models/primary_transaction_additional_details_spec.rb +78 -0
- data/spec/models/primary_transaction_spec.rb +102 -0
- data/spec/models/processor_data_spec.rb +54 -0
- data/spec/models/response_type_spec.rb +36 -0
- data/spec/models/secondary_transaction_spec.rb +48 -0
- data/spec/models/sepa_mandate_spec.rb +64 -0
- data/spec/models/sepa_spec.rb +66 -0
- data/spec/models/shipping_spec.rb +54 -0
- data/spec/models/split_shipment_spec.rb +48 -0
- data/spec/models/stored_credential_spec.rb +68 -0
- data/spec/models/transaction_error_response_spec.rb +170 -0
- data/spec/models/transaction_response_authentication_redirect_params_spec.rb +54 -0
- data/spec/models/transaction_response_authentication_redirect_spec.rb +58 -0
- data/spec/models/transaction_response_spec.rb +164 -0
- data/spec/models/transaction_type_spec.rb +36 -0
- data/spec/spec_helper.rb +111 -0
- metadata +457 -0
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# SwaggerClient::ErrorDetails
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**field** | **String** | The property or attribute associated with the error. | [optional]
|
|
7
|
+
**message** | **String** | Information specific to a property or attribute. | [optional]
|
|
8
|
+
|
|
9
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
# SwaggerClient::ErrorResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**client_request_id** | **String** | Echoes back the value from the request header for tracking | [optional]
|
|
7
|
+
**api_trace_id** | **String** | Request identifier in API. Use this to request logs from support. | [optional]
|
|
8
|
+
**response_type** | [**ResponseType**](ResponseType.md) | The schema type returned in the response. | [optional]
|
|
9
|
+
**error** | [**Error**](Error.md) | | [optional]
|
|
10
|
+
|
|
11
|
+
|
data/docs/Expiration.md
ADDED
data/docs/Frequency.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# SwaggerClient::IndustrySpecificExtensions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**airline** | [**Airline**](Airline.md) | | [optional]
|
|
7
|
+
**lodging** | [**Lodging**](Lodging.md) | | [optional]
|
|
8
|
+
**car_rental** | [**CarRental**](CarRental.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# SwaggerClient::InstallmentOptions
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**number_of_installments** | **Integer** | Number of installments for a Sale transaction if the customer pays the total amount in multiple transactions | [optional]
|
|
7
|
+
**installments_interest** | **BOOLEAN** | Indicates whether the installment interest amount has been applied. Possible values are \"yes\" or \"no\". | [optional]
|
|
8
|
+
**installment_delay_months** | **Integer** | The number of months the first installment payment will be delayed | [optional]
|
|
9
|
+
|
|
10
|
+
|
data/docs/Lodging.md
ADDED
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
# SwaggerClient::Lodging
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**arrival_date** | **Date** | Date of arrival | [optional]
|
|
7
|
+
**departure_date** | **Date** | Date of departure | [optional]
|
|
8
|
+
**folio_number** | **String** | Portfolio number | [optional]
|
|
9
|
+
**extra_charges** | [**Array<LodgingExtraCharges>**](LodgingExtraCharges.md) | | [optional]
|
|
10
|
+
**no_show_indicator** | **BOOLEAN** | | [optional]
|
|
11
|
+
|
|
12
|
+
|
data/docs/Order.md
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
# SwaggerClient::Order
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
Name | Type | Description | Notes
|
|
5
|
+
------------ | ------------- | ------------- | -------------
|
|
6
|
+
**order_id** | **String** | | [optional]
|
|
7
|
+
**billing** | [**Billing**](Billing.md) | | [optional]
|
|
8
|
+
**shipping** | [**Shipping**](Shipping.md) | | [optional]
|
|
9
|
+
|
|
10
|
+
|
data/docs/OrderApi.md
ADDED
|
@@ -0,0 +1,148 @@
|
|
|
1
|
+
# SwaggerClient::OrderApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://cert.api.firstdata.com/gateway*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**perform_payment_post_authorisation**](OrderApi.md#perform_payment_post_authorisation) | **POST** /v1/orders/{order-id}/postauth | Use this to capture/complete a transaction. Partial postauths are allowed.
|
|
8
|
+
[**return_transaction**](OrderApi.md#return_transaction) | **POST** /v1/orders/{order-id}/return | Use this to return/refund on the order. Partial returns are allowed.
|
|
9
|
+
|
|
10
|
+
|
|
11
|
+
# **perform_payment_post_authorisation**
|
|
12
|
+
> TransactionResponse perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, message_signature, order_id, payload, opts)
|
|
13
|
+
|
|
14
|
+
Use this to capture/complete a transaction. Partial postauths are allowed.
|
|
15
|
+
|
|
16
|
+
This can be used for postauth and partial postauths.
|
|
17
|
+
|
|
18
|
+
### Example
|
|
19
|
+
```ruby
|
|
20
|
+
# load the gem
|
|
21
|
+
require 'swagger_client'
|
|
22
|
+
|
|
23
|
+
api_instance = SwaggerClient::OrderApi.new
|
|
24
|
+
|
|
25
|
+
content_type = "application/json" # String | content type
|
|
26
|
+
|
|
27
|
+
client_request_id = "client_request_id_example" # String | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
|
28
|
+
|
|
29
|
+
api_key = "api_key_example" # String |
|
|
30
|
+
|
|
31
|
+
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
|
32
|
+
|
|
33
|
+
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
|
34
|
+
|
|
35
|
+
order_id = "order_id_example" # String | Gateway order identifier as returned in the parameter orderId
|
|
36
|
+
|
|
37
|
+
payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
|
|
38
|
+
|
|
39
|
+
opts = {
|
|
40
|
+
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
|
41
|
+
}
|
|
42
|
+
|
|
43
|
+
begin
|
|
44
|
+
#Use this to capture/complete a transaction. Partial postauths are allowed.
|
|
45
|
+
result = api_instance.perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, message_signature, order_id, payload, opts)
|
|
46
|
+
p result
|
|
47
|
+
rescue SwaggerClient::ApiError => e
|
|
48
|
+
puts "Exception when calling OrderApi->perform_payment_post_authorisation: #{e}"
|
|
49
|
+
end
|
|
50
|
+
```
|
|
51
|
+
|
|
52
|
+
### Parameters
|
|
53
|
+
|
|
54
|
+
Name | Type | Description | Notes
|
|
55
|
+
------------- | ------------- | ------------- | -------------
|
|
56
|
+
**content_type** | **String**| content type | [default to application/json]
|
|
57
|
+
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
|
58
|
+
**api_key** | **String**| |
|
|
59
|
+
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
|
60
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
|
61
|
+
**order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
|
|
62
|
+
**payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
|
|
63
|
+
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
|
64
|
+
|
|
65
|
+
### Return type
|
|
66
|
+
|
|
67
|
+
[**TransactionResponse**](TransactionResponse.md)
|
|
68
|
+
|
|
69
|
+
### Authorization
|
|
70
|
+
|
|
71
|
+
No authorization required
|
|
72
|
+
|
|
73
|
+
### HTTP request headers
|
|
74
|
+
|
|
75
|
+
- **Content-Type**: application/json
|
|
76
|
+
- **Accept**: application/json
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
# **return_transaction**
|
|
81
|
+
> TransactionResponse return_transaction(content_type, client_request_id, api_key, timestamp, message_signature, order_id, payload, opts)
|
|
82
|
+
|
|
83
|
+
Use this to return/refund on the order. Partial returns are allowed.
|
|
84
|
+
|
|
85
|
+
This can be used for Returns and Partial Returns.
|
|
86
|
+
|
|
87
|
+
### Example
|
|
88
|
+
```ruby
|
|
89
|
+
# load the gem
|
|
90
|
+
require 'swagger_client'
|
|
91
|
+
|
|
92
|
+
api_instance = SwaggerClient::OrderApi.new
|
|
93
|
+
|
|
94
|
+
content_type = "application/json" # String | content type
|
|
95
|
+
|
|
96
|
+
client_request_id = "client_request_id_example" # String | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
|
97
|
+
|
|
98
|
+
api_key = "api_key_example" # String |
|
|
99
|
+
|
|
100
|
+
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
|
101
|
+
|
|
102
|
+
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
|
103
|
+
|
|
104
|
+
order_id = "order_id_example" # String | Gateway order identifier as returned in the parameter orderId
|
|
105
|
+
|
|
106
|
+
payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
|
|
107
|
+
|
|
108
|
+
opts = {
|
|
109
|
+
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
begin
|
|
113
|
+
#Use this to return/refund on the order. Partial returns are allowed.
|
|
114
|
+
result = api_instance.return_transaction(content_type, client_request_id, api_key, timestamp, message_signature, order_id, payload, opts)
|
|
115
|
+
p result
|
|
116
|
+
rescue SwaggerClient::ApiError => e
|
|
117
|
+
puts "Exception when calling OrderApi->return_transaction: #{e}"
|
|
118
|
+
end
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
### Parameters
|
|
122
|
+
|
|
123
|
+
Name | Type | Description | Notes
|
|
124
|
+
------------- | ------------- | ------------- | -------------
|
|
125
|
+
**content_type** | **String**| content type | [default to application/json]
|
|
126
|
+
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
|
127
|
+
**api_key** | **String**| |
|
|
128
|
+
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
|
129
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
|
130
|
+
**order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
|
|
131
|
+
**payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
|
|
132
|
+
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
|
133
|
+
|
|
134
|
+
### Return type
|
|
135
|
+
|
|
136
|
+
[**TransactionResponse**](TransactionResponse.md)
|
|
137
|
+
|
|
138
|
+
### Authorization
|
|
139
|
+
|
|
140
|
+
No authorization required
|
|
141
|
+
|
|
142
|
+
### HTTP request headers
|
|
143
|
+
|
|
144
|
+
- **Content-Type**: application/json
|
|
145
|
+
- **Accept**: application/json
|
|
146
|
+
|
|
147
|
+
|
|
148
|
+
|
data/docs/PayPal.md
ADDED
data/docs/PaymentApi.md
ADDED
|
@@ -0,0 +1,345 @@
|
|
|
1
|
+
# SwaggerClient::PaymentApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://cert.api.firstdata.com/gateway*
|
|
4
|
+
|
|
5
|
+
Method | HTTP request | Description
|
|
6
|
+
------------- | ------------- | -------------
|
|
7
|
+
[**perform_payment_post_authorisation**](PaymentApi.md#perform_payment_post_authorisation) | **POST** /v1/payments/{transaction-id}/postauth | Use this to capture/complete a transaction. Partial postauths are allowed.
|
|
8
|
+
[**primary_payment_transaction**](PaymentApi.md#primary_payment_transaction) | **POST** /v1/payments | Generate a primary transaction
|
|
9
|
+
[**return_transaction**](PaymentApi.md#return_transaction) | **POST** /v1/payments/{transaction-id}/return | Return/refund a transaction.
|
|
10
|
+
[**transaction_inquiry**](PaymentApi.md#transaction_inquiry) | **GET** /v1/payments/{transaction-id} | Retrieve the state of a transaction
|
|
11
|
+
[**void_transaction**](PaymentApi.md#void_transaction) | **POST** /v1/payments/{transaction-id}/void | Reverse a previous action on an existing transaction
|
|
12
|
+
|
|
13
|
+
|
|
14
|
+
# **perform_payment_post_authorisation**
|
|
15
|
+
> TransactionResponse perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, payload, opts)
|
|
16
|
+
|
|
17
|
+
Use this to capture/complete a transaction. Partial postauths are allowed.
|
|
18
|
+
|
|
19
|
+
This can be used for postauth and partial postauths.
|
|
20
|
+
|
|
21
|
+
### Example
|
|
22
|
+
```ruby
|
|
23
|
+
# load the gem
|
|
24
|
+
require 'swagger_client'
|
|
25
|
+
|
|
26
|
+
api_instance = SwaggerClient::PaymentApi.new
|
|
27
|
+
|
|
28
|
+
content_type = "application/json" # String | content type
|
|
29
|
+
|
|
30
|
+
client_request_id = "client_request_id_example" # String | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
|
31
|
+
|
|
32
|
+
api_key = "api_key_example" # String |
|
|
33
|
+
|
|
34
|
+
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
|
35
|
+
|
|
36
|
+
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
|
37
|
+
|
|
38
|
+
transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
|
|
39
|
+
|
|
40
|
+
payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
|
|
41
|
+
|
|
42
|
+
opts = {
|
|
43
|
+
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
|
44
|
+
}
|
|
45
|
+
|
|
46
|
+
begin
|
|
47
|
+
#Use this to capture/complete a transaction. Partial postauths are allowed.
|
|
48
|
+
result = api_instance.perform_payment_post_authorisation(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, payload, opts)
|
|
49
|
+
p result
|
|
50
|
+
rescue SwaggerClient::ApiError => e
|
|
51
|
+
puts "Exception when calling PaymentApi->perform_payment_post_authorisation: #{e}"
|
|
52
|
+
end
|
|
53
|
+
```
|
|
54
|
+
|
|
55
|
+
### Parameters
|
|
56
|
+
|
|
57
|
+
Name | Type | Description | Notes
|
|
58
|
+
------------- | ------------- | ------------- | -------------
|
|
59
|
+
**content_type** | **String**| content type | [default to application/json]
|
|
60
|
+
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
|
61
|
+
**api_key** | **String**| |
|
|
62
|
+
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
|
63
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
|
64
|
+
**transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
|
|
65
|
+
**payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
|
|
66
|
+
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
|
67
|
+
|
|
68
|
+
### Return type
|
|
69
|
+
|
|
70
|
+
[**TransactionResponse**](TransactionResponse.md)
|
|
71
|
+
|
|
72
|
+
### Authorization
|
|
73
|
+
|
|
74
|
+
No authorization required
|
|
75
|
+
|
|
76
|
+
### HTTP request headers
|
|
77
|
+
|
|
78
|
+
- **Content-Type**: application/json
|
|
79
|
+
- **Accept**: application/json
|
|
80
|
+
|
|
81
|
+
|
|
82
|
+
|
|
83
|
+
# **primary_payment_transaction**
|
|
84
|
+
> TransactionResponse primary_payment_transaction(content_type, client_request_id, api_key, timestamp, message_signature, payload)
|
|
85
|
+
|
|
86
|
+
Generate a primary transaction
|
|
87
|
+
|
|
88
|
+
Use this to originate a financial transaction, like a sale, preauthorization, or credit.
|
|
89
|
+
|
|
90
|
+
### Example
|
|
91
|
+
```ruby
|
|
92
|
+
# load the gem
|
|
93
|
+
require 'swagger_client'
|
|
94
|
+
|
|
95
|
+
api_instance = SwaggerClient::PaymentApi.new
|
|
96
|
+
|
|
97
|
+
content_type = "application/json" # String | content type
|
|
98
|
+
|
|
99
|
+
client_request_id = "client_request_id_example" # String | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
|
100
|
+
|
|
101
|
+
api_key = "api_key_example" # String |
|
|
102
|
+
|
|
103
|
+
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
|
104
|
+
|
|
105
|
+
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
|
106
|
+
|
|
107
|
+
payload = SwaggerClient::PrimaryTransaction.new # PrimaryTransaction | Primary Transaction request
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
begin
|
|
111
|
+
#Generate a primary transaction
|
|
112
|
+
result = api_instance.primary_payment_transaction(content_type, client_request_id, api_key, timestamp, message_signature, payload)
|
|
113
|
+
p result
|
|
114
|
+
rescue SwaggerClient::ApiError => e
|
|
115
|
+
puts "Exception when calling PaymentApi->primary_payment_transaction: #{e}"
|
|
116
|
+
end
|
|
117
|
+
```
|
|
118
|
+
|
|
119
|
+
### Parameters
|
|
120
|
+
|
|
121
|
+
Name | Type | Description | Notes
|
|
122
|
+
------------- | ------------- | ------------- | -------------
|
|
123
|
+
**content_type** | **String**| content type | [default to application/json]
|
|
124
|
+
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
|
125
|
+
**api_key** | **String**| |
|
|
126
|
+
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
|
127
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
|
128
|
+
**payload** | [**PrimaryTransaction**](PrimaryTransaction.md)| Primary Transaction request |
|
|
129
|
+
|
|
130
|
+
### Return type
|
|
131
|
+
|
|
132
|
+
[**TransactionResponse**](TransactionResponse.md)
|
|
133
|
+
|
|
134
|
+
### Authorization
|
|
135
|
+
|
|
136
|
+
No authorization required
|
|
137
|
+
|
|
138
|
+
### HTTP request headers
|
|
139
|
+
|
|
140
|
+
- **Content-Type**: application/json
|
|
141
|
+
- **Accept**: application/json
|
|
142
|
+
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
# **return_transaction**
|
|
146
|
+
> TransactionResponse return_transaction(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, payload, opts)
|
|
147
|
+
|
|
148
|
+
Return/refund a transaction.
|
|
149
|
+
|
|
150
|
+
Use this to return/refund an existing transaction. Partial returns are allowed.
|
|
151
|
+
|
|
152
|
+
### Example
|
|
153
|
+
```ruby
|
|
154
|
+
# load the gem
|
|
155
|
+
require 'swagger_client'
|
|
156
|
+
|
|
157
|
+
api_instance = SwaggerClient::PaymentApi.new
|
|
158
|
+
|
|
159
|
+
content_type = "application/json" # String | content type
|
|
160
|
+
|
|
161
|
+
client_request_id = "client_request_id_example" # String | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
|
162
|
+
|
|
163
|
+
api_key = "api_key_example" # String |
|
|
164
|
+
|
|
165
|
+
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
|
166
|
+
|
|
167
|
+
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
|
168
|
+
|
|
169
|
+
transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
|
|
170
|
+
|
|
171
|
+
payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
|
|
172
|
+
|
|
173
|
+
opts = {
|
|
174
|
+
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
|
175
|
+
}
|
|
176
|
+
|
|
177
|
+
begin
|
|
178
|
+
#Return/refund a transaction.
|
|
179
|
+
result = api_instance.return_transaction(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, payload, opts)
|
|
180
|
+
p result
|
|
181
|
+
rescue SwaggerClient::ApiError => e
|
|
182
|
+
puts "Exception when calling PaymentApi->return_transaction: #{e}"
|
|
183
|
+
end
|
|
184
|
+
```
|
|
185
|
+
|
|
186
|
+
### Parameters
|
|
187
|
+
|
|
188
|
+
Name | Type | Description | Notes
|
|
189
|
+
------------- | ------------- | ------------- | -------------
|
|
190
|
+
**content_type** | **String**| content type | [default to application/json]
|
|
191
|
+
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
|
192
|
+
**api_key** | **String**| |
|
|
193
|
+
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
|
194
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
|
195
|
+
**transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
|
|
196
|
+
**payload** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
|
|
197
|
+
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
|
198
|
+
|
|
199
|
+
### Return type
|
|
200
|
+
|
|
201
|
+
[**TransactionResponse**](TransactionResponse.md)
|
|
202
|
+
|
|
203
|
+
### Authorization
|
|
204
|
+
|
|
205
|
+
No authorization required
|
|
206
|
+
|
|
207
|
+
### HTTP request headers
|
|
208
|
+
|
|
209
|
+
- **Content-Type**: application/json
|
|
210
|
+
- **Accept**: application/json
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
# **transaction_inquiry**
|
|
215
|
+
> TransactionResponse transaction_inquiry(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, , opts)
|
|
216
|
+
|
|
217
|
+
Retrieve the state of a transaction
|
|
218
|
+
|
|
219
|
+
Use this query to get the current state of an existing transaction.
|
|
220
|
+
|
|
221
|
+
### Example
|
|
222
|
+
```ruby
|
|
223
|
+
# load the gem
|
|
224
|
+
require 'swagger_client'
|
|
225
|
+
|
|
226
|
+
api_instance = SwaggerClient::PaymentApi.new
|
|
227
|
+
|
|
228
|
+
content_type = "application/json" # String | content type
|
|
229
|
+
|
|
230
|
+
client_request_id = "client_request_id_example" # String | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
|
231
|
+
|
|
232
|
+
api_key = "api_key_example" # String |
|
|
233
|
+
|
|
234
|
+
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
|
235
|
+
|
|
236
|
+
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
|
237
|
+
|
|
238
|
+
transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
|
|
239
|
+
|
|
240
|
+
opts = {
|
|
241
|
+
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
|
242
|
+
}
|
|
243
|
+
|
|
244
|
+
begin
|
|
245
|
+
#Retrieve the state of a transaction
|
|
246
|
+
result = api_instance.transaction_inquiry(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, , opts)
|
|
247
|
+
p result
|
|
248
|
+
rescue SwaggerClient::ApiError => e
|
|
249
|
+
puts "Exception when calling PaymentApi->transaction_inquiry: #{e}"
|
|
250
|
+
end
|
|
251
|
+
```
|
|
252
|
+
|
|
253
|
+
### Parameters
|
|
254
|
+
|
|
255
|
+
Name | Type | Description | Notes
|
|
256
|
+
------------- | ------------- | ------------- | -------------
|
|
257
|
+
**content_type** | **String**| content type | [default to application/json]
|
|
258
|
+
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
|
259
|
+
**api_key** | **String**| |
|
|
260
|
+
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
|
261
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
|
262
|
+
**transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
|
|
263
|
+
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
|
264
|
+
|
|
265
|
+
### Return type
|
|
266
|
+
|
|
267
|
+
[**TransactionResponse**](TransactionResponse.md)
|
|
268
|
+
|
|
269
|
+
### Authorization
|
|
270
|
+
|
|
271
|
+
No authorization required
|
|
272
|
+
|
|
273
|
+
### HTTP request headers
|
|
274
|
+
|
|
275
|
+
- **Content-Type**: application/json
|
|
276
|
+
- **Accept**: application/json
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
|
|
280
|
+
# **void_transaction**
|
|
281
|
+
> TransactionResponse void_transaction(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, , opts)
|
|
282
|
+
|
|
283
|
+
Reverse a previous action on an existing transaction
|
|
284
|
+
|
|
285
|
+
Use this to reverse a postauth/completion, credit, preauth, or sale.
|
|
286
|
+
|
|
287
|
+
### Example
|
|
288
|
+
```ruby
|
|
289
|
+
# load the gem
|
|
290
|
+
require 'swagger_client'
|
|
291
|
+
|
|
292
|
+
api_instance = SwaggerClient::PaymentApi.new
|
|
293
|
+
|
|
294
|
+
content_type = "application/json" # String | content type
|
|
295
|
+
|
|
296
|
+
client_request_id = "client_request_id_example" # String | A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format.
|
|
297
|
+
|
|
298
|
+
api_key = "api_key_example" # String |
|
|
299
|
+
|
|
300
|
+
timestamp = 789 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
|
301
|
+
|
|
302
|
+
message_signature = "message_signature_example" # String | Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal.
|
|
303
|
+
|
|
304
|
+
transaction_id = "transaction_id_example" # String | Gateway transaction identifier as returned in the parameter ipgTransactionId
|
|
305
|
+
|
|
306
|
+
opts = {
|
|
307
|
+
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
|
308
|
+
}
|
|
309
|
+
|
|
310
|
+
begin
|
|
311
|
+
#Reverse a previous action on an existing transaction
|
|
312
|
+
result = api_instance.void_transaction(content_type, client_request_id, api_key, timestamp, message_signature, transaction_id, , opts)
|
|
313
|
+
p result
|
|
314
|
+
rescue SwaggerClient::ApiError => e
|
|
315
|
+
puts "Exception when calling PaymentApi->void_transaction: #{e}"
|
|
316
|
+
end
|
|
317
|
+
```
|
|
318
|
+
|
|
319
|
+
### Parameters
|
|
320
|
+
|
|
321
|
+
Name | Type | Description | Notes
|
|
322
|
+
------------- | ------------- | ------------- | -------------
|
|
323
|
+
**content_type** | **String**| content type | [default to application/json]
|
|
324
|
+
**client_request_id** | **String**| A client-generated ID for request tracking and signature creation, unique per request. This is also used for idempotency control. We recommend 128-bit UUID format. |
|
|
325
|
+
**api_key** | **String**| |
|
|
326
|
+
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
|
327
|
+
**message_signature** | **String**| Used to ensure the request has not been tampered with during transmission. The Message-Signature is the Base64 encoded HMAC hash (SHA256 algorithm with the API Secret as the key.) For more information, refer to the supporting documentation on the Developer Portal. |
|
|
328
|
+
**transaction_id** | **String**| Gateway transaction identifier as returned in the parameter ipgTransactionId |
|
|
329
|
+
**store_id** | **String**| an optional outlet id for clients that support multiple store in the same developer app | [optional]
|
|
330
|
+
|
|
331
|
+
### Return type
|
|
332
|
+
|
|
333
|
+
[**TransactionResponse**](TransactionResponse.md)
|
|
334
|
+
|
|
335
|
+
### Authorization
|
|
336
|
+
|
|
337
|
+
No authorization required
|
|
338
|
+
|
|
339
|
+
### HTTP request headers
|
|
340
|
+
|
|
341
|
+
- **Content-Type**: application/json
|
|
342
|
+
- **Accept**: application/json
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|