digital_femsa 1.0.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 +7 -0
- data/CODE_OF_CONDUCT.md +77 -0
- data/CONTRIBUTING.md +19 -0
- data/Gemfile +9 -0
- data/LICENSE +22 -0
- data/Makefile +11 -0
- data/README.md +320 -0
- data/Rakefile +10 -0
- data/VERSION +1 -0
- data/config-ruby.json +30 -0
- data/digital_femsa.gemspec +41 -0
- data/docs/ApiKeyCreateResponse.md +40 -0
- data/docs/ApiKeyRequest.md +20 -0
- data/docs/ApiKeyResponse.md +38 -0
- data/docs/ApiKeyResponseOnDelete.md +34 -0
- data/docs/ApiKeyUpdateRequest.md +20 -0
- data/docs/ApiKeysApi.md +391 -0
- data/docs/BalanceCommonField.md +20 -0
- data/docs/BalanceResponse.md +36 -0
- data/docs/BalancesApi.md +79 -0
- data/docs/ChargeOrderResponse.md +52 -0
- data/docs/ChargeOrderResponsePaymentMethod.md +76 -0
- data/docs/ChargeRequest.md +22 -0
- data/docs/ChargeRequestPaymentMethod.md +22 -0
- data/docs/ChargeResponse.md +52 -0
- data/docs/ChargeResponseChannel.md +24 -0
- data/docs/ChargeResponsePaymentMethod.md +76 -0
- data/docs/ChargeResponseRefunds.md +26 -0
- data/docs/ChargeResponseRefundsData.md +30 -0
- data/docs/ChargeUpdateRequest.md +18 -0
- data/docs/ChargesApi.md +241 -0
- data/docs/ChargesDataResponse.md +52 -0
- data/docs/Checkout.md +34 -0
- data/docs/CheckoutOrderTemplate.md +24 -0
- data/docs/CheckoutOrderTemplateCustomerInfo.md +49 -0
- data/docs/CheckoutRequest.md +30 -0
- data/docs/CheckoutResponse.md +58 -0
- data/docs/CheckoutsResponse.md +26 -0
- data/docs/CompaniesApi.md +159 -0
- data/docs/CompanyFiscalInfoAddressResponse.md +34 -0
- data/docs/CompanyFiscalInfoResponse.md +30 -0
- data/docs/CompanyPayoutDestinationResponse.md +28 -0
- data/docs/CompanyResponse.md +32 -0
- data/docs/CreateCustomerFiscalEntitiesResponse.md +38 -0
- data/docs/CreateCustomerPaymentMethodsRequest.md +47 -0
- data/docs/CreateCustomerPaymentMethodsResponse.md +77 -0
- data/docs/Customer.md +40 -0
- data/docs/CustomerAddress.md +32 -0
- data/docs/CustomerAntifraudInfo.md +20 -0
- data/docs/CustomerAntifraudInfoResponse.md +20 -0
- data/docs/CustomerFiscalEntitiesDataResponse.md +38 -0
- data/docs/CustomerFiscalEntitiesRequest.md +28 -0
- data/docs/CustomerFiscalEntitiesResponse.md +22 -0
- data/docs/CustomerInfo.md +26 -0
- data/docs/CustomerInfoJustCustomerId.md +18 -0
- data/docs/CustomerInfoJustCustomerIdResponse.md +18 -0
- data/docs/CustomerPaymentMethodRequest.md +18 -0
- data/docs/CustomerPaymentMethodsData.md +77 -0
- data/docs/CustomerPaymentMethodsRequest.md +47 -0
- data/docs/CustomerPaymentMethodsResponse.md +26 -0
- data/docs/CustomerResponse.md +50 -0
- data/docs/CustomerResponseShippingContacts.md +22 -0
- data/docs/CustomerShippingContacts.md +32 -0
- data/docs/CustomerShippingContactsAddress.md +30 -0
- data/docs/CustomerShippingContactsDataResponse.md +38 -0
- data/docs/CustomerShippingContactsResponse.md +38 -0
- data/docs/CustomerShippingContactsResponseAddress.md +32 -0
- data/docs/CustomerUpdateFiscalEntitiesRequest.md +28 -0
- data/docs/CustomerUpdateShippingContacts.md +30 -0
- data/docs/CustomersApi.md +553 -0
- data/docs/CustomersResponse.md +26 -0
- data/docs/DeleteApiKeysResponse.md +34 -0
- data/docs/Details.md +18 -0
- data/docs/DetailsError.md +24 -0
- data/docs/DiscountLinesDataResponse.md +28 -0
- data/docs/DiscountLinesResponse.md +28 -0
- data/docs/DiscountsApi.md +405 -0
- data/docs/EmailCheckoutRequest.md +18 -0
- data/docs/Error.md +24 -0
- data/docs/EventResponse.md +32 -0
- data/docs/EventsApi.md +239 -0
- data/docs/EventsResendResponse.md +28 -0
- data/docs/FiscalEntityAddress.md +30 -0
- data/docs/GetApiKeysResponse.md +26 -0
- data/docs/GetChargesResponse.md +26 -0
- data/docs/GetCompaniesResponse.md +26 -0
- data/docs/GetCustomerPaymentMethodDataResponse.md +77 -0
- data/docs/GetEventsResponse.md +26 -0
- data/docs/GetOrderDiscountLinesResponse.md +26 -0
- data/docs/GetOrdersResponse.md +26 -0
- data/docs/GetPaymentMethodResponse.md +26 -0
- data/docs/GetTransactionsResponse.md +26 -0
- data/docs/GetTransfersResponse.md +26 -0
- data/docs/GetWebhookKeysResponse.md +26 -0
- data/docs/GetWebhooksResponse.md +26 -0
- data/docs/LogResponse.md +56 -0
- data/docs/LogsApi.md +165 -0
- data/docs/LogsResponse.md +26 -0
- data/docs/LogsResponseData.md +56 -0
- data/docs/OrderCaptureRequest.md +18 -0
- data/docs/OrderCustomerInfoResponse.md +28 -0
- data/docs/OrderDiscountLinesRequest.md +22 -0
- data/docs/OrderFiscalEntityAddressResponse.md +32 -0
- data/docs/OrderFiscalEntityRequest.md +28 -0
- data/docs/OrderFiscalEntityResponse.md +34 -0
- data/docs/OrderNextActionResponse.md +20 -0
- data/docs/OrderNextActionResponseRedirectToUrl.md +20 -0
- data/docs/OrderRefundRequest.md +22 -0
- data/docs/OrderRequest.md +44 -0
- data/docs/OrderRequestCustomerInfo.md +49 -0
- data/docs/OrderResponse.md +58 -0
- data/docs/OrderResponseCharges.md +22 -0
- data/docs/OrderResponseCheckout.md +58 -0
- data/docs/OrderResponseCustomerInfo.md +30 -0
- data/docs/OrderResponseDiscountLines.md +22 -0
- data/docs/OrderResponseProducts.md +26 -0
- data/docs/OrderResponseShippingContact.md +38 -0
- data/docs/OrderTaxRequest.md +22 -0
- data/docs/OrderUpdateFiscalEntityRequest.md +28 -0
- data/docs/OrderUpdateRequest.md +40 -0
- data/docs/OrderUpdateRequestCustomerInfo.md +49 -0
- data/docs/OrdersApi.md +627 -0
- data/docs/OrdersResponse.md +18 -0
- data/docs/Page.md +20 -0
- data/docs/Pagination.md +20 -0
- data/docs/PaymentLinkApi.md +463 -0
- data/docs/PaymentMethod.md +20 -0
- data/docs/PaymentMethodCash.md +36 -0
- data/docs/PaymentMethodCashRequest.md +20 -0
- data/docs/PaymentMethodCashResponse.md +36 -0
- data/docs/PaymentMethodResponse.md +26 -0
- data/docs/PaymentMethodsApi.md +327 -0
- data/docs/Product.md +34 -0
- data/docs/ProductDataResponse.md +40 -0
- data/docs/ProductOrderResponse.md +40 -0
- data/docs/ProductsApi.md +243 -0
- data/docs/ShippingContactsApi.md +243 -0
- data/docs/ShippingOrderResponse.md +32 -0
- data/docs/ShippingRequest.md +26 -0
- data/docs/ShippingsApi.md +243 -0
- data/docs/SmsCheckoutRequest.md +18 -0
- data/docs/TaxesApi.md +243 -0
- data/docs/TransactionResponse.md +38 -0
- data/docs/TransactionsApi.md +171 -0
- data/docs/TransferDestinationResponse.md +32 -0
- data/docs/TransferMethodResponse.md +32 -0
- data/docs/TransferResponse.md +36 -0
- data/docs/TransfersApi.md +165 -0
- data/docs/TransfersResponse.md +36 -0
- data/docs/UpdateCustomer.md +40 -0
- data/docs/UpdateCustomerAntifraudInfo.md +20 -0
- data/docs/UpdateCustomerFiscalEntitiesResponse.md +38 -0
- data/docs/UpdateCustomerPaymentMethodsResponse.md +77 -0
- data/docs/UpdateOrderDiscountLinesRequest.md +22 -0
- data/docs/UpdateOrderTaxRequest.md +22 -0
- data/docs/UpdateOrderTaxResponse.md +28 -0
- data/docs/UpdatePaymentMethods.md +18 -0
- data/docs/UpdateProduct.md +34 -0
- data/docs/WebhookKeyCreateResponse.md +28 -0
- data/docs/WebhookKeyDeleteResponse.md +28 -0
- data/docs/WebhookKeyRequest.md +18 -0
- data/docs/WebhookKeyResponse.md +30 -0
- data/docs/WebhookKeyUpdateRequest.md +18 -0
- data/docs/WebhookKeysApi.md +385 -0
- data/docs/WebhookLog.md +30 -0
- data/docs/WebhookRequest.md +20 -0
- data/docs/WebhookResponse.md +36 -0
- data/docs/WebhookUpdateRequest.md +22 -0
- data/docs/WebhooksApi.md +461 -0
- data/gitleaks.toml +0 -0
- data/lib/digital_femsa/api/api_keys_api.rb +407 -0
- data/lib/digital_femsa/api/balances_api.rb +86 -0
- data/lib/digital_femsa/api/charges_api.rb +273 -0
- data/lib/digital_femsa/api/companies_api.rb +174 -0
- data/lib/digital_femsa/api/customers_api.rb +591 -0
- data/lib/digital_femsa/api/discounts_api.rb +447 -0
- data/lib/digital_femsa/api/events_api.rb +256 -0
- data/lib/digital_femsa/api/logs_api.rb +182 -0
- data/lib/digital_femsa/api/orders_api.rb +657 -0
- data/lib/digital_femsa/api/payment_link_api.rb +491 -0
- data/lib/digital_femsa/api/payment_methods_api.rb +368 -0
- data/lib/digital_femsa/api/products_api.rb +275 -0
- data/lib/digital_femsa/api/shipping_contacts_api.rb +275 -0
- data/lib/digital_femsa/api/shippings_api.rb +275 -0
- data/lib/digital_femsa/api/taxes_api.rb +275 -0
- data/lib/digital_femsa/api/transactions_api.rb +191 -0
- data/lib/digital_femsa/api/transfers_api.rb +182 -0
- data/lib/digital_femsa/api/webhook_keys_api.rb +396 -0
- data/lib/digital_femsa/api/webhooks_api.rb +477 -0
- data/lib/digital_femsa/api_client.rb +442 -0
- data/lib/digital_femsa/api_error.rb +58 -0
- data/lib/digital_femsa/configuration.rb +382 -0
- data/lib/digital_femsa/models/api_key_create_response.rb +333 -0
- data/lib/digital_femsa/models/api_key_request.rb +231 -0
- data/lib/digital_femsa/models/api_key_response.rb +317 -0
- data/lib/digital_femsa/models/api_key_response_on_delete.rb +296 -0
- data/lib/digital_femsa/models/api_key_update_request.rb +225 -0
- data/lib/digital_femsa/models/balance_common_field.rb +226 -0
- data/lib/digital_femsa/models/balance_response.rb +324 -0
- data/lib/digital_femsa/models/charge_order_response.rb +373 -0
- data/lib/digital_femsa/models/charge_order_response_payment_method.rb +53 -0
- data/lib/digital_femsa/models/charge_request.rb +241 -0
- data/lib/digital_femsa/models/charge_request_payment_method.rb +241 -0
- data/lib/digital_femsa/models/charge_response.rb +371 -0
- data/lib/digital_femsa/models/charge_response_channel.rb +241 -0
- data/lib/digital_femsa/models/charge_response_payment_method.rb +53 -0
- data/lib/digital_femsa/models/charge_response_refunds.rb +281 -0
- data/lib/digital_femsa/models/charge_response_refunds_data.rb +298 -0
- data/lib/digital_femsa/models/charge_update_request.rb +216 -0
- data/lib/digital_femsa/models/charges_data_response.rb +378 -0
- data/lib/digital_femsa/models/checkout.rb +340 -0
- data/lib/digital_femsa/models/checkout_order_template.rb +301 -0
- data/lib/digital_femsa/models/checkout_order_template_customer_info.rb +106 -0
- data/lib/digital_femsa/models/checkout_request.rb +284 -0
- data/lib/digital_femsa/models/checkout_response.rb +429 -0
- data/lib/digital_femsa/models/checkouts_response.rb +280 -0
- data/lib/digital_femsa/models/company_fiscal_info_address_response.rb +330 -0
- data/lib/digital_femsa/models/company_fiscal_info_response.rb +309 -0
- data/lib/digital_femsa/models/company_payout_destination_response.rb +312 -0
- data/lib/digital_femsa/models/company_response.rb +318 -0
- data/lib/digital_femsa/models/create_customer_fiscal_entities_response.rb +341 -0
- data/lib/digital_femsa/models/create_customer_payment_methods_request.rb +105 -0
- data/lib/digital_femsa/models/create_customer_payment_methods_response.rb +54 -0
- data/lib/digital_femsa/models/customer.rb +374 -0
- data/lib/digital_femsa/models/customer_address.rb +301 -0
- data/lib/digital_femsa/models/customer_antifraud_info.rb +223 -0
- data/lib/digital_femsa/models/customer_antifraud_info_response.rb +223 -0
- data/lib/digital_femsa/models/customer_fiscal_entities_data_response.rb +341 -0
- data/lib/digital_femsa/models/customer_fiscal_entities_request.rb +268 -0
- data/lib/digital_femsa/models/customer_fiscal_entities_response.rb +257 -0
- data/lib/digital_femsa/models/customer_info.rb +271 -0
- data/lib/digital_femsa/models/customer_info_just_customer_id.rb +221 -0
- data/lib/digital_femsa/models/customer_info_just_customer_id_response.rb +214 -0
- data/lib/digital_femsa/models/customer_payment_method_request.rb +223 -0
- data/lib/digital_femsa/models/customer_payment_methods_data.rb +54 -0
- data/lib/digital_femsa/models/customer_payment_methods_request.rb +104 -0
- data/lib/digital_femsa/models/customer_payment_methods_response.rb +280 -0
- data/lib/digital_femsa/models/customer_response.rb +425 -0
- data/lib/digital_femsa/models/customer_response_shipping_contacts.rb +257 -0
- data/lib/digital_femsa/models/customer_shipping_contacts.rb +312 -0
- data/lib/digital_femsa/models/customer_shipping_contacts_address.rb +271 -0
- data/lib/digital_femsa/models/customer_shipping_contacts_data_response.rb +366 -0
- data/lib/digital_femsa/models/customer_shipping_contacts_response.rb +328 -0
- data/lib/digital_femsa/models/customer_shipping_contacts_response_address.rb +278 -0
- data/lib/digital_femsa/models/customer_update_fiscal_entities_request.rb +261 -0
- data/lib/digital_femsa/models/customer_update_shipping_contacts.rb +274 -0
- data/lib/digital_femsa/models/customers_response.rb +280 -0
- data/lib/digital_femsa/models/delete_api_keys_response.rb +301 -0
- data/lib/digital_femsa/models/details.rb +216 -0
- data/lib/digital_femsa/models/details_error.rb +242 -0
- data/lib/digital_femsa/models/discount_lines_data_response.rb +333 -0
- data/lib/digital_femsa/models/discount_lines_response.rb +333 -0
- data/lib/digital_femsa/models/email_checkout_request.rb +221 -0
- data/lib/digital_femsa/models/error.rb +253 -0
- data/lib/digital_femsa/models/event_response.rb +301 -0
- data/lib/digital_femsa/models/events_resend_response.rb +281 -0
- data/lib/digital_femsa/models/fiscal_entity_address.rb +312 -0
- data/lib/digital_femsa/models/get_api_keys_response.rb +280 -0
- data/lib/digital_femsa/models/get_charges_response.rb +280 -0
- data/lib/digital_femsa/models/get_companies_response.rb +280 -0
- data/lib/digital_femsa/models/get_customer_payment_method_data_response.rb +54 -0
- data/lib/digital_femsa/models/get_events_response.rb +280 -0
- data/lib/digital_femsa/models/get_order_discount_lines_response.rb +280 -0
- data/lib/digital_femsa/models/get_orders_response.rb +288 -0
- data/lib/digital_femsa/models/get_payment_method_response.rb +280 -0
- data/lib/digital_femsa/models/get_transactions_response.rb +281 -0
- data/lib/digital_femsa/models/get_transfers_response.rb +281 -0
- data/lib/digital_femsa/models/get_webhook_keys_response.rb +280 -0
- data/lib/digital_femsa/models/get_webhooks_response.rb +280 -0
- data/lib/digital_femsa/models/log_response.rb +418 -0
- data/lib/digital_femsa/models/logs_response.rb +261 -0
- data/lib/digital_femsa/models/logs_response_data.rb +396 -0
- data/lib/digital_femsa/models/order_capture_request.rb +241 -0
- data/lib/digital_femsa/models/order_customer_info_response.rb +263 -0
- data/lib/digital_femsa/models/order_discount_lines_request.rb +276 -0
- data/lib/digital_femsa/models/order_fiscal_entity_address_response.rb +328 -0
- data/lib/digital_femsa/models/order_fiscal_entity_request.rb +295 -0
- data/lib/digital_femsa/models/order_fiscal_entity_response.rb +347 -0
- data/lib/digital_femsa/models/order_next_action_response.rb +225 -0
- data/lib/digital_femsa/models/order_next_action_response_redirect_to_url.rb +226 -0
- data/lib/digital_femsa/models/order_refund_request.rb +247 -0
- data/lib/digital_femsa/models/order_request.rb +413 -0
- data/lib/digital_femsa/models/order_request_customer_info.rb +106 -0
- data/lib/digital_femsa/models/order_response.rb +427 -0
- data/lib/digital_femsa/models/order_response_charges.rb +258 -0
- data/lib/digital_femsa/models/order_response_checkout.rb +418 -0
- data/lib/digital_femsa/models/order_response_customer_info.rb +280 -0
- data/lib/digital_femsa/models/order_response_discount_lines.rb +257 -0
- data/lib/digital_femsa/models/order_response_products.rb +280 -0
- data/lib/digital_femsa/models/order_response_shipping_contact.rb +334 -0
- data/lib/digital_femsa/models/order_tax_request.rb +308 -0
- data/lib/digital_femsa/models/order_update_fiscal_entity_request.rb +295 -0
- data/lib/digital_femsa/models/order_update_request.rb +352 -0
- data/lib/digital_femsa/models/order_update_request_customer_info.rb +105 -0
- data/lib/digital_femsa/models/orders_response.rb +223 -0
- data/lib/digital_femsa/models/page.rb +228 -0
- data/lib/digital_femsa/models/pagination.rb +240 -0
- data/lib/digital_femsa/models/payment_method.rb +230 -0
- data/lib/digital_femsa/models/payment_method_cash.rb +312 -0
- data/lib/digital_femsa/models/payment_method_cash_request.rb +238 -0
- data/lib/digital_femsa/models/payment_method_cash_response.rb +330 -0
- data/lib/digital_femsa/models/payment_method_response.rb +278 -0
- data/lib/digital_femsa/models/product.rb +397 -0
- data/lib/digital_femsa/models/product_data_response.rb +431 -0
- data/lib/digital_femsa/models/product_order_response.rb +431 -0
- data/lib/digital_femsa/models/shipping_order_response.rb +336 -0
- data/lib/digital_femsa/models/shipping_request.rb +302 -0
- data/lib/digital_femsa/models/sms_checkout_request.rb +221 -0
- data/lib/digital_femsa/models/transaction_response.rb +412 -0
- data/lib/digital_femsa/models/transfer_destination_response.rb +286 -0
- data/lib/digital_femsa/models/transfer_method_response.rb +286 -0
- data/lib/digital_femsa/models/transfer_response.rb +324 -0
- data/lib/digital_femsa/models/transfers_response.rb +324 -0
- data/lib/digital_femsa/models/update_customer.rb +353 -0
- data/lib/digital_femsa/models/update_customer_antifraud_info.rb +223 -0
- data/lib/digital_femsa/models/update_customer_fiscal_entities_response.rb +341 -0
- data/lib/digital_femsa/models/update_customer_payment_methods_response.rb +54 -0
- data/lib/digital_femsa/models/update_order_discount_lines_request.rb +253 -0
- data/lib/digital_femsa/models/update_order_tax_request.rb +294 -0
- data/lib/digital_femsa/models/update_order_tax_response.rb +349 -0
- data/lib/digital_femsa/models/update_payment_methods.rb +214 -0
- data/lib/digital_femsa/models/update_product.rb +349 -0
- data/lib/digital_femsa/models/webhook_key_create_response.rb +266 -0
- data/lib/digital_femsa/models/webhook_key_delete_response.rb +266 -0
- data/lib/digital_femsa/models/webhook_key_request.rb +217 -0
- data/lib/digital_femsa/models/webhook_key_response.rb +277 -0
- data/lib/digital_femsa/models/webhook_key_update_request.rb +217 -0
- data/lib/digital_femsa/models/webhook_log.rb +289 -0
- data/lib/digital_femsa/models/webhook_request.rb +261 -0
- data/lib/digital_femsa/models/webhook_response.rb +299 -0
- data/lib/digital_femsa/models/webhook_update_request.rb +267 -0
- data/lib/digital_femsa/version.rb +15 -0
- data/lib/digital_femsa.rb +197 -0
- data/lib/ssl_data/ca_bundle.crt +4039 -0
- data/spec/api/api_keys_api_spec.rb +107 -0
- data/spec/api/balances_api_spec.rb +47 -0
- data/spec/api/charges_api_spec.rb +80 -0
- data/spec/api/companies_api_spec.rb +63 -0
- data/spec/api/customers_api_spec.rb +140 -0
- data/spec/api/discounts_api_spec.rb +114 -0
- data/spec/api/events_api_spec.rb +79 -0
- data/spec/api/logs_api_spec.rb +66 -0
- data/spec/api/orders_api_spec.rb +153 -0
- data/spec/api/payment_link_api_spec.rb +119 -0
- data/spec/api/payment_methods_api_spec.rb +99 -0
- data/spec/api/products_api_spec.rb +81 -0
- data/spec/api/shipping_contacts_api_spec.rb +81 -0
- data/spec/api/shippings_api_spec.rb +81 -0
- data/spec/api/taxes_api_spec.rb +81 -0
- data/spec/api/transactions_api_spec.rb +69 -0
- data/spec/api/transfers_api_spec.rb +66 -0
- data/spec/api/webhook_keys_api_spec.rb +104 -0
- data/spec/api/webhooks_api_spec.rb +118 -0
- data/spec/spec_helper.rb +111 -0
- data/ssl_data/ca_bundle.crt +4039 -0
- data/templates/ruby/CUSTOM_VERSION.mustache +1 -0
- data/templates/ruby/api_client.mustache +257 -0
- data/templates/ruby/configuration.mustache +481 -0
- metadata +488 -0
|
@@ -0,0 +1,463 @@
|
|
|
1
|
+
# DigitalFemsa::PaymentLinkApi
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *https://api.digitalfemsa.io*
|
|
4
|
+
|
|
5
|
+
| Method | HTTP request | Description |
|
|
6
|
+
| ------ | ------------ | ----------- |
|
|
7
|
+
| [**cancel_checkout**](PaymentLinkApi.md#cancel_checkout) | **PUT** /checkouts/{id}/cancel | Cancel Payment Link |
|
|
8
|
+
| [**create_checkout**](PaymentLinkApi.md#create_checkout) | **POST** /checkouts | Create Unique Payment Link |
|
|
9
|
+
| [**email_checkout**](PaymentLinkApi.md#email_checkout) | **POST** /checkouts/{id}/email | Send an email |
|
|
10
|
+
| [**get_checkout**](PaymentLinkApi.md#get_checkout) | **GET** /checkouts/{id} | Get a payment link by ID |
|
|
11
|
+
| [**get_checkouts**](PaymentLinkApi.md#get_checkouts) | **GET** /checkouts | Get a list of payment links |
|
|
12
|
+
| [**sms_checkout**](PaymentLinkApi.md#sms_checkout) | **POST** /checkouts/{id}/sms | Send an sms |
|
|
13
|
+
|
|
14
|
+
|
|
15
|
+
## cancel_checkout
|
|
16
|
+
|
|
17
|
+
> <CheckoutResponse> cancel_checkout(id, opts)
|
|
18
|
+
|
|
19
|
+
Cancel Payment Link
|
|
20
|
+
|
|
21
|
+
### Examples
|
|
22
|
+
|
|
23
|
+
```ruby
|
|
24
|
+
require 'time'
|
|
25
|
+
require 'digital_femsa'
|
|
26
|
+
# setup authorization
|
|
27
|
+
DigitalFemsa.configure do |config|
|
|
28
|
+
# Configure Bearer authorization: bearerAuth
|
|
29
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
30
|
+
end
|
|
31
|
+
|
|
32
|
+
api_instance = DigitalFemsa::PaymentLinkApi.new
|
|
33
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
34
|
+
opts = {
|
|
35
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
36
|
+
x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
|
|
37
|
+
}
|
|
38
|
+
|
|
39
|
+
begin
|
|
40
|
+
# Cancel Payment Link
|
|
41
|
+
result = api_instance.cancel_checkout(id, opts)
|
|
42
|
+
p result
|
|
43
|
+
rescue DigitalFemsa::ApiError => e
|
|
44
|
+
puts "Error when calling PaymentLinkApi->cancel_checkout: #{e}"
|
|
45
|
+
end
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
#### Using the cancel_checkout_with_http_info variant
|
|
49
|
+
|
|
50
|
+
This returns an Array which contains the response data, status code and headers.
|
|
51
|
+
|
|
52
|
+
> <Array(<CheckoutResponse>, Integer, Hash)> cancel_checkout_with_http_info(id, opts)
|
|
53
|
+
|
|
54
|
+
```ruby
|
|
55
|
+
begin
|
|
56
|
+
# Cancel Payment Link
|
|
57
|
+
data, status_code, headers = api_instance.cancel_checkout_with_http_info(id, opts)
|
|
58
|
+
p status_code # => 2xx
|
|
59
|
+
p headers # => { ... }
|
|
60
|
+
p data # => <CheckoutResponse>
|
|
61
|
+
rescue DigitalFemsa::ApiError => e
|
|
62
|
+
puts "Error when calling PaymentLinkApi->cancel_checkout_with_http_info: #{e}"
|
|
63
|
+
end
|
|
64
|
+
```
|
|
65
|
+
|
|
66
|
+
### Parameters
|
|
67
|
+
|
|
68
|
+
| Name | Type | Description | Notes |
|
|
69
|
+
| ---- | ---- | ----------- | ----- |
|
|
70
|
+
| **id** | **String** | Identifier of the resource | |
|
|
71
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
72
|
+
| **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
|
|
73
|
+
|
|
74
|
+
### Return type
|
|
75
|
+
|
|
76
|
+
[**CheckoutResponse**](CheckoutResponse.md)
|
|
77
|
+
|
|
78
|
+
### Authorization
|
|
79
|
+
|
|
80
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
81
|
+
|
|
82
|
+
### HTTP request headers
|
|
83
|
+
|
|
84
|
+
- **Content-Type**: Not defined
|
|
85
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
## create_checkout
|
|
89
|
+
|
|
90
|
+
> <CheckoutResponse> create_checkout(checkout, opts)
|
|
91
|
+
|
|
92
|
+
Create Unique Payment Link
|
|
93
|
+
|
|
94
|
+
### Examples
|
|
95
|
+
|
|
96
|
+
```ruby
|
|
97
|
+
require 'time'
|
|
98
|
+
require 'digital_femsa'
|
|
99
|
+
# setup authorization
|
|
100
|
+
DigitalFemsa.configure do |config|
|
|
101
|
+
# Configure Bearer authorization: bearerAuth
|
|
102
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
103
|
+
end
|
|
104
|
+
|
|
105
|
+
api_instance = DigitalFemsa::PaymentLinkApi.new
|
|
106
|
+
checkout = DigitalFemsa::Checkout.new({allowed_payment_methods: ["cash"], expires_at: 1680397724, name: 'Payment Link Name 1594138857', order_template: DigitalFemsa::CheckoutOrderTemplate.new({currency: 'MXN', line_items: [DigitalFemsa::Product.new({name: 'Box of Cohiba S1s', quantity: 1, unit_price: 20000})]}), recurrent: false, type: 'PaymentLink'}) # Checkout | requested field for checkout
|
|
107
|
+
opts = {
|
|
108
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
109
|
+
x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
|
|
110
|
+
}
|
|
111
|
+
|
|
112
|
+
begin
|
|
113
|
+
# Create Unique Payment Link
|
|
114
|
+
result = api_instance.create_checkout(checkout, opts)
|
|
115
|
+
p result
|
|
116
|
+
rescue DigitalFemsa::ApiError => e
|
|
117
|
+
puts "Error when calling PaymentLinkApi->create_checkout: #{e}"
|
|
118
|
+
end
|
|
119
|
+
```
|
|
120
|
+
|
|
121
|
+
#### Using the create_checkout_with_http_info variant
|
|
122
|
+
|
|
123
|
+
This returns an Array which contains the response data, status code and headers.
|
|
124
|
+
|
|
125
|
+
> <Array(<CheckoutResponse>, Integer, Hash)> create_checkout_with_http_info(checkout, opts)
|
|
126
|
+
|
|
127
|
+
```ruby
|
|
128
|
+
begin
|
|
129
|
+
# Create Unique Payment Link
|
|
130
|
+
data, status_code, headers = api_instance.create_checkout_with_http_info(checkout, opts)
|
|
131
|
+
p status_code # => 2xx
|
|
132
|
+
p headers # => { ... }
|
|
133
|
+
p data # => <CheckoutResponse>
|
|
134
|
+
rescue DigitalFemsa::ApiError => e
|
|
135
|
+
puts "Error when calling PaymentLinkApi->create_checkout_with_http_info: #{e}"
|
|
136
|
+
end
|
|
137
|
+
```
|
|
138
|
+
|
|
139
|
+
### Parameters
|
|
140
|
+
|
|
141
|
+
| Name | Type | Description | Notes |
|
|
142
|
+
| ---- | ---- | ----------- | ----- |
|
|
143
|
+
| **checkout** | [**Checkout**](Checkout.md) | requested field for checkout | |
|
|
144
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
145
|
+
| **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
|
|
146
|
+
|
|
147
|
+
### Return type
|
|
148
|
+
|
|
149
|
+
[**CheckoutResponse**](CheckoutResponse.md)
|
|
150
|
+
|
|
151
|
+
### Authorization
|
|
152
|
+
|
|
153
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
154
|
+
|
|
155
|
+
### HTTP request headers
|
|
156
|
+
|
|
157
|
+
- **Content-Type**: application/json
|
|
158
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
## email_checkout
|
|
162
|
+
|
|
163
|
+
> <CheckoutResponse> email_checkout(id, email_checkout_request, opts)
|
|
164
|
+
|
|
165
|
+
Send an email
|
|
166
|
+
|
|
167
|
+
### Examples
|
|
168
|
+
|
|
169
|
+
```ruby
|
|
170
|
+
require 'time'
|
|
171
|
+
require 'digital_femsa'
|
|
172
|
+
# setup authorization
|
|
173
|
+
DigitalFemsa.configure do |config|
|
|
174
|
+
# Configure Bearer authorization: bearerAuth
|
|
175
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
176
|
+
end
|
|
177
|
+
|
|
178
|
+
api_instance = DigitalFemsa::PaymentLinkApi.new
|
|
179
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
180
|
+
email_checkout_request = DigitalFemsa::EmailCheckoutRequest.new({email: 'example@femsa.com'}) # EmailCheckoutRequest | requested field for sms checkout
|
|
181
|
+
opts = {
|
|
182
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
183
|
+
x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
|
|
184
|
+
}
|
|
185
|
+
|
|
186
|
+
begin
|
|
187
|
+
# Send an email
|
|
188
|
+
result = api_instance.email_checkout(id, email_checkout_request, opts)
|
|
189
|
+
p result
|
|
190
|
+
rescue DigitalFemsa::ApiError => e
|
|
191
|
+
puts "Error when calling PaymentLinkApi->email_checkout: #{e}"
|
|
192
|
+
end
|
|
193
|
+
```
|
|
194
|
+
|
|
195
|
+
#### Using the email_checkout_with_http_info variant
|
|
196
|
+
|
|
197
|
+
This returns an Array which contains the response data, status code and headers.
|
|
198
|
+
|
|
199
|
+
> <Array(<CheckoutResponse>, Integer, Hash)> email_checkout_with_http_info(id, email_checkout_request, opts)
|
|
200
|
+
|
|
201
|
+
```ruby
|
|
202
|
+
begin
|
|
203
|
+
# Send an email
|
|
204
|
+
data, status_code, headers = api_instance.email_checkout_with_http_info(id, email_checkout_request, opts)
|
|
205
|
+
p status_code # => 2xx
|
|
206
|
+
p headers # => { ... }
|
|
207
|
+
p data # => <CheckoutResponse>
|
|
208
|
+
rescue DigitalFemsa::ApiError => e
|
|
209
|
+
puts "Error when calling PaymentLinkApi->email_checkout_with_http_info: #{e}"
|
|
210
|
+
end
|
|
211
|
+
```
|
|
212
|
+
|
|
213
|
+
### Parameters
|
|
214
|
+
|
|
215
|
+
| Name | Type | Description | Notes |
|
|
216
|
+
| ---- | ---- | ----------- | ----- |
|
|
217
|
+
| **id** | **String** | Identifier of the resource | |
|
|
218
|
+
| **email_checkout_request** | [**EmailCheckoutRequest**](EmailCheckoutRequest.md) | requested field for sms checkout | |
|
|
219
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
220
|
+
| **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
|
|
221
|
+
|
|
222
|
+
### Return type
|
|
223
|
+
|
|
224
|
+
[**CheckoutResponse**](CheckoutResponse.md)
|
|
225
|
+
|
|
226
|
+
### Authorization
|
|
227
|
+
|
|
228
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
229
|
+
|
|
230
|
+
### HTTP request headers
|
|
231
|
+
|
|
232
|
+
- **Content-Type**: application/json
|
|
233
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
## get_checkout
|
|
237
|
+
|
|
238
|
+
> <CheckoutResponse> get_checkout(id, opts)
|
|
239
|
+
|
|
240
|
+
Get a payment link by ID
|
|
241
|
+
|
|
242
|
+
### Examples
|
|
243
|
+
|
|
244
|
+
```ruby
|
|
245
|
+
require 'time'
|
|
246
|
+
require 'digital_femsa'
|
|
247
|
+
# setup authorization
|
|
248
|
+
DigitalFemsa.configure do |config|
|
|
249
|
+
# Configure Bearer authorization: bearerAuth
|
|
250
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
251
|
+
end
|
|
252
|
+
|
|
253
|
+
api_instance = DigitalFemsa::PaymentLinkApi.new
|
|
254
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
255
|
+
opts = {
|
|
256
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
257
|
+
x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
|
|
258
|
+
}
|
|
259
|
+
|
|
260
|
+
begin
|
|
261
|
+
# Get a payment link by ID
|
|
262
|
+
result = api_instance.get_checkout(id, opts)
|
|
263
|
+
p result
|
|
264
|
+
rescue DigitalFemsa::ApiError => e
|
|
265
|
+
puts "Error when calling PaymentLinkApi->get_checkout: #{e}"
|
|
266
|
+
end
|
|
267
|
+
```
|
|
268
|
+
|
|
269
|
+
#### Using the get_checkout_with_http_info variant
|
|
270
|
+
|
|
271
|
+
This returns an Array which contains the response data, status code and headers.
|
|
272
|
+
|
|
273
|
+
> <Array(<CheckoutResponse>, Integer, Hash)> get_checkout_with_http_info(id, opts)
|
|
274
|
+
|
|
275
|
+
```ruby
|
|
276
|
+
begin
|
|
277
|
+
# Get a payment link by ID
|
|
278
|
+
data, status_code, headers = api_instance.get_checkout_with_http_info(id, opts)
|
|
279
|
+
p status_code # => 2xx
|
|
280
|
+
p headers # => { ... }
|
|
281
|
+
p data # => <CheckoutResponse>
|
|
282
|
+
rescue DigitalFemsa::ApiError => e
|
|
283
|
+
puts "Error when calling PaymentLinkApi->get_checkout_with_http_info: #{e}"
|
|
284
|
+
end
|
|
285
|
+
```
|
|
286
|
+
|
|
287
|
+
### Parameters
|
|
288
|
+
|
|
289
|
+
| Name | Type | Description | Notes |
|
|
290
|
+
| ---- | ---- | ----------- | ----- |
|
|
291
|
+
| **id** | **String** | Identifier of the resource | |
|
|
292
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
293
|
+
| **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
|
|
294
|
+
|
|
295
|
+
### Return type
|
|
296
|
+
|
|
297
|
+
[**CheckoutResponse**](CheckoutResponse.md)
|
|
298
|
+
|
|
299
|
+
### Authorization
|
|
300
|
+
|
|
301
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
302
|
+
|
|
303
|
+
### HTTP request headers
|
|
304
|
+
|
|
305
|
+
- **Content-Type**: Not defined
|
|
306
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
## get_checkouts
|
|
310
|
+
|
|
311
|
+
> <CheckoutsResponse> get_checkouts(opts)
|
|
312
|
+
|
|
313
|
+
Get a list of payment links
|
|
314
|
+
|
|
315
|
+
Returns a list of links generated by the merchant
|
|
316
|
+
|
|
317
|
+
### Examples
|
|
318
|
+
|
|
319
|
+
```ruby
|
|
320
|
+
require 'time'
|
|
321
|
+
require 'digital_femsa'
|
|
322
|
+
# setup authorization
|
|
323
|
+
DigitalFemsa.configure do |config|
|
|
324
|
+
# Configure Bearer authorization: bearerAuth
|
|
325
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
326
|
+
end
|
|
327
|
+
|
|
328
|
+
api_instance = DigitalFemsa::PaymentLinkApi.new
|
|
329
|
+
opts = {
|
|
330
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
331
|
+
x_child_company_id: '6441b6376b60c3a638da80af', # String | In the case of a holding company, the company id of the child company to which will process the request.
|
|
332
|
+
limit: 56, # Integer | The numbers of items to return, the maximum value is 250
|
|
333
|
+
search: 'search_example', # String | General order search, e.g. by mail, reference etc.
|
|
334
|
+
_next: '_next_example', # String | next page
|
|
335
|
+
previous: 'previous_example' # String | previous page
|
|
336
|
+
}
|
|
337
|
+
|
|
338
|
+
begin
|
|
339
|
+
# Get a list of payment links
|
|
340
|
+
result = api_instance.get_checkouts(opts)
|
|
341
|
+
p result
|
|
342
|
+
rescue DigitalFemsa::ApiError => e
|
|
343
|
+
puts "Error when calling PaymentLinkApi->get_checkouts: #{e}"
|
|
344
|
+
end
|
|
345
|
+
```
|
|
346
|
+
|
|
347
|
+
#### Using the get_checkouts_with_http_info variant
|
|
348
|
+
|
|
349
|
+
This returns an Array which contains the response data, status code and headers.
|
|
350
|
+
|
|
351
|
+
> <Array(<CheckoutsResponse>, Integer, Hash)> get_checkouts_with_http_info(opts)
|
|
352
|
+
|
|
353
|
+
```ruby
|
|
354
|
+
begin
|
|
355
|
+
# Get a list of payment links
|
|
356
|
+
data, status_code, headers = api_instance.get_checkouts_with_http_info(opts)
|
|
357
|
+
p status_code # => 2xx
|
|
358
|
+
p headers # => { ... }
|
|
359
|
+
p data # => <CheckoutsResponse>
|
|
360
|
+
rescue DigitalFemsa::ApiError => e
|
|
361
|
+
puts "Error when calling PaymentLinkApi->get_checkouts_with_http_info: #{e}"
|
|
362
|
+
end
|
|
363
|
+
```
|
|
364
|
+
|
|
365
|
+
### Parameters
|
|
366
|
+
|
|
367
|
+
| Name | Type | Description | Notes |
|
|
368
|
+
| ---- | ---- | ----------- | ----- |
|
|
369
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
370
|
+
| **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
|
|
371
|
+
| **limit** | **Integer** | The numbers of items to return, the maximum value is 250 | [optional][default to 20] |
|
|
372
|
+
| **search** | **String** | General order search, e.g. by mail, reference etc. | [optional] |
|
|
373
|
+
| **_next** | **String** | next page | [optional] |
|
|
374
|
+
| **previous** | **String** | previous page | [optional] |
|
|
375
|
+
|
|
376
|
+
### Return type
|
|
377
|
+
|
|
378
|
+
[**CheckoutsResponse**](CheckoutsResponse.md)
|
|
379
|
+
|
|
380
|
+
### Authorization
|
|
381
|
+
|
|
382
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
383
|
+
|
|
384
|
+
### HTTP request headers
|
|
385
|
+
|
|
386
|
+
- **Content-Type**: Not defined
|
|
387
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
## sms_checkout
|
|
391
|
+
|
|
392
|
+
> <CheckoutResponse> sms_checkout(id, sms_checkout_request, opts)
|
|
393
|
+
|
|
394
|
+
Send an sms
|
|
395
|
+
|
|
396
|
+
### Examples
|
|
397
|
+
|
|
398
|
+
```ruby
|
|
399
|
+
require 'time'
|
|
400
|
+
require 'digital_femsa'
|
|
401
|
+
# setup authorization
|
|
402
|
+
DigitalFemsa.configure do |config|
|
|
403
|
+
# Configure Bearer authorization: bearerAuth
|
|
404
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
|
405
|
+
end
|
|
406
|
+
|
|
407
|
+
api_instance = DigitalFemsa::PaymentLinkApi.new
|
|
408
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
|
409
|
+
sms_checkout_request = DigitalFemsa::SmsCheckoutRequest.new({phonenumber: '5566982090'}) # SmsCheckoutRequest | requested field for sms checkout
|
|
410
|
+
opts = {
|
|
411
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
|
412
|
+
x_child_company_id: '6441b6376b60c3a638da80af' # String | In the case of a holding company, the company id of the child company to which will process the request.
|
|
413
|
+
}
|
|
414
|
+
|
|
415
|
+
begin
|
|
416
|
+
# Send an sms
|
|
417
|
+
result = api_instance.sms_checkout(id, sms_checkout_request, opts)
|
|
418
|
+
p result
|
|
419
|
+
rescue DigitalFemsa::ApiError => e
|
|
420
|
+
puts "Error when calling PaymentLinkApi->sms_checkout: #{e}"
|
|
421
|
+
end
|
|
422
|
+
```
|
|
423
|
+
|
|
424
|
+
#### Using the sms_checkout_with_http_info variant
|
|
425
|
+
|
|
426
|
+
This returns an Array which contains the response data, status code and headers.
|
|
427
|
+
|
|
428
|
+
> <Array(<CheckoutResponse>, Integer, Hash)> sms_checkout_with_http_info(id, sms_checkout_request, opts)
|
|
429
|
+
|
|
430
|
+
```ruby
|
|
431
|
+
begin
|
|
432
|
+
# Send an sms
|
|
433
|
+
data, status_code, headers = api_instance.sms_checkout_with_http_info(id, sms_checkout_request, opts)
|
|
434
|
+
p status_code # => 2xx
|
|
435
|
+
p headers # => { ... }
|
|
436
|
+
p data # => <CheckoutResponse>
|
|
437
|
+
rescue DigitalFemsa::ApiError => e
|
|
438
|
+
puts "Error when calling PaymentLinkApi->sms_checkout_with_http_info: #{e}"
|
|
439
|
+
end
|
|
440
|
+
```
|
|
441
|
+
|
|
442
|
+
### Parameters
|
|
443
|
+
|
|
444
|
+
| Name | Type | Description | Notes |
|
|
445
|
+
| ---- | ---- | ----------- | ----- |
|
|
446
|
+
| **id** | **String** | Identifier of the resource | |
|
|
447
|
+
| **sms_checkout_request** | [**SmsCheckoutRequest**](SmsCheckoutRequest.md) | requested field for sms checkout | |
|
|
448
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
|
449
|
+
| **x_child_company_id** | **String** | In the case of a holding company, the company id of the child company to which will process the request. | [optional] |
|
|
450
|
+
|
|
451
|
+
### Return type
|
|
452
|
+
|
|
453
|
+
[**CheckoutResponse**](CheckoutResponse.md)
|
|
454
|
+
|
|
455
|
+
### Authorization
|
|
456
|
+
|
|
457
|
+
[bearerAuth](../README.md#bearerAuth)
|
|
458
|
+
|
|
459
|
+
### HTTP request headers
|
|
460
|
+
|
|
461
|
+
- **Content-Type**: application/json
|
|
462
|
+
- **Accept**: application/vnd.app-v2.1.0+json
|
|
463
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DigitalFemsa::PaymentMethod
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | | [optional] |
|
|
8
|
+
| **object** | **String** | | |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'digital_femsa'
|
|
14
|
+
|
|
15
|
+
instance = DigitalFemsa::PaymentMethod.new(
|
|
16
|
+
type: null,
|
|
17
|
+
object: payment_source
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# DigitalFemsa::PaymentMethodCash
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | | [optional] |
|
|
8
|
+
| **object** | **String** | | |
|
|
9
|
+
| **auth_code** | **Integer** | | [optional] |
|
|
10
|
+
| **cashier_id** | **String** | | [optional] |
|
|
11
|
+
| **reference** | **String** | | [optional] |
|
|
12
|
+
| **barcode_url** | **String** | | [optional] |
|
|
13
|
+
| **expires_at** | **Integer** | | [optional] |
|
|
14
|
+
| **service_name** | **String** | | [optional] |
|
|
15
|
+
| **store** | **String** | | [optional] |
|
|
16
|
+
| **store_name** | **String** | | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'digital_femsa'
|
|
22
|
+
|
|
23
|
+
instance = DigitalFemsa::PaymentMethodCash.new(
|
|
24
|
+
type: null,
|
|
25
|
+
object: payment_source,
|
|
26
|
+
auth_code: 542563,
|
|
27
|
+
cashier_id: OINM01010,
|
|
28
|
+
reference: 93000262276908,
|
|
29
|
+
barcode_url: https://pt-common-s3-stg.s3.amazonaws.com/644ebf80f2243197aad6cd8810375b905b613dbe.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA3UN6375MP4SLLCWV%2F20230203%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230203T215750Z&X-Amz-Expires=604800&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEH4aCXVzLWVhc3QtMSJGMEQCICd79cu7DYu%2F4%2B3HnVVswydgU9yHcE9kmQIIk2TLoZJrAiBVZ0HxVSeboK5lhdQSqADjwQF62XX35jhC%2F2riB0M8uCqQBAj2%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAIaDDc5OTgwMTA4MTY4OCIMXWZds9ZI5hzUdbeGKuQDFreMyeWnWWPqDuGZ2%2BHk6usCr%2Fl096%2FNJh9xtf8htLu56K%2FhWUTx%2BjiqFWM2O%2FF5zTS%2BIV6TqkLDZ%2BQ5Jo1miQrRmR57YDz6uP2Yd1mNZ1ouq5ipnNjUuu5UWCCBAmqyZQsrVmeMQpSV2IB%2BTERCCcW2SukFEYU%2F20%2Fzy5orsoZ8DxOW460IymR3cWBk5u3Xh2cV6Y1RdPEwDEThhqYEF5w%2ByKbLENloMsI%2FUm6sG5PPrO3yQOAP9aK2muLJs9lXQRU%2FL%2FSsmS4FKSUFOqlN6YU%2Bi2Y%2FyGIKAJT2VDkngvz5Sl%2Fadj0j%2BPKftVRV5FcEhySB6Rl%2BSkPN7kVQMJp6pS8hMJ6JCyEA%2BA3eWYdIfKgQhWVXAR4oCBfJ62DH8FU3a7WfSjjpTwfVkiReWen3GGCYfUWETTVKp46MKnJ9PG0CD3KzxKV8VfmEGc5krK%2FI%2F%2BDV2wtSa%2F9qf1%2BK1YYJIK9qZGb25ljUiGhTB4T%2BMUOSQFjetiWUoOJc5Q3Jz%2FXJbiTAMTST39MhdbCgiMgfrc8OGKN5DOVbex33Z7dn0xf%2FOCkSqurhLaG08efKQBdhLNS0RlE9hbg9yZ2ywwtQIF39fI6A7eeH0T11a5HMlvm51u4rAffPHRuEJfwJoIuj%2F2s3QzDg7%2FWeBjqmAbnPOlGfysjrDdvHyG7HVnaX02kdG%2BI3Q4PFOO4Mjaa3ocpjcfPT70%2BZ5a%2FSv5vP0jDLGrLToeM9%2BAUlNepptICRu23a1tLGW4ri0twPA%2FZ4JDTtUUUgdblyG8bKpcUTNp4oOsdmLLBz3FVyr4c2xQbDZSu2zYOtoOxB18W0AC6kIbsMWVU55Bf0mBhPeBWxGrtM4Kw1SgHHlt%2F8vetQi2OwtUcg08c%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=d06dfa41550003359f2aabc8006063a80dfd806a13a54d244024946a76aa9abc,
|
|
30
|
+
expires_at: 0,
|
|
31
|
+
service_name: OxxoPay,
|
|
32
|
+
store: 10MON50EDI,
|
|
33
|
+
store_name: OXXO
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# DigitalFemsa::PaymentMethodCashRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | Type of payment method | |
|
|
8
|
+
| **expires_at** | **Integer** | | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'digital_femsa'
|
|
14
|
+
|
|
15
|
+
instance = DigitalFemsa::PaymentMethodCashRequest.new(
|
|
16
|
+
type: cash,
|
|
17
|
+
expires_at: 1553273553
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
# DigitalFemsa::PaymentMethodCashResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | | |
|
|
8
|
+
| **id** | **String** | | |
|
|
9
|
+
| **object** | **String** | | |
|
|
10
|
+
| **created_at** | **Integer** | | |
|
|
11
|
+
| **parent_id** | **String** | | [optional] |
|
|
12
|
+
| **reference** | **String** | | [optional] |
|
|
13
|
+
| **barcode** | **String** | | [optional] |
|
|
14
|
+
| **barcode_url** | **String** | | [optional] |
|
|
15
|
+
| **expires_at** | **Integer** | | [optional] |
|
|
16
|
+
| **provider** | **String** | | [optional] |
|
|
17
|
+
|
|
18
|
+
## Example
|
|
19
|
+
|
|
20
|
+
```ruby
|
|
21
|
+
require 'digital_femsa'
|
|
22
|
+
|
|
23
|
+
instance = DigitalFemsa::PaymentMethodCashResponse.new(
|
|
24
|
+
type: null,
|
|
25
|
+
id: src_2s8K1B3PBKDontpi9,
|
|
26
|
+
object: payment_source,
|
|
27
|
+
created_at: 1675715413,
|
|
28
|
+
parent_id: cus_2s8K1B3PBKDontpi8,
|
|
29
|
+
reference: 93000262276908,
|
|
30
|
+
barcode: 93000262276908,
|
|
31
|
+
barcode_url: https://pt-common-s3-stg.s3.amazonaws.com/644ebf80f2243197aad6cd8810375b905b613dbe.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIA3UN6375MP4SLLCWV%2F20230203%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230203T215750Z&X-Amz-Expires=604800&X-Amz-Security-Token=IQoJb3JpZ2luX2VjEH4aCXVzLWVhc3QtMSJGMEQCICd79cu7DYu%2F4%2B3HnVVswydgU9yHcE9kmQIIk2TLoZJrAiBVZ0HxVSeboK5lhdQSqADjwQF62XX35jhC%2F2riB0M8uCqQBAj2%2F%2F%2F%2F%2F%2F%2F%2F%2F%2F8BEAIaDDc5OTgwMTA4MTY4OCIMXWZds9ZI5hzUdbeGKuQDFreMyeWnWWPqDuGZ2%2BHk6usCr%2Fl096%2FNJh9xtf8htLu56K%2FhWUTx%2BjiqFWM2O%2FF5zTS%2BIV6TqkLDZ%2BQ5Jo1miQrRmR57YDz6uP2Yd1mNZ1ouq5ipnNjUuu5UWCCBAmqyZQsrVmeMQpSV2IB%2BTERCCcW2SukFEYU%2F20%2Fzy5orsoZ8DxOW460IymR3cWBk5u3Xh2cV6Y1RdPEwDEThhqYEF5w%2ByKbLENloMsI%2FUm6sG5PPrO3yQOAP9aK2muLJs9lXQRU%2FL%2FSsmS4FKSUFOqlN6YU%2Bi2Y%2FyGIKAJT2VDkngvz5Sl%2Fadj0j%2BPKftVRV5FcEhySB6Rl%2BSkPN7kVQMJp6pS8hMJ6JCyEA%2BA3eWYdIfKgQhWVXAR4oCBfJ62DH8FU3a7WfSjjpTwfVkiReWen3GGCYfUWETTVKp46MKnJ9PG0CD3KzxKV8VfmEGc5krK%2FI%2F%2BDV2wtSa%2F9qf1%2BK1YYJIK9qZGb25ljUiGhTB4T%2BMUOSQFjetiWUoOJc5Q3Jz%2FXJbiTAMTST39MhdbCgiMgfrc8OGKN5DOVbex33Z7dn0xf%2FOCkSqurhLaG08efKQBdhLNS0RlE9hbg9yZ2ywwtQIF39fI6A7eeH0T11a5HMlvm51u4rAffPHRuEJfwJoIuj%2F2s3QzDg7%2FWeBjqmAbnPOlGfysjrDdvHyG7HVnaX02kdG%2BI3Q4PFOO4Mjaa3ocpjcfPT70%2BZ5a%2FSv5vP0jDLGrLToeM9%2BAUlNepptICRu23a1tLGW4ri0twPA%2FZ4JDTtUUUgdblyG8bKpcUTNp4oOsdmLLBz3FVyr4c2xQbDZSu2zYOtoOxB18W0AC6kIbsMWVU55Bf0mBhPeBWxGrtM4Kw1SgHHlt%2F8vetQi2OwtUcg08c%3D&X-Amz-SignedHeaders=host&X-Amz-Signature=d06dfa41550003359f2aabc8006063a80dfd806a13a54d244024946a76aa9abc,
|
|
32
|
+
expires_at: 0,
|
|
33
|
+
provider: Oxxo
|
|
34
|
+
)
|
|
35
|
+
```
|
|
36
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# DigitalFemsa::PaymentMethodResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **type** | **String** | | |
|
|
8
|
+
| **id** | **String** | | |
|
|
9
|
+
| **object** | **String** | | |
|
|
10
|
+
| **created_at** | **Integer** | | |
|
|
11
|
+
| **parent_id** | **String** | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'digital_femsa'
|
|
17
|
+
|
|
18
|
+
instance = DigitalFemsa::PaymentMethodResponse.new(
|
|
19
|
+
type: null,
|
|
20
|
+
id: src_2s8K1B3PBKDontpi9,
|
|
21
|
+
object: payment_source,
|
|
22
|
+
created_at: 1675715413,
|
|
23
|
+
parent_id: cus_2s8K1B3PBKDontpi8
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|