first_data_gateway 1.0.3 → 1.1.0
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 +4 -4
- data/Gemfile +1 -0
- data/README.md +144 -65
- data/Rakefile +2 -0
- data/docs/AVSResponse.md +9 -0
- data/docs/AccessTokenResponse.md +2 -3
- data/docs/AdditionalAmountRate.md +9 -0
- data/docs/AdditionalTransactionDetails.md +10 -0
- data/docs/Address.md +5 -5
- data/docs/Airline.md +14 -14
- data/docs/AirlineAncillaryServiceCategory.md +2 -2
- data/docs/AirlineTravelRoute.md +8 -8
- data/docs/AliPay.md +11 -0
- data/docs/Amount.md +2 -2
- data/docs/AmountComponents.md +8 -8
- data/docs/AuthenticationApi.md +19 -24
- data/docs/AuthenticationRequest.md +9 -0
- data/docs/AuthenticationResponseVerification.md +5 -4
- data/docs/AuthenticationResponseVerificationRequest.md +11 -0
- data/docs/BasicResponse.md +10 -0
- data/docs/BasketItem.md +2 -2
- data/docs/Billing.md +6 -5
- data/docs/BillingAddress.md +17 -0
- data/docs/BillingAddressPhone.md +9 -0
- data/docs/CarRental.md +9 -9
- data/docs/CarRentalExtraCharges.md +2 -2
- data/docs/Card.md +15 -0
- data/docs/CardInfo.md +13 -0
- data/docs/CardInfoLookupApi.md +68 -0
- data/docs/CardInfoLookupRequest.md +9 -0
- data/docs/CardInfoLookupResponse.md +12 -0
- data/docs/CardVerificationApi.md +68 -0
- data/docs/CardVerificationRequest.md +9 -0
- data/docs/CardVerificationsTransaction.md +2 -2
- data/docs/ChinaDomestic.md +15 -0
- data/docs/ClientLocale.md +3 -3
- data/docs/Contact.md +5 -5
- data/docs/CurrencyConversionApi.md +68 -0
- data/docs/Customer.md +19 -0
- data/docs/CustomerAddress.md +14 -0
- data/docs/CustomerAddressPhone.md +9 -0
- data/docs/Dcc.md +9 -0
- data/docs/Device.md +19 -0
- data/docs/DeviceNetworks.md +21 -0
- data/docs/Document.md +9 -0
- data/docs/Error.md +1 -1
- data/docs/ErrorDetails.md +1 -1
- data/docs/ErrorResponse.md +4 -4
- data/docs/ExchangeRateRequest.md +12 -0
- data/docs/ExchangeRateResponse.md +21 -0
- data/docs/Expiration.md +3 -3
- data/docs/FraudDetectApi.md +68 -0
- data/docs/FraudOrder.md +10 -0
- data/docs/FraudOrderItems.md +15 -0
- data/docs/FraudOrderShipToAddress.md +14 -0
- data/docs/Frequency.md +3 -3
- data/docs/IndustrySpecificExtensions.md +1 -1
- data/docs/InstallmentOptions.md +1 -1
- data/docs/Lodging.md +3 -3
- data/docs/LodgingExtraCharges.md +1 -1
- data/docs/Loyalty.md +10 -0
- data/docs/Merchant.md +11 -0
- data/docs/MerchantLocation.md +12 -0
- data/docs/MerchantLocationMerchantAddress.md +13 -0
- data/docs/Order.md +2 -2
- data/docs/OrderApi.md +107 -55
- data/docs/OrderErrorResponse.md +19 -0
- data/docs/OrderResponse.md +18 -0
- data/docs/PayPal.md +1 -1
- data/docs/Payment.md +18 -0
- data/docs/PaymentApi.md +164 -124
- data/docs/PaymentCard.md +10 -6
- data/docs/PaymentCardAuthenticationResult.md +1 -1
- data/docs/PaymentFacilitator.md +12 -0
- data/docs/PaymentIssuerResponse.md +10 -0
- data/docs/PaymentMethod.md +5 -2
- data/docs/PaymentPayMethod.md +13 -0
- data/docs/PaymentSchedulesApi.md +256 -0
- data/docs/PaymentSchedulesErrorResponse.md +14 -0
- data/docs/PaymentSchedulesRequest.md +10 -7
- data/docs/PaymentSchedulesResponse.md +7 -5
- data/docs/PaymentTokenApi.md +134 -0
- data/docs/PaymentTokenization.md +16 -0
- data/docs/PaymentTokenizationErrorResponse.md +19 -0
- data/docs/PaymentTokenizationRequest.md +11 -0
- data/docs/PaymentTokenizationResponse.md +18 -0
- data/docs/PaymentURLApi.md +68 -0
- data/docs/PaymentUrlErrorResponse.md +15 -0
- data/docs/PaymentUrlRequest.md +13 -3
- data/docs/PaymentUrlResponse.md +6 -5
- data/docs/PaymentVerification3ds.md +10 -0
- data/docs/PaymentVerificationAvs.md +10 -0
- data/docs/PaymentVerificationCvv.md +10 -0
- data/docs/PrimaryTransaction.md +7 -3
- data/docs/PrimaryTransactionAdditionalDetails.md +7 -5
- data/docs/ProcessorData.md +8 -4
- data/docs/PurchaseCards.md +9 -0
- data/docs/PurchaseCardsLevel2.md +12 -0
- data/docs/PurchaseCardsLevel3.md +8 -0
- data/docs/PurchaseCardsLevel3LineItems.md +16 -0
- data/docs/RecurringPaymentDetails.md +20 -0
- data/docs/RecurringPaymentDetailsResponse.md +19 -0
- data/docs/ReferencedOrder.md +9 -0
- data/docs/ResponseType.md +1 -1
- data/docs/ScoreOnlyRequest.md +21 -0
- data/docs/ScoreOnlyResponse.md +13 -0
- data/docs/ScoreOnlyResponseFraudScore.md +10 -0
- data/docs/ScoreOnlyResponseFraudScoreExplanations.md +10 -0
- data/docs/SecondaryTransaction.md +4 -1
- data/docs/SecondaryTransactionAdditionalDetails.md +8 -0
- data/docs/Secure3dResponse.md +8 -0
- data/docs/Sepa.md +1 -1
- data/docs/SepaMandate.md +3 -3
- data/docs/Shipping.md +1 -1
- data/docs/SoftDescriptor.md +9 -0
- data/docs/SplitShipment.md +3 -3
- data/docs/StoredCredential.md +4 -4
- data/docs/SubMerchantData.md +13 -0
- data/docs/Transaction.md +19 -0
- data/docs/TransactionErrorResponse.md +13 -11
- data/docs/TransactionOrigin.md +7 -0
- data/docs/TransactionResponse.md +13 -11
- data/docs/TransactionType.md +1 -1
- data/first_data_gateway.gemspec +9 -9
- data/git_push.sh +2 -2
- data/lib/openapi_client/.DS_Store +0 -0
- data/lib/{swagger_client → openapi_client}/api/authentication_api.rb +22 -27
- data/lib/openapi_client/api/card_info_lookup_api.rb +117 -0
- data/lib/openapi_client/api/card_verification_api.rb +117 -0
- data/lib/openapi_client/api/currency_conversion_api.rb +117 -0
- data/lib/openapi_client/api/fraud_detect_api.rb +122 -0
- data/lib/openapi_client/api/order_api.rb +327 -0
- data/lib/{swagger_client → openapi_client}/api/payment_api.rb +212 -111
- data/lib/openapi_client/api/payment_schedules_api.rb +411 -0
- data/lib/openapi_client/api/payment_token_api.rb +218 -0
- data/lib/openapi_client/api/payment_url_api.rb +117 -0
- data/lib/{swagger_client → openapi_client}/api_client.rb +50 -38
- data/lib/{swagger_client → openapi_client}/api_error.rb +6 -6
- data/lib/{swagger_client → openapi_client}/configuration.rb +49 -7
- data/lib/openapi_client/models/.DS_Store +0 -0
- data/lib/{swagger_client → openapi_client}/models/access_token_response.rb +20 -33
- data/lib/{swagger_client/models/secondary_transaction.rb → openapi_client/models/additional_amount_rate.rb} +25 -28
- data/lib/{swagger_client/models/primary_transaction_additional_details.rb → openapi_client/models/additional_transaction_details.rb} +68 -62
- data/lib/{swagger_client → openapi_client}/models/address.rb +33 -44
- data/lib/{swagger_client → openapi_client}/models/airline.rb +48 -47
- data/lib/{swagger_client → openapi_client}/models/airline_ancillary_service_category.rb +18 -21
- data/lib/{swagger_client → openapi_client}/models/airline_travel_route.rb +39 -42
- data/lib/openapi_client/models/ali_pay.rb +326 -0
- data/lib/{swagger_client → openapi_client}/models/amount.rb +18 -21
- data/lib/{swagger_client → openapi_client}/models/amount_components.rb +22 -19
- data/lib/{swagger_client/models/transaction_response_authentication_redirect.rb → openapi_client/models/authentication_request.rb} +33 -38
- data/lib/{swagger_client → openapi_client}/models/authentication_response_verification.rb +43 -30
- data/lib/{swagger_client/models/payment_url_request.rb → openapi_client/models/authentication_response_verification_request.rb} +35 -56
- data/lib/openapi_client/models/avs_response.rb +239 -0
- data/lib/openapi_client/models/basic_response.rb +209 -0
- data/lib/{swagger_client → openapi_client}/models/basket_item.rb +16 -20
- data/lib/{swagger_client → openapi_client}/models/billing.rb +65 -25
- data/lib/openapi_client/models/billing_address.rb +279 -0
- data/lib/{swagger_client/models/transaction_response_authentication_redirect_params.rb → openapi_client/models/billing_address_phone.rb} +31 -42
- data/lib/{swagger_client → openapi_client}/models/car_rental.rb +31 -31
- data/lib/{swagger_client → openapi_client}/models/car_rental_extra_charges.rb +18 -21
- data/lib/openapi_client/models/card.rb +254 -0
- data/lib/{swagger_client/models/payment_card.rb → openapi_client/models/card_info.rb} +68 -81
- data/lib/openapi_client/models/card_info_lookup_request.rb +214 -0
- data/lib/openapi_client/models/card_info_lookup_response.rb +265 -0
- data/lib/openapi_client/models/card_verification_request.rb +198 -0
- data/lib/{swagger_client → openapi_client}/models/card_verifications_transaction.rb +31 -20
- data/lib/openapi_client/models/china_domestic.rb +386 -0
- data/lib/{swagger_client → openapi_client}/models/client_locale.rb +19 -23
- data/lib/{swagger_client → openapi_client}/models/contact.rb +26 -31
- data/lib/openapi_client/models/customer.rb +333 -0
- data/lib/openapi_client/models/customer_address.rb +259 -0
- data/lib/openapi_client/models/customer_address_phone.rb +195 -0
- data/lib/openapi_client/models/dcc.rb +200 -0
- data/lib/openapi_client/models/device.rb +340 -0
- data/lib/openapi_client/models/device_networks.rb +353 -0
- data/lib/{swagger_client/models/payment_card_authentication_request.rb → openapi_client/models/document.rb} +62 -26
- data/lib/{swagger_client → openapi_client}/models/error.rb +14 -18
- data/lib/{swagger_client → openapi_client}/models/error_details.rb +14 -19
- data/lib/{swagger_client → openapi_client}/models/error_response.rb +22 -22
- data/lib/openapi_client/models/exchange_rate_request.rb +307 -0
- data/lib/openapi_client/models/exchange_rate_response.rb +319 -0
- data/lib/{swagger_client → openapi_client}/models/expiration.rb +18 -20
- data/lib/openapi_client/models/fraud_order.rb +206 -0
- data/lib/openapi_client/models/fraud_order_items.rb +253 -0
- data/lib/openapi_client/models/fraud_order_ship_to_address.rb +245 -0
- data/lib/{swagger_client → openapi_client}/models/frequency.rb +27 -30
- data/lib/{swagger_client → openapi_client}/models/industry_specific_extensions.rb +15 -19
- data/lib/{swagger_client → openapi_client}/models/installment_options.rb +22 -28
- data/lib/{swagger_client → openapi_client}/models/lodging.rb +19 -22
- data/lib/{swagger_client → openapi_client}/models/lodging_extra_charges.rb +17 -21
- data/lib/openapi_client/models/loyalty.rb +205 -0
- data/lib/openapi_client/models/merchant.rb +219 -0
- data/lib/openapi_client/models/merchant_location.rb +224 -0
- data/lib/openapi_client/models/merchant_location_merchant_address.rb +250 -0
- data/lib/{swagger_client/models/processor_data.rb → openapi_client/models/order.rb} +49 -47
- data/lib/openapi_client/models/order_error_response.rb +296 -0
- data/lib/openapi_client/models/order_response.rb +287 -0
- data/lib/{swagger_client → openapi_client}/models/pay_pal.rb +19 -23
- data/lib/openapi_client/models/payment.rb +346 -0
- data/lib/openapi_client/models/payment_card.rb +363 -0
- data/lib/{swagger_client → openapi_client}/models/payment_card_authentication_result.rb +32 -37
- data/lib/openapi_client/models/payment_facilitator.rb +292 -0
- data/lib/openapi_client/models/payment_issuer_response.rb +249 -0
- data/lib/openapi_client/models/payment_method.rb +278 -0
- data/lib/openapi_client/models/payment_pay_method.rb +278 -0
- data/lib/openapi_client/models/payment_schedules_error_response.rb +281 -0
- data/lib/{swagger_client → openapi_client}/models/payment_schedules_request.rb +83 -80
- data/lib/openapi_client/models/payment_schedules_response.rb +272 -0
- data/lib/openapi_client/models/payment_tokenization.rb +327 -0
- data/lib/openapi_client/models/payment_tokenization_error_response.rb +329 -0
- data/lib/{swagger_client/models/payment_method.rb → openapi_client/models/payment_tokenization_request.rb} +34 -37
- data/lib/openapi_client/models/payment_tokenization_response.rb +319 -0
- data/lib/openapi_client/models/payment_url_error_response.rb +292 -0
- data/lib/openapi_client/models/payment_url_request.rb +335 -0
- data/lib/{swagger_client → openapi_client}/models/payment_url_response.rb +35 -38
- data/lib/openapi_client/models/payment_verification3ds.rb +215 -0
- data/lib/openapi_client/models/payment_verification_avs.rb +215 -0
- data/lib/openapi_client/models/payment_verification_cvv.rb +215 -0
- data/lib/{swagger_client → openapi_client}/models/primary_transaction.rb +93 -31
- data/lib/openapi_client/models/primary_transaction_additional_details.rb +352 -0
- data/lib/openapi_client/models/processor_data.rb +272 -0
- data/lib/openapi_client/models/purchase_cards.rb +192 -0
- data/lib/openapi_client/models/purchase_cards_level2.rb +267 -0
- data/lib/openapi_client/models/purchase_cards_level3.rb +186 -0
- data/lib/openapi_client/models/purchase_cards_level3_line_items.rb +337 -0
- data/lib/openapi_client/models/recurring_payment_details.rb +399 -0
- data/lib/openapi_client/models/recurring_payment_details_response.rb +296 -0
- data/lib/{swagger_client/models/order.rb → openapi_client/models/referenced_order.rb} +23 -36
- data/lib/openapi_client/models/response_type.rb +37 -0
- data/lib/openapi_client/models/score_only_request.rb +389 -0
- data/lib/{swagger_client/models/payment_schedules_response.rb → openapi_client/models/score_only_response.rb} +56 -56
- data/lib/openapi_client/models/score_only_response_fraud_score.rb +208 -0
- data/lib/openapi_client/models/score_only_response_fraud_score_explanations.rb +201 -0
- data/lib/openapi_client/models/secondary_transaction.rb +220 -0
- data/lib/openapi_client/models/secondary_transaction_additional_details.rb +183 -0
- data/lib/openapi_client/models/secure3d_response.rb +184 -0
- data/lib/{swagger_client → openapi_client}/models/sepa.rb +30 -35
- data/lib/{swagger_client → openapi_client}/models/sepa_mandate.rb +32 -35
- data/lib/{swagger_client → openapi_client}/models/shipping.rb +17 -22
- data/lib/openapi_client/models/soft_descriptor.rb +215 -0
- data/lib/{swagger_client → openapi_client}/models/split_shipment.rb +17 -21
- data/lib/{swagger_client → openapi_client}/models/stored_credential.rb +28 -32
- data/lib/openapi_client/models/sub_merchant_data.rb +302 -0
- data/lib/openapi_client/models/transaction.rb +337 -0
- data/lib/{swagger_client → openapi_client}/models/transaction_error_response.rb +110 -80
- data/lib/openapi_client/models/transaction_origin.rb +32 -0
- data/lib/{swagger_client → openapi_client}/models/transaction_response.rb +112 -82
- data/lib/openapi_client/models/transaction_type.rb +36 -0
- data/lib/openapi_client/version.rb +15 -0
- data/lib/openapi_client.rb +158 -0
- data/lib/simple/client_context.rb +2 -2
- data/lib/simple/gateway.rb +274 -37
- data/spec/api/authentication_api_spec.rb +12 -12
- data/spec/api/card_info_lookup_api_spec.rb +53 -0
- data/spec/api/card_verification_api_spec.rb +53 -0
- data/spec/api/currency_conversion_api_spec.rb +53 -0
- data/spec/api/fraud_detect_api_spec.rb +53 -0
- data/spec/api/order_api_spec.rb +44 -23
- data/spec/api/payment_api_spec.rb +50 -26
- data/spec/api/payment_schedules_api_spec.rb +111 -0
- data/spec/api/payment_token_api_spec.rb +74 -0
- data/spec/api/payment_url_api_spec.rb +53 -0
- data/spec/api_client_spec.rb +66 -66
- data/spec/configuration_spec.rb +15 -15
- data/spec/models/access_token_response_spec.rb +16 -23
- data/spec/models/additional_amount_rate_spec.rb +47 -0
- data/spec/models/additional_transaction_details_spec.rb +53 -0
- data/spec/models/address_spec.rb +16 -17
- data/spec/models/airline_ancillary_service_category_spec.rb +14 -15
- data/spec/models/airline_spec.rb +27 -28
- data/spec/models/airline_travel_route_spec.rb +22 -23
- data/spec/models/ali_pay_spec.rb +63 -0
- data/spec/models/amount_components_spec.rb +16 -17
- data/spec/models/amount_spec.rb +12 -13
- data/spec/models/authentication_request_spec.rb +51 -0
- data/spec/models/authentication_response_verification_request_spec.rb +59 -0
- data/spec/models/authentication_response_verification_spec.rb +23 -18
- data/spec/models/avs_response_spec.rb +55 -0
- data/spec/models/basic_response_spec.rb +53 -0
- data/spec/models/basket_item_spec.rb +13 -14
- data/spec/models/billing_address_phone_spec.rb +47 -0
- data/spec/models/billing_address_spec.rb +95 -0
- data/spec/models/billing_spec.rb +25 -20
- data/spec/models/car_rental_extra_charges_spec.rb +14 -15
- data/spec/models/car_rental_spec.rb +17 -18
- data/spec/models/card_info_lookup_request_spec.rb +47 -0
- data/spec/models/card_info_lookup_response_spec.rb +69 -0
- data/spec/models/card_info_spec.rb +79 -0
- data/spec/models/card_spec.rb +83 -0
- data/spec/models/card_verification_request_spec.rb +47 -0
- data/spec/models/card_verifications_transaction_spec.rb +11 -12
- data/spec/models/china_domestic_spec.rb +83 -0
- data/spec/models/client_locale_spec.rb +11 -12
- data/spec/models/contact_spec.rb +13 -14
- data/spec/models/customer_address_phone_spec.rb +47 -0
- data/spec/models/customer_address_spec.rb +77 -0
- data/spec/models/customer_spec.rb +111 -0
- data/spec/models/dcc_spec.rb +47 -0
- data/spec/models/device_networks_spec.rb +123 -0
- data/spec/models/device_spec.rb +111 -0
- data/spec/models/document_spec.rb +51 -0
- data/spec/models/error_details_spec.rb +11 -12
- data/spec/models/error_response_spec.rb +13 -14
- data/spec/models/error_spec.rb +12 -13
- data/spec/models/exchange_rate_request_spec.rb +69 -0
- data/spec/models/exchange_rate_response_spec.rb +119 -0
- data/spec/models/expiration_spec.rb +11 -12
- data/spec/models/fraud_order_items_spec.rb +83 -0
- data/spec/models/fraud_order_ship_to_address_spec.rb +77 -0
- data/spec/models/fraud_order_spec.rb +53 -0
- data/spec/models/frequency_spec.rb +15 -16
- data/spec/models/industry_specific_extensions_spec.rb +12 -13
- data/spec/models/installment_options_spec.rb +12 -13
- data/spec/models/lodging_extra_charges_spec.rb +14 -15
- data/spec/models/lodging_spec.rb +14 -15
- data/spec/models/loyalty_spec.rb +53 -0
- data/spec/models/merchant_location_merchant_address_spec.rb +71 -0
- data/spec/models/merchant_location_spec.rb +65 -0
- data/spec/models/merchant_spec.rb +59 -0
- data/spec/models/order_error_response_spec.rb +107 -0
- data/spec/models/order_response_spec.rb +101 -0
- data/spec/models/order_spec.rb +12 -13
- data/spec/models/pay_pal_spec.rb +10 -11
- data/spec/models/payment_card_authentication_result_spec.rb +26 -27
- data/spec/models/payment_card_spec.rb +41 -22
- data/spec/models/payment_facilitator_spec.rb +65 -0
- data/spec/models/payment_issuer_response_spec.rb +57 -0
- data/spec/models/payment_method_spec.rb +35 -18
- data/spec/models/payment_pay_method_spec.rb +75 -0
- data/spec/models/payment_schedules_error_response_spec.rb +81 -0
- data/spec/models/payment_schedules_request_spec.rb +43 -30
- data/spec/models/payment_schedules_response_spec.rb +30 -19
- data/spec/models/payment_spec.rb +109 -0
- data/spec/models/payment_tokenization_error_response_spec.rb +111 -0
- data/spec/models/payment_tokenization_request_spec.rb +63 -0
- data/spec/models/payment_tokenization_response_spec.rb +105 -0
- data/spec/models/payment_tokenization_spec.rb +93 -0
- data/spec/models/payment_url_error_response_spec.rb +87 -0
- data/spec/models/payment_url_request_spec.rb +73 -14
- data/spec/models/payment_url_response_spec.rb +25 -20
- data/spec/models/payment_verification3ds_spec.rb +53 -0
- data/spec/models/payment_verification_avs_spec.rb +53 -0
- data/spec/models/payment_verification_cvv_spec.rb +53 -0
- data/spec/models/primary_transaction_additional_details_spec.rb +28 -17
- data/spec/models/primary_transaction_spec.rb +45 -22
- data/spec/models/processor_data_spec.rb +41 -14
- data/spec/models/purchase_cards_level2_spec.rb +65 -0
- data/spec/models/purchase_cards_level3_line_items_spec.rb +89 -0
- data/spec/models/purchase_cards_level3_spec.rb +41 -0
- data/spec/models/purchase_cards_spec.rb +47 -0
- data/spec/models/recurring_payment_details_response_spec.rb +107 -0
- data/spec/models/recurring_payment_details_spec.rb +117 -0
- data/spec/models/referenced_order_spec.rb +47 -0
- data/spec/models/response_type_spec.rb +9 -10
- data/spec/models/score_only_request_spec.rb +127 -0
- data/spec/models/score_only_response_fraud_score_explanations_spec.rb +53 -0
- data/spec/models/score_only_response_fraud_score_spec.rb +53 -0
- data/spec/models/score_only_response_spec.rb +75 -0
- data/spec/models/secondary_transaction_additional_details_spec.rb +41 -0
- data/spec/models/secondary_transaction_spec.rb +29 -12
- data/spec/models/secure3d_response_spec.rb +41 -0
- data/spec/models/sepa_mandate_spec.rb +17 -18
- data/spec/models/sepa_spec.rb +14 -15
- data/spec/models/shipping_spec.rb +12 -13
- data/spec/models/soft_descriptor_spec.rb +47 -0
- data/spec/models/split_shipment_spec.rb +11 -12
- data/spec/models/stored_credential_spec.rb +21 -22
- data/spec/models/sub_merchant_data_spec.rb +71 -0
- data/spec/models/transaction_error_response_spec.rb +62 -51
- data/spec/models/transaction_origin_spec.rb +35 -0
- data/spec/models/transaction_response_spec.rb +61 -50
- data/spec/models/transaction_spec.rb +115 -0
- data/spec/models/transaction_type_spec.rb +9 -10
- data/spec/spec_helper.rb +6 -6
- metadata +339 -69
- data/docs/PaymentCardAuthenticationRequest.md +0 -8
- data/docs/TransactionResponseAuthenticationRedirect.md +0 -10
- data/docs/TransactionResponseAuthenticationRedirectParams.md +0 -10
- data/lib/swagger_client/api/order_api.rb +0 -229
- data/lib/swagger_client/models/response_type.rb +0 -37
- data/lib/swagger_client/models/transaction_type.rb +0 -36
- data/lib/swagger_client/version.rb +0 -15
- data/lib/swagger_client.rb +0 -91
- data/spec/models/payment_card_authentication_request_spec.rb +0 -46
- data/spec/models/transaction_response_authentication_redirect_params_spec.rb +0 -54
- data/spec/models/transaction_response_authentication_redirect_spec.rb +0 -58
@@ -0,0 +1,68 @@
|
|
1
|
+
# OpenapiClient::FraudDetectApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://cert.api.firstdata.com/gateway*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**score_only**](FraudDetectApi.md#score_only) | **POST** /v1/fraud/score-only | Score a transaction for fraud.
|
8
|
+
|
9
|
+
|
10
|
+
# **score_only**
|
11
|
+
> ScoreOnlyResponse score_only(content_type, client_request_id, api_key, timestamp, score_only_request, opts)
|
12
|
+
|
13
|
+
Score a transaction for fraud.
|
14
|
+
|
15
|
+
Use this to obtain a fraud score for a transaction.
|
16
|
+
|
17
|
+
### Example
|
18
|
+
```ruby
|
19
|
+
# load the gem
|
20
|
+
require 'openapi_client'
|
21
|
+
|
22
|
+
api_instance = OpenapiClient::FraudDetectApi.new
|
23
|
+
content_type = 'application/json' # String | content type
|
24
|
+
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.
|
25
|
+
api_key = 'api_key_example' # String |
|
26
|
+
timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
27
|
+
score_only_request = OpenapiClient::ScoreOnlyRequest.new # ScoreOnlyRequest |
|
28
|
+
opts = {
|
29
|
+
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.
|
30
|
+
region: 'region_example' # String | The region where client wants to process the transaction
|
31
|
+
}
|
32
|
+
|
33
|
+
begin
|
34
|
+
#Score a transaction for fraud.
|
35
|
+
result = api_instance.score_only(content_type, client_request_id, api_key, timestamp, score_only_request, opts)
|
36
|
+
p result
|
37
|
+
rescue OpenapiClient::ApiError => e
|
38
|
+
puts "Exception when calling FraudDetectApi->score_only: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
### Parameters
|
43
|
+
|
44
|
+
Name | Type | Description | Notes
|
45
|
+
------------- | ------------- | ------------- | -------------
|
46
|
+
**content_type** | **String**| content type | [default to 'application/json']
|
47
|
+
**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. |
|
48
|
+
**api_key** | **String**| |
|
49
|
+
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
50
|
+
**score_only_request** | [**ScoreOnlyRequest**](ScoreOnlyRequest.md)| |
|
51
|
+
**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. | [optional]
|
52
|
+
**region** | **String**| The region where client wants to process the transaction | [optional]
|
53
|
+
|
54
|
+
### Return type
|
55
|
+
|
56
|
+
[**ScoreOnlyResponse**](ScoreOnlyResponse.md)
|
57
|
+
|
58
|
+
### Authorization
|
59
|
+
|
60
|
+
No authorization required
|
61
|
+
|
62
|
+
### HTTP request headers
|
63
|
+
|
64
|
+
- **Content-Type**: application/json
|
65
|
+
- **Accept**: application/json
|
66
|
+
|
67
|
+
|
68
|
+
|
data/docs/FraudOrder.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# OpenapiClient::FraudOrder
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**ship_to_address** | [**FraudOrderShipToAddress**](FraudOrderShipToAddress.md) | | [optional]
|
7
|
+
**items** | [**Array<FraudOrderItems>**](FraudOrderItems.md) | The list of items included in the order. | [optional]
|
8
|
+
**user_defined** | [**Object**](.md) | A JSON object that can carry any additional information about the order that might be helpful for fraud detection. | [optional]
|
9
|
+
|
10
|
+
|
@@ -0,0 +1,15 @@
|
|
1
|
+
# OpenapiClient::FraudOrderItems
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | A unique ID associated with the product. Must be unique within the merchant's system. | [optional]
|
7
|
+
**name** | **String** | A name or short description of the product. | [optional]
|
8
|
+
**quantity** | **String** | The unit in which the product is sold (e.g. litre, kilogram, etc). Leave empty if the product is sold as a complete unit. | [optional]
|
9
|
+
**unit** | **Float** | The number of units sold. Set to 1 if there is only one unit of the item. Leave empty if the quantity is unknown at the time of the request. | [optional]
|
10
|
+
**unit_price** | **String** | The price per unit. | [optional]
|
11
|
+
**categories** | **String** | The categories that this product belongs to. | [optional]
|
12
|
+
**details_url** | **String** | The URL to the merchant's management system, for reporting and analysis. | [optional]
|
13
|
+
**user_defined** | [**Object**](.md) | | [optional]
|
14
|
+
|
15
|
+
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# OpenapiClient::FraudOrderShipToAddress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**phone** | **String** | Free-form phone number associated with the ship-to address. | [optional]
|
7
|
+
**address1** | **String** | Street Address 1. This field is required if the parent object is present. | [optional]
|
8
|
+
**address2** | **String** | Street Address 2. | [optional]
|
9
|
+
**city** | **String** | City | [optional]
|
10
|
+
**state** | **String** | State or Province | [optional]
|
11
|
+
**zip** | **String** | Postal Code, free form. This field is required if the parent object is present. | [optional]
|
12
|
+
**country** | **String** | Country. This field is required if the parent object is present. | [optional]
|
13
|
+
|
14
|
+
|
data/docs/Frequency.md
CHANGED
@@ -1,9 +1,9 @@
|
|
1
|
-
#
|
1
|
+
# OpenapiClient::Frequency
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**every** | **Integer** | Rate of frequency
|
7
|
-
**unit** | **String** | Unit which defines the frequency
|
6
|
+
**every** | **Integer** | Rate of frequency |
|
7
|
+
**unit** | **String** | Unit which defines the frequency |
|
8
8
|
|
9
9
|
|
data/docs/InstallmentOptions.md
CHANGED
data/docs/Lodging.md
CHANGED
@@ -1,4 +1,4 @@
|
|
1
|
-
#
|
1
|
+
# OpenapiClient::Lodging
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
@@ -6,7 +6,7 @@ Name | Type | Description | Notes
|
|
6
6
|
**arrival_date** | **Date** | Date of arrival | [optional]
|
7
7
|
**departure_date** | **Date** | Date of departure | [optional]
|
8
8
|
**folio_number** | **String** | Portfolio number | [optional]
|
9
|
-
**extra_charges** | [**Array<LodgingExtraCharges>**](LodgingExtraCharges.md) |
|
10
|
-
**no_show_indicator** | **BOOLEAN** |
|
9
|
+
**extra_charges** | [**Array<LodgingExtraCharges>**](LodgingExtraCharges.md) | Information about charges other than base lodging | [optional]
|
10
|
+
**no_show_indicator** | **BOOLEAN** | Indicates if the transaction is associated with a delayed or no-show penalty | [optional]
|
11
11
|
|
12
12
|
|
data/docs/LodgingExtraCharges.md
CHANGED
data/docs/Loyalty.md
ADDED
@@ -0,0 +1,10 @@
|
|
1
|
+
# OpenapiClient::Loyalty
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**id** | **String** | A unique ID associated with the loyalty program account. Must be unique within the merchants system. Depending on loyalty programs the account might also serve as a credit/bank account. If this is the case the ID must be not be the PAN. | [optional]
|
7
|
+
**program** | **String** | A string that identifies the program in which the customer is enrolled if the merchant supports several programs or levels. | [optional]
|
8
|
+
**balance** | **Float** | The balance of the loyalty program account in a program specific currency (e.g. points). | [optional]
|
9
|
+
|
10
|
+
|
data/docs/Merchant.md
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
# OpenapiClient::Merchant
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**mcc** | **String** | The 4-digit Merchant Category Code. The merchant might be associated with multiple MCCs. In that case the MCC provided here will be the one that better describes the current transaction. | [optional]
|
7
|
+
**merchant_unique_id** | **String** | The unique ID of this merchant. Must be unique for the entire system (not just within a specific industry). |
|
8
|
+
**location** | [**MerchantLocation**](MerchantLocation.md) | | [optional]
|
9
|
+
**user_defined** | [**Object**](.md) | A JSON object that can carry any additional information about the merchant that might be helpful for fraud detection. | [optional]
|
10
|
+
|
11
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# OpenapiClient::MerchantLocation
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**location_id** | **String** | The unique ID of this location. | [optional]
|
7
|
+
**merchant_address** | [**MerchantLocationMerchantAddress**](MerchantLocationMerchantAddress.md) | | [optional]
|
8
|
+
**hierarchy** | **String** | Free-text field to describe a hierarchy the merchant would like to provide. | [optional]
|
9
|
+
**timezone_offset** | **String** | The timezone offset from UTC to the merchants timezone configuration, specified in the format +hh:mm. | [optional]
|
10
|
+
**user_defined** | [**Object**](.md) | A JSON object that can carry any additional information about the location that might be helpful for fraud detection. | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,13 @@
|
|
1
|
+
# OpenapiClient::MerchantLocationMerchantAddress
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**street** | **String** | Merchant Street Address 1. This field is required if the parent object is present. |
|
7
|
+
**street2** | **String** | Merchant Street Address 2 | [optional]
|
8
|
+
**state_province** | **String** | Merchant State | [optional]
|
9
|
+
**city** | **String** | Merchant City | [optional]
|
10
|
+
**country** | **String** | Merchant Country. |
|
11
|
+
**zip_postal_code** | **String** | Merchant Zip Code. |
|
12
|
+
|
13
|
+
|
data/docs/Order.md
CHANGED
@@ -1,9 +1,9 @@
|
|
1
|
-
#
|
1
|
+
# OpenapiClient::Order
|
2
2
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
-
**order_id** | **String** |
|
6
|
+
**order_id** | **String** | Client Order ID if supplied by client. | [optional]
|
7
7
|
**billing** | [**Billing**](Billing.md) | | [optional]
|
8
8
|
**shipping** | [**Shipping**](Shipping.md) | | [optional]
|
9
9
|
|
data/docs/OrderApi.md
CHANGED
@@ -1,50 +1,106 @@
|
|
1
|
-
#
|
1
|
+
# OpenapiClient::OrderApi
|
2
2
|
|
3
3
|
All URIs are relative to *https://cert.api.firstdata.com/gateway*
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**
|
8
|
-
[**
|
7
|
+
[**order_inquiry**](OrderApi.md#order_inquiry) | **GET** /v1/orders/{order-id} | Retrieve the state of an order
|
8
|
+
[**order_post_auth**](OrderApi.md#order_post_auth) | **POST** /v1/orders/{order-id}/postauth | Capture/complete an already existing order.
|
9
|
+
[**order_return_transaction**](OrderApi.md#order_return_transaction) | **POST** /v1/orders/{order-id}/return | Return/refund an order.
|
9
10
|
|
10
11
|
|
11
|
-
# **
|
12
|
-
>
|
12
|
+
# **order_inquiry**
|
13
|
+
> OrderResponse order_inquiry(content_type, client_request_id, api_key, timestamp, order_id, opts)
|
13
14
|
|
14
|
-
|
15
|
+
Retrieve the state of an order
|
15
16
|
|
16
|
-
|
17
|
+
Use this query to get the current state of an existing order.
|
17
18
|
|
18
19
|
### Example
|
19
20
|
```ruby
|
20
21
|
# load the gem
|
21
|
-
require '
|
22
|
+
require 'openapi_client'
|
23
|
+
|
24
|
+
api_instance = OpenapiClient::OrderApi.new
|
25
|
+
content_type = 'application/json' # String | content type
|
26
|
+
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.
|
27
|
+
api_key = 'api_key_example' # String |
|
28
|
+
timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
29
|
+
order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId
|
30
|
+
opts = {
|
31
|
+
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.
|
32
|
+
region: 'region_example', # String | The region where client wants to process the transaction
|
33
|
+
store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app
|
34
|
+
}
|
35
|
+
|
36
|
+
begin
|
37
|
+
#Retrieve the state of an order
|
38
|
+
result = api_instance.order_inquiry(content_type, client_request_id, api_key, timestamp, order_id, opts)
|
39
|
+
p result
|
40
|
+
rescue OpenapiClient::ApiError => e
|
41
|
+
puts "Exception when calling OrderApi->order_inquiry: #{e}"
|
42
|
+
end
|
43
|
+
```
|
44
|
+
|
45
|
+
### Parameters
|
46
|
+
|
47
|
+
Name | Type | Description | Notes
|
48
|
+
------------- | ------------- | ------------- | -------------
|
49
|
+
**content_type** | **String**| content type | [default to 'application/json']
|
50
|
+
**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. |
|
51
|
+
**api_key** | **String**| |
|
52
|
+
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
53
|
+
**order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
|
54
|
+
**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. | [optional]
|
55
|
+
**region** | **String**| The region where client wants to process the transaction | [optional]
|
56
|
+
**store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app | [optional]
|
57
|
+
|
58
|
+
### Return type
|
22
59
|
|
23
|
-
|
60
|
+
[**OrderResponse**](OrderResponse.md)
|
24
61
|
|
25
|
-
|
62
|
+
### Authorization
|
26
63
|
|
27
|
-
|
64
|
+
No authorization required
|
28
65
|
|
29
|
-
|
66
|
+
### HTTP request headers
|
67
|
+
|
68
|
+
- **Content-Type**: Not defined
|
69
|
+
- **Accept**: application/json
|
30
70
|
|
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
71
|
|
33
|
-
order_id = "order_id_example" # String | Gateway order identifier as returned in the parameter orderId
|
34
72
|
|
35
|
-
|
73
|
+
# **order_post_auth**
|
74
|
+
> TransactionResponse order_post_auth(content_type, client_request_id, api_key, timestamp, order_id, secondary_transaction, opts)
|
36
75
|
|
37
|
-
|
38
|
-
|
39
|
-
|
76
|
+
Capture/complete an already existing order.
|
77
|
+
|
78
|
+
Use this to capture/complete an order. Postauths and partial postauths are allowed.
|
79
|
+
|
80
|
+
### Example
|
81
|
+
```ruby
|
82
|
+
# load the gem
|
83
|
+
require 'openapi_client'
|
84
|
+
|
85
|
+
api_instance = OpenapiClient::OrderApi.new
|
86
|
+
content_type = 'application/json' # String | content type
|
87
|
+
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.
|
88
|
+
api_key = 'api_key_example' # String |
|
89
|
+
timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
90
|
+
order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId
|
91
|
+
secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction |
|
92
|
+
opts = {
|
93
|
+
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.
|
94
|
+
region: 'region_example', # String | The region where client wants to process the transaction
|
95
|
+
store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app
|
40
96
|
}
|
41
97
|
|
42
98
|
begin
|
43
|
-
#
|
44
|
-
result = api_instance.
|
99
|
+
#Capture/complete an already existing order.
|
100
|
+
result = api_instance.order_post_auth(content_type, client_request_id, api_key, timestamp, order_id, secondary_transaction, opts)
|
45
101
|
p result
|
46
|
-
rescue
|
47
|
-
puts "Exception when calling OrderApi->
|
102
|
+
rescue OpenapiClient::ApiError => e
|
103
|
+
puts "Exception when calling OrderApi->order_post_auth: #{e}"
|
48
104
|
end
|
49
105
|
```
|
50
106
|
|
@@ -52,14 +108,15 @@ end
|
|
52
108
|
|
53
109
|
Name | Type | Description | Notes
|
54
110
|
------------- | ------------- | ------------- | -------------
|
55
|
-
**content_type** | **String**| content type | [default to application/json]
|
111
|
+
**content_type** | **String**| content type | [default to 'application/json']
|
56
112
|
**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. |
|
57
113
|
**api_key** | **String**| |
|
58
114
|
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
59
115
|
**order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
|
60
|
-
**
|
116
|
+
**secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
|
61
117
|
**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. | [optional]
|
62
|
-
**
|
118
|
+
**region** | **String**| The region where client wants to process the transaction | [optional]
|
119
|
+
**store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app | [optional]
|
63
120
|
|
64
121
|
### Return type
|
65
122
|
|
@@ -76,43 +133,37 @@ No authorization required
|
|
76
133
|
|
77
134
|
|
78
135
|
|
79
|
-
# **
|
80
|
-
> TransactionResponse
|
136
|
+
# **order_return_transaction**
|
137
|
+
> TransactionResponse order_return_transaction(content_type, client_request_id, api_key, timestamp, order_id, secondary_transaction, opts)
|
81
138
|
|
82
|
-
|
139
|
+
Return/refund an order.
|
83
140
|
|
84
|
-
|
141
|
+
Use this for Returns of an existing order. Partial Returns are allowed.
|
85
142
|
|
86
143
|
### Example
|
87
144
|
```ruby
|
88
145
|
# load the gem
|
89
|
-
require '
|
90
|
-
|
91
|
-
api_instance =
|
92
|
-
|
93
|
-
|
94
|
-
|
95
|
-
|
96
|
-
|
97
|
-
|
98
|
-
|
99
|
-
|
100
|
-
|
101
|
-
|
102
|
-
|
103
|
-
payload = SwaggerClient::SecondaryTransaction.new # SecondaryTransaction |
|
104
|
-
|
105
|
-
opts = {
|
106
|
-
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.
|
107
|
-
store_id: "store_id_example" # String | an optional outlet id for clients that support multiple store in the same developer app
|
146
|
+
require 'openapi_client'
|
147
|
+
|
148
|
+
api_instance = OpenapiClient::OrderApi.new
|
149
|
+
content_type = 'application/json' # String | content type
|
150
|
+
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.
|
151
|
+
api_key = 'api_key_example' # String |
|
152
|
+
timestamp = 56 # Integer | Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins).
|
153
|
+
order_id = 'order_id_example' # String | Gateway order identifier as returned in the parameter orderId
|
154
|
+
secondary_transaction = OpenapiClient::SecondaryTransaction.new # SecondaryTransaction |
|
155
|
+
opts = {
|
156
|
+
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.
|
157
|
+
region: 'region_example', # String | The region where client wants to process the transaction
|
158
|
+
store_id: 'store_id_example' # String | An optional outlet ID for clients that support multiple stores in the same developer app
|
108
159
|
}
|
109
160
|
|
110
161
|
begin
|
111
|
-
#
|
112
|
-
result = api_instance.
|
162
|
+
#Return/refund an order.
|
163
|
+
result = api_instance.order_return_transaction(content_type, client_request_id, api_key, timestamp, order_id, secondary_transaction, opts)
|
113
164
|
p result
|
114
|
-
rescue
|
115
|
-
puts "Exception when calling OrderApi->
|
165
|
+
rescue OpenapiClient::ApiError => e
|
166
|
+
puts "Exception when calling OrderApi->order_return_transaction: #{e}"
|
116
167
|
end
|
117
168
|
```
|
118
169
|
|
@@ -120,14 +171,15 @@ end
|
|
120
171
|
|
121
172
|
Name | Type | Description | Notes
|
122
173
|
------------- | ------------- | ------------- | -------------
|
123
|
-
**content_type** | **String**| content type | [default to application/json]
|
174
|
+
**content_type** | **String**| content type | [default to 'application/json']
|
124
175
|
**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
176
|
**api_key** | **String**| |
|
126
177
|
**timestamp** | **Integer**| Epoch timestamp in milliseconds in the request from a client system. Used for Message Signature generation and time limit (5 mins). |
|
127
178
|
**order_id** | **String**| Gateway order identifier as returned in the parameter orderId |
|
128
|
-
**
|
179
|
+
**secondary_transaction** | [**SecondaryTransaction**](SecondaryTransaction.md)| |
|
129
180
|
**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. | [optional]
|
130
|
-
**
|
181
|
+
**region** | **String**| The region where client wants to process the transaction | [optional]
|
182
|
+
**store_id** | **String**| An optional outlet ID for clients that support multiple stores in the same developer app | [optional]
|
131
183
|
|
132
184
|
### Return type
|
133
185
|
|
@@ -0,0 +1,19 @@
|
|
1
|
+
# OpenapiClient::OrderErrorResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional]
|
7
|
+
**api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional]
|
8
|
+
**response_type** | [**ResponseType**](ResponseType.md) | |
|
9
|
+
**ipg_transaction_id** | **String** | The response transaction ID | [optional]
|
10
|
+
**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID | [optional]
|
11
|
+
**transaction_time** | **Integer** | The transaction time in seconds since Epoch | [optional]
|
12
|
+
**billing** | [**Billing**](Billing.md) | | [optional]
|
13
|
+
**shipping** | [**Shipping**](Shipping.md) | | [optional]
|
14
|
+
**mandate** | [**SepaMandate**](SepaMandate.md) | | [optional]
|
15
|
+
**transactions** | [**Array<Transaction>**](Transaction.md) | Required for some payment methods (for example, Klarna) | [optional]
|
16
|
+
**processor** | [**ProcessorData**](ProcessorData.md) | | [optional]
|
17
|
+
**error** | [**Error**](Error.md) | | [optional]
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# OpenapiClient::OrderResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**client_request_id** | **String** | Echoes back the value in the request header for tracking. | [optional]
|
7
|
+
**api_trace_id** | **String** | Request identifier in API, can be used to request logs from the support team. | [optional]
|
8
|
+
**response_type** | [**ResponseType**](ResponseType.md) | |
|
9
|
+
**ipg_transaction_id** | **String** | The response transaction ID | [optional]
|
10
|
+
**order_id** | **String** | Client order ID if supplied by client, otherwise the order ID | [optional]
|
11
|
+
**transaction_time** | **Integer** | The transaction time in seconds since Epoch | [optional]
|
12
|
+
**billing** | [**Billing**](Billing.md) | | [optional]
|
13
|
+
**shipping** | [**Shipping**](Shipping.md) | | [optional]
|
14
|
+
**mandate** | [**SepaMandate**](SepaMandate.md) | | [optional]
|
15
|
+
**transactions** | [**Array<Transaction>**](Transaction.md) | Required for some payment methods (for example, Klarna) | [optional]
|
16
|
+
**processor** | [**ProcessorData**](ProcessorData.md) | | [optional]
|
17
|
+
|
18
|
+
|
data/docs/PayPal.md
CHANGED
data/docs/Payment.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# OpenapiClient::Payment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**payment_type** | **String** | Defines the type of the payment. |
|
7
|
+
**pay_method** | [**PaymentPayMethod**](PaymentPayMethod.md) | |
|
8
|
+
**pin_present** | **BOOLEAN** | Indicates if the cards Personal Identification Number was supplied. |
|
9
|
+
**entry_method** | **String** | The method in which the card information entered the system. |
|
10
|
+
**issuer_response** | [**PaymentIssuerResponse**](PaymentIssuerResponse.md) | | [optional]
|
11
|
+
**issuer_approved_amount** | **String** | The actual approved amount. This field should be filled in when the message has already passed through the issuer (e.g. post-authorization). For transaction/authorization this amount refers to the amount that was locked on the card-holders account. | [optional]
|
12
|
+
**issuer_card_balance** | **String** | The payment methods account balance if available. This field should be filled in when the message has already passed through the issuer (e.g. post-authorization). | [optional]
|
13
|
+
**verification_avs** | [**PaymentVerificationAvs**](PaymentVerificationAvs.md) | | [optional]
|
14
|
+
**verification3ds** | [**PaymentVerification3ds**](PaymentVerification3ds.md) | | [optional]
|
15
|
+
**verification_cvv** | [**PaymentVerificationCvv**](PaymentVerificationCvv.md) | | [optional]
|
16
|
+
**user_defined** | [**Object**](.md) | A JSON object that carries any additional information that might be helpful for fraud detection. | [optional]
|
17
|
+
|
18
|
+
|