yapstone-payments 1.0.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +79 -0
- data/README.md +203 -0
- data/Rakefile +10 -0
- data/docs/APM.md +29 -0
- data/docs/APMSpecInParameters.md +19 -0
- data/docs/Action.md +16 -0
- data/docs/Address.md +29 -0
- data/docs/Amount.md +21 -0
- data/docs/AuthResponse.md +19 -0
- data/docs/AuthTokenRequest.md +19 -0
- data/docs/AuthTokenResponse.md +17 -0
- data/docs/AuthenticationApi.md +58 -0
- data/docs/BankAccount.md +37 -0
- data/docs/BillingAddress.md +29 -0
- data/docs/BookingInfo.md +31 -0
- data/docs/CapturePaymentRequest.md +21 -0
- data/docs/Card.md +27 -0
- data/docs/CardResponse.md +21 -0
- data/docs/Consent.md +21 -0
- data/docs/CreditCardAuthResponse.md +25 -0
- data/docs/Customer.md +29 -0
- data/docs/CustomerData.md +19 -0
- data/docs/CustomerDetails.md +23 -0
- data/docs/Deposit.md +23 -0
- data/docs/DepositDetails.md +17 -0
- data/docs/DisburseLineItemsReq.md +19 -0
- data/docs/DisburseTransaction.md +19 -0
- data/docs/DisburseTransactionReq.md +17 -0
- data/docs/Disbursement.md +17 -0
- data/docs/DisbursementAllOf.md +17 -0
- data/docs/DisbursementDetails.md +17 -0
- data/docs/DisbursementRequest.md +16 -0
- data/docs/DisbursementRequests.md +17 -0
- data/docs/DisbursementResponse.md +17 -0
- data/docs/DisbursementsApi.md +138 -0
- data/docs/Error.md +25 -0
- data/docs/ErrorResponse.md +19 -0
- data/docs/Fields.md +17 -0
- data/docs/GovIdentification.md +29 -0
- data/docs/Guest.md +29 -0
- data/docs/GuestInfoResponse.md +19 -0
- data/docs/Href.md +17 -0
- data/docs/InlineResponse200.md +25 -0
- data/docs/InstallmentPlan.md +19 -0
- data/docs/Instrument.md +21 -0
- data/docs/InstrumentVerificationResponse.md +31 -0
- data/docs/KYC.md +21 -0
- data/docs/LeaseInfo.md +21 -0
- data/docs/LineItemDetails.md +25 -0
- data/docs/MarketplaceData.md +23 -0
- data/docs/Merketplace.md +17 -0
- data/docs/Money.md +19 -0
- data/docs/Name.md +27 -0
- data/docs/OfferingDetails.md +21 -0
- data/docs/OrderTransactions.md +25 -0
- data/docs/Payment.md +21 -0
- data/docs/PaymentCancelResponse.md +23 -0
- data/docs/PaymentCancelTransactionResponse.md +21 -0
- data/docs/PaymentDetails.md +29 -0
- data/docs/PaymentInstrument.md +27 -0
- data/docs/PaymentInstrumentCard.md +19 -0
- data/docs/PaymentInstrumentResponse.md +19 -0
- data/docs/PaymentPayment.md +27 -0
- data/docs/PaymentPaymentAllOf.md +27 -0
- data/docs/PaymentResponse.md +33 -0
- data/docs/PaymentsApi.md +447 -0
- data/docs/Phone.md +21 -0
- data/docs/ProcessPayment.md +29 -0
- data/docs/PropertyInfo.md +21 -0
- data/docs/PropertyInfoResponse.md +19 -0
- data/docs/RefundAction.md +16 -0
- data/docs/RefundCancelResponse.md +21 -0
- data/docs/RefundCancelTransactionResponse.md +19 -0
- data/docs/RefundRequest.md +25 -0
- data/docs/RefundResponse.md +29 -0
- data/docs/RefundStatus.md +16 -0
- data/docs/RefundTransactions.md +27 -0
- data/docs/RefundsApi.md +378 -0
- data/docs/RentalInfo.md +21 -0
- data/docs/Renter.md +29 -0
- data/docs/Resolution.md +17 -0
- data/docs/Result.md +21 -0
- data/docs/RiskStatus.md +17 -0
- data/docs/SanctionedEntities.md +19 -0
- data/docs/SearchApi.md +132 -0
- data/docs/SearchPaymentResponse.md +17 -0
- data/docs/StackTraceElement.md +25 -0
- data/docs/Status.md +16 -0
- data/docs/Throwable.md +21 -0
- data/docs/ToEntityRef.md +19 -0
- data/docs/Token.md +19 -0
- data/docs/TokenApi.md +134 -0
- data/docs/TokenReq.md +19 -0
- data/docs/TokenRequest.md +17 -0
- data/docs/TokenResponse.md +17 -0
- data/docs/Transaction.md +21 -0
- data/docs/TransactionResponse.md +27 -0
- data/docs/Triggers.md +21 -0
- data/docs/VacationRentalInfo.md +19 -0
- data/docs/VacationRentalInfoRequest.md +21 -0
- data/docs/VerifyInstrumentRequest.md +21 -0
- data/git_push.sh +55 -0
- data/lib/yapstone-payments.rb +137 -0
- data/lib/yapstone-payments/api/authentication_api.rb +92 -0
- data/lib/yapstone-payments/api/disbursements_api.rb +202 -0
- data/lib/yapstone-payments/api/payments_api.rb +598 -0
- data/lib/yapstone-payments/api/refunds_api.rb +507 -0
- data/lib/yapstone-payments/api/search_api.rb +187 -0
- data/lib/yapstone-payments/api/token_api.rb +182 -0
- data/lib/yapstone-payments/api_client.rb +386 -0
- data/lib/yapstone-payments/api_error.rb +57 -0
- data/lib/yapstone-payments/configuration.rb +249 -0
- data/lib/yapstone-payments/models/action.rb +39 -0
- data/lib/yapstone-payments/models/address.rb +258 -0
- data/lib/yapstone-payments/models/amount.rb +218 -0
- data/lib/yapstone-payments/models/apm.rb +292 -0
- data/lib/yapstone-payments/models/apm_spec_in_parameters.rb +208 -0
- data/lib/yapstone-payments/models/auth_response.rb +217 -0
- data/lib/yapstone-payments/models/auth_token_request.rb +205 -0
- data/lib/yapstone-payments/models/auth_token_response.rb +196 -0
- data/lib/yapstone-payments/models/bank_account.rb +347 -0
- data/lib/yapstone-payments/models/billing_address.rb +258 -0
- data/lib/yapstone-payments/models/booking_info.rb +266 -0
- data/lib/yapstone-payments/models/capture_payment_request.rb +252 -0
- data/lib/yapstone-payments/models/card.rb +247 -0
- data/lib/yapstone-payments/models/card_response.rb +217 -0
- data/lib/yapstone-payments/models/consent.rb +248 -0
- data/lib/yapstone-payments/models/credit_card_auth_response.rb +267 -0
- data/lib/yapstone-payments/models/customer.rb +256 -0
- data/lib/yapstone-payments/models/customer_data.rb +208 -0
- data/lib/yapstone-payments/models/customer_details.rb +226 -0
- data/lib/yapstone-payments/models/deposit.rb +228 -0
- data/lib/yapstone-payments/models/deposit_details.rb +199 -0
- data/lib/yapstone-payments/models/disburse_line_items_req.rb +208 -0
- data/lib/yapstone-payments/models/disburse_transaction.rb +208 -0
- data/lib/yapstone-payments/models/disburse_transaction_req.rb +199 -0
- data/lib/yapstone-payments/models/disbursement.rb +203 -0
- data/lib/yapstone-payments/models/disbursement_all_of.rb +197 -0
- data/lib/yapstone-payments/models/disbursement_details.rb +200 -0
- data/lib/yapstone-payments/models/disbursement_request.rb +187 -0
- data/lib/yapstone-payments/models/disbursement_requests.rb +198 -0
- data/lib/yapstone-payments/models/disbursement_response.rb +198 -0
- data/lib/yapstone-payments/models/error.rb +241 -0
- data/lib/yapstone-payments/models/error_response.rb +218 -0
- data/lib/yapstone-payments/models/fields.rb +196 -0
- data/lib/yapstone-payments/models/gov_identification.rb +292 -0
- data/lib/yapstone-payments/models/guest.rb +257 -0
- data/lib/yapstone-payments/models/guest_info_response.rb +208 -0
- data/lib/yapstone-payments/models/href.rb +196 -0
- data/lib/yapstone-payments/models/inline_response200.rb +232 -0
- data/lib/yapstone-payments/models/installment_plan.rb +208 -0
- data/lib/yapstone-payments/models/instrument.rb +250 -0
- data/lib/yapstone-payments/models/instrument_verification_response.rb +260 -0
- data/lib/yapstone-payments/models/kyc.rb +215 -0
- data/lib/yapstone-payments/models/lease_info.rb +218 -0
- data/lib/yapstone-payments/models/line_item_details.rb +236 -0
- data/lib/yapstone-payments/models/marketplace_data.rb +260 -0
- data/lib/yapstone-payments/models/merketplace.rb +197 -0
- data/lib/yapstone-payments/models/money.rb +207 -0
- data/lib/yapstone-payments/models/name.rb +248 -0
- data/lib/yapstone-payments/models/offering_details.rb +216 -0
- data/lib/yapstone-payments/models/order_transactions.rb +235 -0
- data/lib/yapstone-payments/models/payment.rb +216 -0
- data/lib/yapstone-payments/models/payment_cancel_response.rb +227 -0
- data/lib/yapstone-payments/models/payment_cancel_transaction_response.rb +218 -0
- data/lib/yapstone-payments/models/payment_details.rb +319 -0
- data/lib/yapstone-payments/models/payment_instrument.rb +277 -0
- data/lib/yapstone-payments/models/payment_instrument_card.rb +241 -0
- data/lib/yapstone-payments/models/payment_instrument_response.rb +205 -0
- data/lib/yapstone-payments/models/payment_payment.rb +257 -0
- data/lib/yapstone-payments/models/payment_payment_all_of.rb +250 -0
- data/lib/yapstone-payments/models/payment_response.rb +275 -0
- data/lib/yapstone-payments/models/phone.rb +218 -0
- data/lib/yapstone-payments/models/process_payment.rb +304 -0
- data/lib/yapstone-payments/models/property_info.rb +216 -0
- data/lib/yapstone-payments/models/property_info_response.rb +207 -0
- data/lib/yapstone-payments/models/refund_action.rb +35 -0
- data/lib/yapstone-payments/models/refund_cancel_response.rb +217 -0
- data/lib/yapstone-payments/models/refund_cancel_transaction_response.rb +207 -0
- data/lib/yapstone-payments/models/refund_request.rb +285 -0
- data/lib/yapstone-payments/models/refund_response.rb +253 -0
- data/lib/yapstone-payments/models/refund_status.rb +90 -0
- data/lib/yapstone-payments/models/refund_transactions.rb +245 -0
- data/lib/yapstone-payments/models/rental_info.rb +215 -0
- data/lib/yapstone-payments/models/renter.rb +254 -0
- data/lib/yapstone-payments/models/resolution.rb +196 -0
- data/lib/yapstone-payments/models/result.rb +218 -0
- data/lib/yapstone-payments/models/risk_status.rb +196 -0
- data/lib/yapstone-payments/models/sanctioned_entities.rb +207 -0
- data/lib/yapstone-payments/models/search_payment_response.rb +196 -0
- data/lib/yapstone-payments/models/stack_trace_element.rb +238 -0
- data/lib/yapstone-payments/models/status.rb +91 -0
- data/lib/yapstone-payments/models/throwable.rb +220 -0
- data/lib/yapstone-payments/models/to_entity_ref.rb +207 -0
- data/lib/yapstone-payments/models/token.rb +207 -0
- data/lib/yapstone-payments/models/token_req.rb +206 -0
- data/lib/yapstone-payments/models/token_request.rb +196 -0
- data/lib/yapstone-payments/models/token_response.rb +196 -0
- data/lib/yapstone-payments/models/transaction.rb +218 -0
- data/lib/yapstone-payments/models/transaction_response.rb +248 -0
- data/lib/yapstone-payments/models/triggers.rb +216 -0
- data/lib/yapstone-payments/models/vacation_rental_info.rb +205 -0
- data/lib/yapstone-payments/models/vacation_rental_info_request.rb +215 -0
- data/lib/yapstone-payments/models/verify_instrument_request.rb +215 -0
- data/lib/yapstone-payments/version.rb +15 -0
- data/spec/api/authentication_api_spec.rb +48 -0
- data/spec/api/disbursements_api_spec.rb +69 -0
- data/spec/api/payments_api_spec.rb +146 -0
- data/spec/api/refunds_api_spec.rb +127 -0
- data/spec/api/search_api_spec.rb +66 -0
- data/spec/api/token_api_spec.rb +67 -0
- data/spec/api_client_spec.rb +226 -0
- data/spec/configuration_spec.rb +42 -0
- data/spec/models/action_spec.rb +35 -0
- data/spec/models/address_spec.rb +77 -0
- data/spec/models/amount_spec.rb +53 -0
- data/spec/models/apm_spec.rb +81 -0
- data/spec/models/apm_spec_in_parameters_spec.rb +47 -0
- data/spec/models/auth_response_spec.rb +47 -0
- data/spec/models/auth_token_request_spec.rb +47 -0
- data/spec/models/auth_token_response_spec.rb +41 -0
- data/spec/models/bank_account_spec.rb +105 -0
- data/spec/models/billing_address_spec.rb +77 -0
- data/spec/models/booking_info_spec.rb +83 -0
- data/spec/models/capture_payment_request_spec.rb +57 -0
- data/spec/models/card_response_spec.rb +53 -0
- data/spec/models/card_spec.rb +71 -0
- data/spec/models/consent_spec.rb +57 -0
- data/spec/models/credit_card_auth_response_spec.rb +69 -0
- data/spec/models/customer_data_spec.rb +47 -0
- data/spec/models/customer_details_spec.rb +59 -0
- data/spec/models/customer_spec.rb +77 -0
- data/spec/models/deposit_details_spec.rb +41 -0
- data/spec/models/deposit_spec.rb +59 -0
- data/spec/models/disburse_line_items_req_spec.rb +47 -0
- data/spec/models/disburse_transaction_req_spec.rb +41 -0
- data/spec/models/disburse_transaction_spec.rb +47 -0
- data/spec/models/disbursement_all_of_spec.rb +41 -0
- data/spec/models/disbursement_details_spec.rb +41 -0
- data/spec/models/disbursement_request_spec.rb +35 -0
- data/spec/models/disbursement_requests_spec.rb +41 -0
- data/spec/models/disbursement_response_spec.rb +41 -0
- data/spec/models/disbursement_spec.rb +41 -0
- data/spec/models/error_response_spec.rb +47 -0
- data/spec/models/error_spec.rb +65 -0
- data/spec/models/fields_spec.rb +41 -0
- data/spec/models/gov_identification_spec.rb +81 -0
- data/spec/models/guest_info_response_spec.rb +47 -0
- data/spec/models/guest_spec.rb +77 -0
- data/spec/models/href_spec.rb +41 -0
- data/spec/models/inline_response200_spec.rb +65 -0
- data/spec/models/installment_plan_spec.rb +47 -0
- data/spec/models/instrument_spec.rb +57 -0
- data/spec/models/instrument_verification_response_spec.rb +83 -0
- data/spec/models/kyc_spec.rb +53 -0
- data/spec/models/lease_info_spec.rb +53 -0
- data/spec/models/line_item_details_spec.rb +65 -0
- data/spec/models/marketplace_data_spec.rb +63 -0
- data/spec/models/merketplace_spec.rb +41 -0
- data/spec/models/money_spec.rb +47 -0
- data/spec/models/name_spec.rb +71 -0
- data/spec/models/offering_details_spec.rb +53 -0
- data/spec/models/order_transactions_spec.rb +65 -0
- data/spec/models/payment_cancel_response_spec.rb +59 -0
- data/spec/models/payment_cancel_transaction_response_spec.rb +53 -0
- data/spec/models/payment_details_spec.rb +81 -0
- data/spec/models/payment_instrument_card_spec.rb +51 -0
- data/spec/models/payment_instrument_response_spec.rb +47 -0
- data/spec/models/payment_instrument_spec.rb +75 -0
- data/spec/models/payment_payment_all_of_spec.rb +71 -0
- data/spec/models/payment_payment_spec.rb +71 -0
- data/spec/models/payment_response_spec.rb +89 -0
- data/spec/models/payment_spec.rb +53 -0
- data/spec/models/phone_spec.rb +53 -0
- data/spec/models/process_payment_spec.rb +77 -0
- data/spec/models/property_info_response_spec.rb +47 -0
- data/spec/models/property_info_spec.rb +53 -0
- data/spec/models/refund_action_spec.rb +35 -0
- data/spec/models/refund_cancel_response_spec.rb +53 -0
- data/spec/models/refund_cancel_transaction_response_spec.rb +47 -0
- data/spec/models/refund_request_spec.rb +65 -0
- data/spec/models/refund_response_spec.rb +77 -0
- data/spec/models/refund_status_spec.rb +35 -0
- data/spec/models/refund_transactions_spec.rb +71 -0
- data/spec/models/rental_info_spec.rb +53 -0
- data/spec/models/renter_spec.rb +77 -0
- data/spec/models/resolution_spec.rb +41 -0
- data/spec/models/result_spec.rb +53 -0
- data/spec/models/risk_status_spec.rb +41 -0
- data/spec/models/sanctioned_entities_spec.rb +47 -0
- data/spec/models/search_payment_response_spec.rb +41 -0
- data/spec/models/stack_trace_element_spec.rb +65 -0
- data/spec/models/status_spec.rb +35 -0
- data/spec/models/throwable_spec.rb +53 -0
- data/spec/models/to_entity_ref_spec.rb +47 -0
- data/spec/models/token_req_spec.rb +47 -0
- data/spec/models/token_request_spec.rb +41 -0
- data/spec/models/token_response_spec.rb +41 -0
- data/spec/models/token_spec.rb +47 -0
- data/spec/models/transaction_response_spec.rb +71 -0
- data/spec/models/transaction_spec.rb +53 -0
- data/spec/models/triggers_spec.rb +53 -0
- data/spec/models/vacation_rental_info_request_spec.rb +53 -0
- data/spec/models/vacation_rental_info_spec.rb +47 -0
- data/spec/models/verify_instrument_request_spec.rb +53 -0
- data/spec/spec_helper.rb +111 -0
- data/yapstone-payments.gemspec +45 -0
- metadata +633 -0
@@ -0,0 +1,19 @@
|
|
1
|
+
# Yapstone::PaymentInstrumentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**instrument_type** | **String** | | [optional]
|
8
|
+
**token** | [**Token**](Token.md) | | [optional]
|
9
|
+
|
10
|
+
## Code Sample
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'Yapstone'
|
14
|
+
|
15
|
+
instance = Yapstone::PaymentInstrumentResponse.new(instrument_type: null,
|
16
|
+
token: null)
|
17
|
+
```
|
18
|
+
|
19
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# Yapstone::PaymentPayment
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**payment_id** | **String** | Unique identifier for a payment. Payments contain transactions associated with that payment. Multiple payments can be associated through a master payment. | [optional]
|
8
|
+
**total_amount** | [**Money**](Money.md) | | [optional]
|
9
|
+
**line_items** | **Array<Object>** | | [optional]
|
10
|
+
**payin_transactions** | **Array<Object>** | | [optional]
|
11
|
+
**payout_transactions** | **Array<Object>** | | [optional]
|
12
|
+
**deposit_details** | [**Array<DepositDetails>**](DepositDetails.md) | | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'Yapstone'
|
18
|
+
|
19
|
+
instance = Yapstone::PaymentPayment.new(payment_id: null,
|
20
|
+
total_amount: null,
|
21
|
+
line_items: null,
|
22
|
+
payin_transactions: null,
|
23
|
+
payout_transactions: null,
|
24
|
+
deposit_details: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,27 @@
|
|
1
|
+
# Yapstone::PaymentPaymentAllOf
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**payment_id** | **String** | Unique identifier for a payment. Payments contain transactions associated with that payment. Multiple payments can be associated through a master payment. | [optional]
|
8
|
+
**total_amount** | [**Money**](Money.md) | | [optional]
|
9
|
+
**line_items** | **Array<Object>** | | [optional]
|
10
|
+
**payin_transactions** | **Array<Object>** | | [optional]
|
11
|
+
**payout_transactions** | **Array<Object>** | | [optional]
|
12
|
+
**deposit_details** | [**Array<DepositDetails>**](DepositDetails.md) | | [optional]
|
13
|
+
|
14
|
+
## Code Sample
|
15
|
+
|
16
|
+
```ruby
|
17
|
+
require 'Yapstone'
|
18
|
+
|
19
|
+
instance = Yapstone::PaymentPaymentAllOf.new(payment_id: null,
|
20
|
+
total_amount: null,
|
21
|
+
line_items: null,
|
22
|
+
payin_transactions: null,
|
23
|
+
payout_transactions: null,
|
24
|
+
deposit_details: null)
|
25
|
+
```
|
26
|
+
|
27
|
+
|
@@ -0,0 +1,33 @@
|
|
1
|
+
# Yapstone::PaymentResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
Name | Type | Description | Notes
|
6
|
+
------------ | ------------- | ------------- | -------------
|
7
|
+
**action** | **String** | The action that was taken for this phase of the payment. | [optional]
|
8
|
+
**client_correlation_id** | **String** | Optionally provide your system's internal identifier for this entity, for use later if you need to correlate data across systems or consolidate records. | [optional]
|
9
|
+
**client_unique_transaction_id** | **String** | This is the unique transaction ID for one transaction to do with a payment being processed. You can use this to retrieve a specific transaction vs. a set of associated transactions (which is what you would use the clientCorrelationId for). | [optional]
|
10
|
+
**payment_id** | **String** | The payment ID allows you to reference the payment if you need to cancel it or retrieve it. | [optional]
|
11
|
+
**payment** | [**Payment**](Payment.md) | | [optional]
|
12
|
+
**customer** | [**CustomerDetails**](CustomerDetails.md) | | [optional]
|
13
|
+
**marketplace** | [**Merketplace**](Merketplace.md) | | [optional]
|
14
|
+
**custom_data** | **Hash<String, String>** | | [optional]
|
15
|
+
**refund_id** | **String** | | [optional]
|
16
|
+
|
17
|
+
## Code Sample
|
18
|
+
|
19
|
+
```ruby
|
20
|
+
require 'Yapstone'
|
21
|
+
|
22
|
+
instance = Yapstone::PaymentResponse.new(action: null,
|
23
|
+
client_correlation_id: a92afbb6-9599-48f1-b80b-acc6184d7a11,
|
24
|
+
client_unique_transaction_id: 4ed13361-5d66-4b76-8c6c-b462d5f638a7,
|
25
|
+
payment_id: null,
|
26
|
+
payment: null,
|
27
|
+
customer: null,
|
28
|
+
marketplace: null,
|
29
|
+
custom_data: null,
|
30
|
+
refund_id: null)
|
31
|
+
```
|
32
|
+
|
33
|
+
|
data/docs/PaymentsApi.md
ADDED
@@ -0,0 +1,447 @@
|
|
1
|
+
# Yapstone::PaymentsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api-prod-sandbox.yapstone.com*
|
4
|
+
|
5
|
+
Method | HTTP request | Description
|
6
|
+
------------- | ------------- | -------------
|
7
|
+
[**cancel_payment**](PaymentsApi.md#cancel_payment) | **DELETE** /v2/payments/payment/{paymentId} | Cancel Payment by payment Id
|
8
|
+
[**cancel_transaction**](PaymentsApi.md#cancel_transaction) | **DELETE** /v2/payments/transaction/{transactionId} | Cancel Transaction by TransactionId
|
9
|
+
[**capture_payment**](PaymentsApi.md#capture_payment) | **PATCH** /v2/payments/payment/{paymentId} | Capture a prior authorized payment
|
10
|
+
[**create_payment**](PaymentsApi.md#create_payment) | **POST** /v2/payments/payment | Process Payment
|
11
|
+
[**get_payment**](PaymentsApi.md#get_payment) | **GET** /v2/payments/payment/{paymentId} | Get with Payment Id
|
12
|
+
[**get_transaction**](PaymentsApi.md#get_transaction) | **GET** /v2/payments/transaction/{transactionId} | Get Transaction by Transaction Id
|
13
|
+
[**verify_payment_instrument**](PaymentsApi.md#verify_payment_instrument) | **POST** /v2/payments/instrument/verify | Verify payment instrument
|
14
|
+
|
15
|
+
|
16
|
+
|
17
|
+
## cancel_payment
|
18
|
+
|
19
|
+
> PaymentCancelResponse cancel_payment(authorization, x_yapstone_ip_address, payment_id, opts)
|
20
|
+
|
21
|
+
Cancel Payment by payment Id
|
22
|
+
|
23
|
+
Use a DELETE request to send a payment ID to this endpoint in order to cancel the payment.
|
24
|
+
|
25
|
+
### Example
|
26
|
+
|
27
|
+
```ruby
|
28
|
+
# load the gem
|
29
|
+
require 'yapstone-payments'
|
30
|
+
# setup authorization
|
31
|
+
Yapstone.configure do |config|
|
32
|
+
# Configure Bearer authorization (JWT): Bearer
|
33
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
34
|
+
end
|
35
|
+
|
36
|
+
api_instance = Yapstone::PaymentsApi.new
|
37
|
+
authorization = 'authorization_example' # String | Authorization
|
38
|
+
x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | Ip Address of the client
|
39
|
+
payment_id = 'payment_id_example' # String | paymentId
|
40
|
+
opts = {
|
41
|
+
x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.
|
42
|
+
x_yapstone_fpsid: 'x_yapstone_fpsid_example' # String | Device Finger Print Id
|
43
|
+
}
|
44
|
+
|
45
|
+
begin
|
46
|
+
#Cancel Payment by payment Id
|
47
|
+
result = api_instance.cancel_payment(authorization, x_yapstone_ip_address, payment_id, opts)
|
48
|
+
p result
|
49
|
+
rescue Yapstone::ApiError => e
|
50
|
+
puts "Exception when calling PaymentsApi->cancel_payment: #{e}"
|
51
|
+
end
|
52
|
+
```
|
53
|
+
|
54
|
+
### Parameters
|
55
|
+
|
56
|
+
|
57
|
+
Name | Type | Description | Notes
|
58
|
+
------------- | ------------- | ------------- | -------------
|
59
|
+
**authorization** | **String**| Authorization |
|
60
|
+
**x_yapstone_ip_address** | **String**| Ip Address of the client |
|
61
|
+
**payment_id** | **String**| paymentId |
|
62
|
+
**x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. | [optional]
|
63
|
+
**x_yapstone_fpsid** | **String**| Device Finger Print Id | [optional]
|
64
|
+
|
65
|
+
### Return type
|
66
|
+
|
67
|
+
[**PaymentCancelResponse**](PaymentCancelResponse.md)
|
68
|
+
|
69
|
+
### Authorization
|
70
|
+
|
71
|
+
[Bearer](../README.md#Bearer)
|
72
|
+
|
73
|
+
### HTTP request headers
|
74
|
+
|
75
|
+
- **Content-Type**: Not defined
|
76
|
+
- **Accept**: application/json
|
77
|
+
|
78
|
+
|
79
|
+
## cancel_transaction
|
80
|
+
|
81
|
+
> PaymentCancelTransactionResponse cancel_transaction(authorization, x_yapstone_ip_address, transaction_id, opts)
|
82
|
+
|
83
|
+
Cancel Transaction by TransactionId
|
84
|
+
|
85
|
+
Use a transaction identifier to cancel a transaction.
|
86
|
+
|
87
|
+
### Example
|
88
|
+
|
89
|
+
```ruby
|
90
|
+
# load the gem
|
91
|
+
require 'yapstone-payments'
|
92
|
+
# setup authorization
|
93
|
+
Yapstone.configure do |config|
|
94
|
+
# Configure Bearer authorization (JWT): Bearer
|
95
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
96
|
+
end
|
97
|
+
|
98
|
+
api_instance = Yapstone::PaymentsApi.new
|
99
|
+
authorization = 'authorization_example' # String | Authorization
|
100
|
+
x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | Ip Address of the client
|
101
|
+
transaction_id = 'transaction_id_example' # String | The transaction ID for the transaction you would like to cancel.
|
102
|
+
opts = {
|
103
|
+
x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.
|
104
|
+
x_yapstone_fpsid: 'x_yapstone_fpsid_example' # String | Device Finger Print Id
|
105
|
+
}
|
106
|
+
|
107
|
+
begin
|
108
|
+
#Cancel Transaction by TransactionId
|
109
|
+
result = api_instance.cancel_transaction(authorization, x_yapstone_ip_address, transaction_id, opts)
|
110
|
+
p result
|
111
|
+
rescue Yapstone::ApiError => e
|
112
|
+
puts "Exception when calling PaymentsApi->cancel_transaction: #{e}"
|
113
|
+
end
|
114
|
+
```
|
115
|
+
|
116
|
+
### Parameters
|
117
|
+
|
118
|
+
|
119
|
+
Name | Type | Description | Notes
|
120
|
+
------------- | ------------- | ------------- | -------------
|
121
|
+
**authorization** | **String**| Authorization |
|
122
|
+
**x_yapstone_ip_address** | **String**| Ip Address of the client |
|
123
|
+
**transaction_id** | **String**| The transaction ID for the transaction you would like to cancel. |
|
124
|
+
**x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. | [optional]
|
125
|
+
**x_yapstone_fpsid** | **String**| Device Finger Print Id | [optional]
|
126
|
+
|
127
|
+
### Return type
|
128
|
+
|
129
|
+
[**PaymentCancelTransactionResponse**](PaymentCancelTransactionResponse.md)
|
130
|
+
|
131
|
+
### Authorization
|
132
|
+
|
133
|
+
[Bearer](../README.md#Bearer)
|
134
|
+
|
135
|
+
### HTTP request headers
|
136
|
+
|
137
|
+
- **Content-Type**: Not defined
|
138
|
+
- **Accept**: application/json
|
139
|
+
|
140
|
+
|
141
|
+
## capture_payment
|
142
|
+
|
143
|
+
> PaymentResponse capture_payment(authorization, x_yapstone_ip_address, payment_id, opts)
|
144
|
+
|
145
|
+
Capture a prior authorized payment
|
146
|
+
|
147
|
+
Capture a prior authorized payment. This endpoint is used after a payment is authorized. Once a payment is authorized, you must capture it so that money can be transferred from the customer's account to the merchant's account.
|
148
|
+
|
149
|
+
### Example
|
150
|
+
|
151
|
+
```ruby
|
152
|
+
# load the gem
|
153
|
+
require 'yapstone-payments'
|
154
|
+
# setup authorization
|
155
|
+
Yapstone.configure do |config|
|
156
|
+
# Configure Bearer authorization (JWT): Bearer
|
157
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
158
|
+
end
|
159
|
+
|
160
|
+
api_instance = Yapstone::PaymentsApi.new
|
161
|
+
authorization = 'authorization_example' # String | Authorization
|
162
|
+
x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | Ip Address of the client
|
163
|
+
payment_id = 'payment_id_example' # String | The payment ID associated with the payment. You can use this to retrieve a payment or chance its status.
|
164
|
+
opts = {
|
165
|
+
x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.
|
166
|
+
x_yapstone_fpsid: 'x_yapstone_fpsid_example', # String | Device Finger Print Id
|
167
|
+
capture_payment_request: Yapstone::CapturePaymentRequest.new # CapturePaymentRequest |
|
168
|
+
}
|
169
|
+
|
170
|
+
begin
|
171
|
+
#Capture a prior authorized payment
|
172
|
+
result = api_instance.capture_payment(authorization, x_yapstone_ip_address, payment_id, opts)
|
173
|
+
p result
|
174
|
+
rescue Yapstone::ApiError => e
|
175
|
+
puts "Exception when calling PaymentsApi->capture_payment: #{e}"
|
176
|
+
end
|
177
|
+
```
|
178
|
+
|
179
|
+
### Parameters
|
180
|
+
|
181
|
+
|
182
|
+
Name | Type | Description | Notes
|
183
|
+
------------- | ------------- | ------------- | -------------
|
184
|
+
**authorization** | **String**| Authorization |
|
185
|
+
**x_yapstone_ip_address** | **String**| Ip Address of the client |
|
186
|
+
**payment_id** | **String**| The payment ID associated with the payment. You can use this to retrieve a payment or chance its status. |
|
187
|
+
**x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. | [optional]
|
188
|
+
**x_yapstone_fpsid** | **String**| Device Finger Print Id | [optional]
|
189
|
+
**capture_payment_request** | [**CapturePaymentRequest**](CapturePaymentRequest.md)| | [optional]
|
190
|
+
|
191
|
+
### Return type
|
192
|
+
|
193
|
+
[**PaymentResponse**](PaymentResponse.md)
|
194
|
+
|
195
|
+
### Authorization
|
196
|
+
|
197
|
+
[Bearer](../README.md#Bearer)
|
198
|
+
|
199
|
+
### HTTP request headers
|
200
|
+
|
201
|
+
- **Content-Type**: application/json
|
202
|
+
- **Accept**: application/json
|
203
|
+
|
204
|
+
|
205
|
+
## create_payment
|
206
|
+
|
207
|
+
> PaymentResponse create_payment(authorization, x_yapstone_ip_address, process_payment, opts)
|
208
|
+
|
209
|
+
Process Payment
|
210
|
+
|
211
|
+
The payment endpoint lets you create a payment and send information identifying the customer device the payment comes from.
|
212
|
+
|
213
|
+
### Example
|
214
|
+
|
215
|
+
```ruby
|
216
|
+
# load the gem
|
217
|
+
require 'yapstone-payments'
|
218
|
+
# setup authorization
|
219
|
+
Yapstone.configure do |config|
|
220
|
+
# Configure Bearer authorization (JWT): Bearer
|
221
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
222
|
+
end
|
223
|
+
|
224
|
+
api_instance = Yapstone::PaymentsApi.new
|
225
|
+
authorization = 'authorization_example' # String | Authorization
|
226
|
+
x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | This is the IP address of the client.
|
227
|
+
process_payment = Yapstone::ProcessPayment.new # ProcessPayment | processPayment
|
228
|
+
opts = {
|
229
|
+
x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.
|
230
|
+
x_yapstone_fpsid: 'x_yapstone_fpsid_example' # String | A device fingerprint is information gathered about the hardware and software of a website visitor combined with browser information. The fingerprint can be used to help retrieve particular sessions later, and it provides details about whoever is making a payment.
|
231
|
+
}
|
232
|
+
|
233
|
+
begin
|
234
|
+
#Process Payment
|
235
|
+
result = api_instance.create_payment(authorization, x_yapstone_ip_address, process_payment, opts)
|
236
|
+
p result
|
237
|
+
rescue Yapstone::ApiError => e
|
238
|
+
puts "Exception when calling PaymentsApi->create_payment: #{e}"
|
239
|
+
end
|
240
|
+
```
|
241
|
+
|
242
|
+
### Parameters
|
243
|
+
|
244
|
+
|
245
|
+
Name | Type | Description | Notes
|
246
|
+
------------- | ------------- | ------------- | -------------
|
247
|
+
**authorization** | **String**| Authorization |
|
248
|
+
**x_yapstone_ip_address** | **String**| This is the IP address of the client. |
|
249
|
+
**process_payment** | [**ProcessPayment**](ProcessPayment.md)| processPayment |
|
250
|
+
**x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. | [optional]
|
251
|
+
**x_yapstone_fpsid** | **String**| A device fingerprint is information gathered about the hardware and software of a website visitor combined with browser information. The fingerprint can be used to help retrieve particular sessions later, and it provides details about whoever is making a payment. | [optional]
|
252
|
+
|
253
|
+
### Return type
|
254
|
+
|
255
|
+
[**PaymentResponse**](PaymentResponse.md)
|
256
|
+
|
257
|
+
### Authorization
|
258
|
+
|
259
|
+
[Bearer](../README.md#Bearer)
|
260
|
+
|
261
|
+
### HTTP request headers
|
262
|
+
|
263
|
+
- **Content-Type**: application/json
|
264
|
+
- **Accept**: application/json
|
265
|
+
|
266
|
+
|
267
|
+
## get_payment
|
268
|
+
|
269
|
+
> PaymentResponse get_payment(authorization, x_yapstone_ip_address, payment_id, opts)
|
270
|
+
|
271
|
+
Get with Payment Id
|
272
|
+
|
273
|
+
This endpoint lets you send a GET request containing a payment ID. The associated payment is returned to you in the response.
|
274
|
+
|
275
|
+
### Example
|
276
|
+
|
277
|
+
```ruby
|
278
|
+
# load the gem
|
279
|
+
require 'yapstone-payments'
|
280
|
+
# setup authorization
|
281
|
+
Yapstone.configure do |config|
|
282
|
+
# Configure Bearer authorization (JWT): Bearer
|
283
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
284
|
+
end
|
285
|
+
|
286
|
+
api_instance = Yapstone::PaymentsApi.new
|
287
|
+
authorization = 'authorization_example' # String | Authorization
|
288
|
+
x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | IP Address of the client
|
289
|
+
payment_id = 'payment_id_example' # String | paymentId
|
290
|
+
opts = {
|
291
|
+
x_yapstone_trace_id: 'x_yapstone_trace_id_example' # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.
|
292
|
+
}
|
293
|
+
|
294
|
+
begin
|
295
|
+
#Get with Payment Id
|
296
|
+
result = api_instance.get_payment(authorization, x_yapstone_ip_address, payment_id, opts)
|
297
|
+
p result
|
298
|
+
rescue Yapstone::ApiError => e
|
299
|
+
puts "Exception when calling PaymentsApi->get_payment: #{e}"
|
300
|
+
end
|
301
|
+
```
|
302
|
+
|
303
|
+
### Parameters
|
304
|
+
|
305
|
+
|
306
|
+
Name | Type | Description | Notes
|
307
|
+
------------- | ------------- | ------------- | -------------
|
308
|
+
**authorization** | **String**| Authorization |
|
309
|
+
**x_yapstone_ip_address** | **String**| IP Address of the client |
|
310
|
+
**payment_id** | **String**| paymentId |
|
311
|
+
**x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. | [optional]
|
312
|
+
|
313
|
+
### Return type
|
314
|
+
|
315
|
+
[**PaymentResponse**](PaymentResponse.md)
|
316
|
+
|
317
|
+
### Authorization
|
318
|
+
|
319
|
+
[Bearer](../README.md#Bearer)
|
320
|
+
|
321
|
+
### HTTP request headers
|
322
|
+
|
323
|
+
- **Content-Type**: Not defined
|
324
|
+
- **Accept**: application/json
|
325
|
+
|
326
|
+
|
327
|
+
## get_transaction
|
328
|
+
|
329
|
+
> OrderTransactions get_transaction(authorization, x_yapstone_ip_address, transaction_id, opts)
|
330
|
+
|
331
|
+
Get Transaction by Transaction Id
|
332
|
+
|
333
|
+
Retrieve information about a specific transaction.
|
334
|
+
|
335
|
+
### Example
|
336
|
+
|
337
|
+
```ruby
|
338
|
+
# load the gem
|
339
|
+
require 'yapstone-payments'
|
340
|
+
# setup authorization
|
341
|
+
Yapstone.configure do |config|
|
342
|
+
# Configure Bearer authorization (JWT): Bearer
|
343
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
344
|
+
end
|
345
|
+
|
346
|
+
api_instance = Yapstone::PaymentsApi.new
|
347
|
+
authorization = 'authorization_example' # String | Authorization
|
348
|
+
x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | IP Address of the client
|
349
|
+
transaction_id = 'transaction_id_example' # String | The transaction identifier for the transaction you want to retrieve details about.
|
350
|
+
opts = {
|
351
|
+
x_yapstone_trace_id: 'x_yapstone_trace_id_example' # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.
|
352
|
+
}
|
353
|
+
|
354
|
+
begin
|
355
|
+
#Get Transaction by Transaction Id
|
356
|
+
result = api_instance.get_transaction(authorization, x_yapstone_ip_address, transaction_id, opts)
|
357
|
+
p result
|
358
|
+
rescue Yapstone::ApiError => e
|
359
|
+
puts "Exception when calling PaymentsApi->get_transaction: #{e}"
|
360
|
+
end
|
361
|
+
```
|
362
|
+
|
363
|
+
### Parameters
|
364
|
+
|
365
|
+
|
366
|
+
Name | Type | Description | Notes
|
367
|
+
------------- | ------------- | ------------- | -------------
|
368
|
+
**authorization** | **String**| Authorization |
|
369
|
+
**x_yapstone_ip_address** | **String**| IP Address of the client |
|
370
|
+
**transaction_id** | **String**| The transaction identifier for the transaction you want to retrieve details about. |
|
371
|
+
**x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. | [optional]
|
372
|
+
|
373
|
+
### Return type
|
374
|
+
|
375
|
+
[**OrderTransactions**](OrderTransactions.md)
|
376
|
+
|
377
|
+
### Authorization
|
378
|
+
|
379
|
+
[Bearer](../README.md#Bearer)
|
380
|
+
|
381
|
+
### HTTP request headers
|
382
|
+
|
383
|
+
- **Content-Type**: Not defined
|
384
|
+
- **Accept**: application/json
|
385
|
+
|
386
|
+
|
387
|
+
## verify_payment_instrument
|
388
|
+
|
389
|
+
> InstrumentVerificationResponse verify_payment_instrument(authorization, x_yapstone_ip_address, verify_instrument_request, opts)
|
390
|
+
|
391
|
+
Verify payment instrument
|
392
|
+
|
393
|
+
Use this endpoint to verify that a customer's payment instrument is valid and associated with them.
|
394
|
+
|
395
|
+
### Example
|
396
|
+
|
397
|
+
```ruby
|
398
|
+
# load the gem
|
399
|
+
require 'yapstone-payments'
|
400
|
+
# setup authorization
|
401
|
+
Yapstone.configure do |config|
|
402
|
+
# Configure Bearer authorization (JWT): Bearer
|
403
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
404
|
+
end
|
405
|
+
|
406
|
+
api_instance = Yapstone::PaymentsApi.new
|
407
|
+
authorization = 'authorization_example' # String | Authorization
|
408
|
+
x_yapstone_ip_address = 'x_yapstone_ip_address_example' # String | IP Address of the client
|
409
|
+
verify_instrument_request = Yapstone::VerifyInstrumentRequest.new # VerifyInstrumentRequest | verifyInstrumentRequest
|
410
|
+
opts = {
|
411
|
+
x_yapstone_trace_id: 'x_yapstone_trace_id_example', # String | Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string.
|
412
|
+
x_yapstone_fpsid: 'x_yapstone_fpsid_example' # String | Device Finger Print Id
|
413
|
+
}
|
414
|
+
|
415
|
+
begin
|
416
|
+
#Verify payment instrument
|
417
|
+
result = api_instance.verify_payment_instrument(authorization, x_yapstone_ip_address, verify_instrument_request, opts)
|
418
|
+
p result
|
419
|
+
rescue Yapstone::ApiError => e
|
420
|
+
puts "Exception when calling PaymentsApi->verify_payment_instrument: #{e}"
|
421
|
+
end
|
422
|
+
```
|
423
|
+
|
424
|
+
### Parameters
|
425
|
+
|
426
|
+
|
427
|
+
Name | Type | Description | Notes
|
428
|
+
------------- | ------------- | ------------- | -------------
|
429
|
+
**authorization** | **String**| Authorization |
|
430
|
+
**x_yapstone_ip_address** | **String**| IP Address of the client |
|
431
|
+
**verify_instrument_request** | [**VerifyInstrumentRequest**](VerifyInstrumentRequest.md)| verifyInstrumentRequest |
|
432
|
+
**x_yapstone_trace_id** | **String**| Optionally provide a unique identifier for this request, for use later if you need to debug this request with Yapstone support. Can be any arbitrary string. | [optional]
|
433
|
+
**x_yapstone_fpsid** | **String**| Device Finger Print Id | [optional]
|
434
|
+
|
435
|
+
### Return type
|
436
|
+
|
437
|
+
[**InstrumentVerificationResponse**](InstrumentVerificationResponse.md)
|
438
|
+
|
439
|
+
### Authorization
|
440
|
+
|
441
|
+
[Bearer](../README.md#Bearer)
|
442
|
+
|
443
|
+
### HTTP request headers
|
444
|
+
|
445
|
+
- **Content-Type**: application/json
|
446
|
+
- **Accept**: application/json
|
447
|
+
|