conekta 6.0.3 → 6.0.5
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/README.md +11 -5
- data/VERSION +1 -1
- data/config-ruby.json +1 -1
- data/docs/ChargeRequest.md +1 -1
- data/docs/ChargeRequestPaymentMethod.md +39 -18
- data/docs/ChargeResponse.md +6 -6
- data/docs/ChargesApi.md +79 -1
- data/docs/ChargesDataResponse.md +6 -6
- data/docs/ChargesOrderResponse.md +22 -0
- data/docs/ChargesOrderResponseAllOfData.md +52 -0
- data/docs/Checkout.md +2 -0
- data/docs/CheckoutRequest.md +2 -0
- data/docs/CreateCustomerPaymentMethodsRequest.md +4 -4
- data/docs/Customer.md +4 -0
- data/docs/CustomerPaymentMethodsRequest.md +4 -4
- data/docs/CustomerResponse.md +4 -0
- data/docs/OrderRefundRequest.md +2 -2
- data/docs/OrderRequest.md +1 -1
- data/docs/OrderResponseCheckout.md +2 -0
- data/docs/PaymentMethodBankTransfer.md +3 -1
- data/docs/PaymentMethodCard.md +12 -10
- data/docs/PaymentMethodCardRequest.md +12 -2
- data/docs/PaymentMethodCash.md +7 -1
- data/docs/PaymentMethodGeneralRequest.md +32 -0
- data/docs/PaymentMethodTokenRequest.md +20 -0
- data/docs/PaymentMethodsApi.md +1 -1
- data/docs/PayoutOrdersApi.md +74 -0
- data/docs/SubscriptionResponse.md +2 -0
- data/docs/UpdateCustomer.md +4 -0
- data/lib/conekta/api/charges_api.rb +84 -0
- data/lib/conekta/api/payout_orders_api.rb +70 -0
- data/lib/conekta/models/charge_request.rb +1 -0
- data/lib/conekta/models/charge_request_payment_method.rb +74 -239
- data/lib/conekta/models/charge_response.rb +4 -0
- data/lib/conekta/models/charges_data_response.rb +4 -0
- data/lib/conekta/models/charges_order_response.rb +258 -0
- data/lib/conekta/models/charges_order_response_all_of_data.rb +382 -0
- data/lib/conekta/models/checkout.rb +11 -1
- data/lib/conekta/models/checkout_request.rb +11 -1
- data/lib/conekta/models/create_customer_payment_methods_request.rb +2 -2
- data/lib/conekta/models/customer.rb +21 -1
- data/lib/conekta/models/customer_payment_methods_request.rb +2 -2
- data/lib/conekta/models/customer_response.rb +21 -1
- data/lib/conekta/models/order_refund_request.rb +2 -1
- data/lib/conekta/models/order_request.rb +1 -1
- data/lib/conekta/models/order_response_checkout.rb +12 -1
- data/lib/conekta/models/payment_method_bank_transfer.rb +14 -5
- data/lib/conekta/models/payment_method_card.rb +22 -4
- data/lib/conekta/models/payment_method_card_request.rb +174 -12
- data/lib/conekta/models/payment_method_cash.rb +33 -4
- data/lib/conekta/models/payment_method_general_request.rb +291 -0
- data/lib/conekta/models/payment_method_token_request.rb +246 -0
- data/lib/conekta/models/subscription_response.rb +11 -1
- data/lib/conekta/models/update_customer.rb +21 -1
- data/lib/conekta/version.rb +1 -1
- data/lib/conekta.rb +4 -0
- data/spec/api/charges_api_spec.rb +18 -10
- data/spec/api/customers_api_spec.rb +10 -4
- data/spec/api/orders_api_spec.rb +6 -6
- metadata +32 -24
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 1e98acb32c3e76886c5a5679dffc113c74c61585c0ee400ab95fcc81e1cb4499
|
4
|
+
data.tar.gz: 879d3c2bf03856ae3998efc4860d9bbf38bb0aceadfe1edee35789b583cf1a12
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 631b7f455552dcb3da143d8ba624ae61d4f7496995ff084a011f2a21c9193acc09afc80588fe2de3d56963b0352598c4d948f84b111e4f392db36180898bf4df
|
7
|
+
data.tar.gz: 7c881ad3460ccb1e832ddb31489ece2069bf3d3b619e5215e738ca3ac81c985bf8efe8d3ef8be99596708ef0e107b97149d26b768b9737f4042bb78d1745859d
|
data/README.md
CHANGED
@@ -7,8 +7,8 @@ Conekta sdk
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.1.0
|
10
|
-
- Package version: 6.0.
|
11
|
-
- Build date:
|
10
|
+
- Package version: 6.0.5
|
11
|
+
- Build date: 2025-02-12T18:24:23.186518636Z[Etc/UTC]
|
12
12
|
- Generator version: 7.5.0
|
13
13
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
14
14
|
For more information, please visit [https://github.com/conekta/openapi/issues](https://github.com/conekta/openapi/issues)
|
@@ -26,16 +26,16 @@ gem build conekta.gemspec
|
|
26
26
|
Then either install the gem locally:
|
27
27
|
|
28
28
|
```shell
|
29
|
-
gem install ./conekta-6.0.
|
29
|
+
gem install ./conekta-6.0.5.gem
|
30
30
|
```
|
31
31
|
|
32
|
-
(for development, run `gem install --dev ./conekta-6.0.
|
32
|
+
(for development, run `gem install --dev ./conekta-6.0.5.gem` to install the development dependencies)
|
33
33
|
|
34
34
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
35
35
|
|
36
36
|
Finally add this to the Gemfile:
|
37
37
|
|
38
|
-
gem 'conekta', '~> 6.0.
|
38
|
+
gem 'conekta', '~> 6.0.5'
|
39
39
|
|
40
40
|
### Install from Git
|
41
41
|
|
@@ -105,6 +105,7 @@ Class | Method | HTTP request | Description
|
|
105
105
|
*Conekta::BalancesApi* | [**get_balance**](docs/BalancesApi.md#get_balance) | **GET** /balance | Get a company's balance
|
106
106
|
*Conekta::ChargesApi* | [**get_charges**](docs/ChargesApi.md#get_charges) | **GET** /charges | Get A List of Charges
|
107
107
|
*Conekta::ChargesApi* | [**orders_create_charge**](docs/ChargesApi.md#orders_create_charge) | **POST** /orders/{id}/charges | Create charge
|
108
|
+
*Conekta::ChargesApi* | [**orders_create_charges**](docs/ChargesApi.md#orders_create_charges) | **POST** /orders/{id}/add_charges | Create charges
|
108
109
|
*Conekta::ChargesApi* | [**update_charge**](docs/ChargesApi.md#update_charge) | **PUT** /charges/{id} | Update a charge
|
109
110
|
*Conekta::CompaniesApi* | [**get_companies**](docs/CompaniesApi.md#get_companies) | **GET** /companies | Get List of Companies
|
110
111
|
*Conekta::CompaniesApi* | [**get_company**](docs/CompaniesApi.md#get_company) | **GET** /companies/{id} | Get Company
|
@@ -143,6 +144,7 @@ Class | Method | HTTP request | Description
|
|
143
144
|
*Conekta::PaymentMethodsApi* | [**delete_customer_payment_methods**](docs/PaymentMethodsApi.md#delete_customer_payment_methods) | **DELETE** /customers/{id}/payment_sources/{payment_method_id} | Delete Payment Method
|
144
145
|
*Conekta::PaymentMethodsApi* | [**get_customer_payment_methods**](docs/PaymentMethodsApi.md#get_customer_payment_methods) | **GET** /customers/{id}/payment_sources | Get Payment Methods
|
145
146
|
*Conekta::PaymentMethodsApi* | [**update_customer_payment_methods**](docs/PaymentMethodsApi.md#update_customer_payment_methods) | **PUT** /customers/{id}/payment_sources/{payment_method_id} | Update Payment Method
|
147
|
+
*Conekta::PayoutOrdersApi* | [**cancel_payout_order_by_id**](docs/PayoutOrdersApi.md#cancel_payout_order_by_id) | **PUT** /payout_orders/{id}/cancel | Cancel Payout Order
|
146
148
|
*Conekta::PayoutOrdersApi* | [**create_payout_order**](docs/PayoutOrdersApi.md#create_payout_order) | **POST** /payout_orders | Create payout order
|
147
149
|
*Conekta::PayoutOrdersApi* | [**get_payout_order_by_id**](docs/PayoutOrdersApi.md#get_payout_order_by_id) | **GET** /payout_orders/{id} | Get Payout Order
|
148
150
|
*Conekta::PayoutOrdersApi* | [**get_payout_orders**](docs/PayoutOrdersApi.md#get_payout_orders) | **GET** /payout_orders | Get a list of Payout Orders
|
@@ -209,6 +211,8 @@ Class | Method | HTTP request | Description
|
|
209
211
|
- [Conekta::ChargeResponseRefundsData](docs/ChargeResponseRefundsData.md)
|
210
212
|
- [Conekta::ChargeUpdateRequest](docs/ChargeUpdateRequest.md)
|
211
213
|
- [Conekta::ChargesDataResponse](docs/ChargesDataResponse.md)
|
214
|
+
- [Conekta::ChargesOrderResponse](docs/ChargesOrderResponse.md)
|
215
|
+
- [Conekta::ChargesOrderResponseAllOfData](docs/ChargesOrderResponseAllOfData.md)
|
212
216
|
- [Conekta::Checkout](docs/Checkout.md)
|
213
217
|
- [Conekta::CheckoutOrderTemplate](docs/CheckoutOrderTemplate.md)
|
214
218
|
- [Conekta::CheckoutOrderTemplateCustomerInfo](docs/CheckoutOrderTemplateCustomerInfo.md)
|
@@ -309,9 +313,11 @@ Class | Method | HTTP request | Description
|
|
309
313
|
- [Conekta::PaymentMethodCash](docs/PaymentMethodCash.md)
|
310
314
|
- [Conekta::PaymentMethodCashRequest](docs/PaymentMethodCashRequest.md)
|
311
315
|
- [Conekta::PaymentMethodCashResponse](docs/PaymentMethodCashResponse.md)
|
316
|
+
- [Conekta::PaymentMethodGeneralRequest](docs/PaymentMethodGeneralRequest.md)
|
312
317
|
- [Conekta::PaymentMethodResponse](docs/PaymentMethodResponse.md)
|
313
318
|
- [Conekta::PaymentMethodSpeiRecurrent](docs/PaymentMethodSpeiRecurrent.md)
|
314
319
|
- [Conekta::PaymentMethodSpeiRequest](docs/PaymentMethodSpeiRequest.md)
|
320
|
+
- [Conekta::PaymentMethodTokenRequest](docs/PaymentMethodTokenRequest.md)
|
315
321
|
- [Conekta::Payout](docs/Payout.md)
|
316
322
|
- [Conekta::PayoutMethod](docs/PayoutMethod.md)
|
317
323
|
- [Conekta::PayoutOrder](docs/PayoutOrder.md)
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
6.0.
|
1
|
+
6.0.5
|
data/config-ruby.json
CHANGED
data/docs/ChargeRequest.md
CHANGED
@@ -4,7 +4,7 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **amount** | **Integer** |
|
7
|
+
| **amount** | **Integer** | Amount to be charged in cents | [optional] |
|
8
8
|
| **payment_method** | [**ChargeRequestPaymentMethod**](ChargeRequestPaymentMethod.md) | | |
|
9
9
|
| **reference_id** | **String** | Custom reference to add to the charge | [optional] |
|
10
10
|
|
@@ -1,28 +1,49 @@
|
|
1
1
|
# Conekta::ChargeRequestPaymentMethod
|
2
2
|
|
3
|
-
##
|
3
|
+
## Class instance methods
|
4
4
|
|
5
|
-
|
6
|
-
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **expires_at** | **Integer** | Method expiration date as unix timestamp | [optional] |
|
8
|
-
| **monthly_installments** | **Integer** | How many months without interest to apply, it can be 3, 6, 9, 12 or 18 | [optional] |
|
9
|
-
| **type** | **String** | | |
|
10
|
-
| **token_id** | **String** | | [optional] |
|
11
|
-
| **payment_source_id** | **String** | | [optional] |
|
12
|
-
| **contract_id** | **String** | Optional id sent to indicate the bank contract for recurrent card charges. | [optional] |
|
5
|
+
### `openapi_one_of`
|
13
6
|
|
14
|
-
|
7
|
+
Returns the list of classes defined in oneOf.
|
8
|
+
|
9
|
+
#### Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'conekta'
|
13
|
+
|
14
|
+
Conekta::ChargeRequestPaymentMethod.openapi_one_of
|
15
|
+
# =>
|
16
|
+
# [
|
17
|
+
# :'PaymentMethodCardRequest',
|
18
|
+
# :'PaymentMethodGeneralRequest'
|
19
|
+
# ]
|
20
|
+
```
|
21
|
+
|
22
|
+
### build
|
23
|
+
|
24
|
+
Find the appropriate object from the `openapi_one_of` list and casts the data into it.
|
25
|
+
|
26
|
+
#### Example
|
15
27
|
|
16
28
|
```ruby
|
17
29
|
require 'conekta'
|
18
30
|
|
19
|
-
|
20
|
-
|
21
|
-
|
22
|
-
|
23
|
-
|
24
|
-
payment_source_id: src_2tLkkyfMPh6v7pFry,
|
25
|
-
contract_id: S781317595
|
26
|
-
)
|
31
|
+
Conekta::ChargeRequestPaymentMethod.build(data)
|
32
|
+
# => #<PaymentMethodCardRequest:0x00007fdd4aab02a0>
|
33
|
+
|
34
|
+
Conekta::ChargeRequestPaymentMethod.build(data_that_doesnt_match)
|
35
|
+
# => nil
|
27
36
|
```
|
28
37
|
|
38
|
+
#### Parameters
|
39
|
+
|
40
|
+
| Name | Type | Description |
|
41
|
+
| ---- | ---- | ----------- |
|
42
|
+
| **data** | **Mixed** | data to be matched against the list of oneOf items |
|
43
|
+
|
44
|
+
#### Return type
|
45
|
+
|
46
|
+
- `PaymentMethodCardRequest`
|
47
|
+
- `PaymentMethodGeneralRequest`
|
48
|
+
- `nil` (if no type matches)
|
49
|
+
|
data/docs/ChargeResponse.md
CHANGED
@@ -13,11 +13,11 @@
|
|
13
13
|
| **device_fingerprint** | **String** | | [optional] |
|
14
14
|
| **failure_code** | **String** | | [optional] |
|
15
15
|
| **failure_message** | **String** | | [optional] |
|
16
|
-
| **id** | **String** |
|
17
|
-
| **livemode** | **Boolean** |
|
16
|
+
| **id** | **String** | Charge ID | [optional] |
|
17
|
+
| **livemode** | **Boolean** | Whether the charge was made in live mode or not | [optional] |
|
18
18
|
| **object** | **String** | | [optional] |
|
19
|
-
| **order_id** | **String** |
|
20
|
-
| **paid_at** | **Integer** |
|
19
|
+
| **order_id** | **String** | Order ID | [optional] |
|
20
|
+
| **paid_at** | **Integer** | Payment date | [optional] |
|
21
21
|
| **payment_method** | [**ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) | | [optional] |
|
22
22
|
| **reference_id** | **String** | Reference ID of the charge | [optional] |
|
23
23
|
| **refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) | | [optional] |
|
@@ -39,8 +39,8 @@ instance = Conekta::ChargeResponse.new(
|
|
39
39
|
failure_code: suspected_fraud,
|
40
40
|
failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso.,
|
41
41
|
id: 63efa757cf65380001aec040,
|
42
|
-
livemode:
|
43
|
-
object:
|
42
|
+
livemode: false,
|
43
|
+
object: charge,
|
44
44
|
order_id: ord_2tN73UdUSNrYRPD9r,
|
45
45
|
paid_at: 1676390742,
|
46
46
|
payment_method: null,
|
data/docs/ChargesApi.md
CHANGED
@@ -6,6 +6,7 @@ All URIs are relative to *https://api.conekta.io*
|
|
6
6
|
| ------ | ------------ | ----------- |
|
7
7
|
| [**get_charges**](ChargesApi.md#get_charges) | **GET** /charges | Get A List of Charges |
|
8
8
|
| [**orders_create_charge**](ChargesApi.md#orders_create_charge) | **POST** /orders/{id}/charges | Create charge |
|
9
|
+
| [**orders_create_charges**](ChargesApi.md#orders_create_charges) | **POST** /orders/{id}/add_charges | Create charges |
|
9
10
|
| [**update_charge**](ChargesApi.md#update_charge) | **PUT** /charges/{id} | Update a charge |
|
10
11
|
|
11
12
|
|
@@ -109,7 +110,7 @@ end
|
|
109
110
|
|
110
111
|
api_instance = Conekta::ChargesApi.new
|
111
112
|
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
112
|
-
charge_request = Conekta::ChargeRequest.new({payment_method: Conekta::
|
113
|
+
charge_request = Conekta::ChargeRequest.new({payment_method: Conekta::PaymentMethodCardRequest.new({type: 'card | cash | spei', cvc: '198', exp_month: '12', exp_year: '2025', name: 'John Doe', number: '4242424242424242'})}) # ChargeRequest | requested field for a charge
|
113
114
|
opts = {
|
114
115
|
accept_language: 'es', # String | Use for knowing which language to use
|
115
116
|
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.
|
@@ -165,6 +166,83 @@ end
|
|
165
166
|
- **Accept**: application/vnd.conekta-v2.1.0+json
|
166
167
|
|
167
168
|
|
169
|
+
## orders_create_charges
|
170
|
+
|
171
|
+
> <ChargesOrderResponse> orders_create_charges(id, charge_request, opts)
|
172
|
+
|
173
|
+
Create charges
|
174
|
+
|
175
|
+
Create charges for an existing orden
|
176
|
+
|
177
|
+
### Examples
|
178
|
+
|
179
|
+
```ruby
|
180
|
+
require 'time'
|
181
|
+
require 'conekta'
|
182
|
+
# setup authorization
|
183
|
+
Conekta.configure do |config|
|
184
|
+
# Configure Bearer authorization: bearerAuth
|
185
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
186
|
+
end
|
187
|
+
|
188
|
+
api_instance = Conekta::ChargesApi.new
|
189
|
+
id = '6307a60c41de27127515a575' # String | Identifier of the resource
|
190
|
+
charge_request = Conekta::ChargeRequest.new({payment_method: Conekta::PaymentMethodCardRequest.new({type: 'card | cash | spei', cvc: '198', exp_month: '12', exp_year: '2025', name: 'John Doe', number: '4242424242424242'})}) # ChargeRequest | requested field for a charge
|
191
|
+
opts = {
|
192
|
+
accept_language: 'es', # String | Use for knowing which language to use
|
193
|
+
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.
|
194
|
+
}
|
195
|
+
|
196
|
+
begin
|
197
|
+
# Create charges
|
198
|
+
result = api_instance.orders_create_charges(id, charge_request, opts)
|
199
|
+
p result
|
200
|
+
rescue Conekta::ApiError => e
|
201
|
+
puts "Error when calling ChargesApi->orders_create_charges: #{e}"
|
202
|
+
end
|
203
|
+
```
|
204
|
+
|
205
|
+
#### Using the orders_create_charges_with_http_info variant
|
206
|
+
|
207
|
+
This returns an Array which contains the response data, status code and headers.
|
208
|
+
|
209
|
+
> <Array(<ChargesOrderResponse>, Integer, Hash)> orders_create_charges_with_http_info(id, charge_request, opts)
|
210
|
+
|
211
|
+
```ruby
|
212
|
+
begin
|
213
|
+
# Create charges
|
214
|
+
data, status_code, headers = api_instance.orders_create_charges_with_http_info(id, charge_request, opts)
|
215
|
+
p status_code # => 2xx
|
216
|
+
p headers # => { ... }
|
217
|
+
p data # => <ChargesOrderResponse>
|
218
|
+
rescue Conekta::ApiError => e
|
219
|
+
puts "Error when calling ChargesApi->orders_create_charges_with_http_info: #{e}"
|
220
|
+
end
|
221
|
+
```
|
222
|
+
|
223
|
+
### Parameters
|
224
|
+
|
225
|
+
| Name | Type | Description | Notes |
|
226
|
+
| ---- | ---- | ----------- | ----- |
|
227
|
+
| **id** | **String** | Identifier of the resource | |
|
228
|
+
| **charge_request** | [**ChargeRequest**](ChargeRequest.md) | requested field for a charge | |
|
229
|
+
| **accept_language** | **String** | Use for knowing which language to use | [optional][default to 'es'] |
|
230
|
+
| **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] |
|
231
|
+
|
232
|
+
### Return type
|
233
|
+
|
234
|
+
[**ChargesOrderResponse**](ChargesOrderResponse.md)
|
235
|
+
|
236
|
+
### Authorization
|
237
|
+
|
238
|
+
[bearerAuth](../README.md#bearerAuth)
|
239
|
+
|
240
|
+
### HTTP request headers
|
241
|
+
|
242
|
+
- **Content-Type**: application/json
|
243
|
+
- **Accept**: application/vnd.conekta-v2.1.0+json
|
244
|
+
|
245
|
+
|
168
246
|
## update_charge
|
169
247
|
|
170
248
|
> <ChargeResponse> update_charge(id, charge_update_request, opts)
|
data/docs/ChargesDataResponse.md
CHANGED
@@ -13,11 +13,11 @@
|
|
13
13
|
| **device_fingerprint** | **String** | | [optional] |
|
14
14
|
| **failure_code** | **String** | | [optional] |
|
15
15
|
| **failure_message** | **String** | | [optional] |
|
16
|
-
| **id** | **String** |
|
17
|
-
| **livemode** | **Boolean** |
|
16
|
+
| **id** | **String** | Charge ID | [optional] |
|
17
|
+
| **livemode** | **Boolean** | Whether the charge was made in live mode or not | [optional] |
|
18
18
|
| **object** | **String** | | [optional] |
|
19
|
-
| **order_id** | **String** |
|
20
|
-
| **paid_at** | **Integer** |
|
19
|
+
| **order_id** | **String** | Order ID | [optional] |
|
20
|
+
| **paid_at** | **Integer** | Payment date | [optional] |
|
21
21
|
| **payment_method** | [**ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) | | [optional] |
|
22
22
|
| **reference_id** | **String** | Reference ID of the charge | [optional] |
|
23
23
|
| **refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) | | [optional] |
|
@@ -39,8 +39,8 @@ instance = Conekta::ChargesDataResponse.new(
|
|
39
39
|
failure_code: suspected_fraud,
|
40
40
|
failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso.,
|
41
41
|
id: 63efa757cf65380001aec040,
|
42
|
-
livemode:
|
43
|
-
object:
|
42
|
+
livemode: false,
|
43
|
+
object: charge,
|
44
44
|
order_id: ord_2tN73UdUSNrYRPD9r,
|
45
45
|
paid_at: 1676390742,
|
46
46
|
payment_method: null,
|
@@ -0,0 +1,22 @@
|
|
1
|
+
# Conekta::ChargesOrderResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **has_more** | **Boolean** | Indicates if there are more pages to be requested | |
|
8
|
+
| **object** | **String** | Object type, in this case is list | |
|
9
|
+
| **data** | [**Array<ChargesOrderResponseAllOfData>**](ChargesOrderResponseAllOfData.md) | | [optional] |
|
10
|
+
|
11
|
+
## Example
|
12
|
+
|
13
|
+
```ruby
|
14
|
+
require 'conekta'
|
15
|
+
|
16
|
+
instance = Conekta::ChargesOrderResponse.new(
|
17
|
+
has_more: false,
|
18
|
+
object: list,
|
19
|
+
data: null
|
20
|
+
)
|
21
|
+
```
|
22
|
+
|
@@ -0,0 +1,52 @@
|
|
1
|
+
# Conekta::ChargesOrderResponseAllOfData
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **amount** | **Integer** | | [optional] |
|
8
|
+
| **channel** | [**ChargeResponseChannel**](ChargeResponseChannel.md) | | [optional] |
|
9
|
+
| **created_at** | **Integer** | | [optional] |
|
10
|
+
| **currency** | **String** | | [optional] |
|
11
|
+
| **customer_id** | **String** | | [optional] |
|
12
|
+
| **description** | **String** | | [optional] |
|
13
|
+
| **device_fingerprint** | **String** | | [optional] |
|
14
|
+
| **failure_code** | **String** | | [optional] |
|
15
|
+
| **failure_message** | **String** | | [optional] |
|
16
|
+
| **id** | **String** | Charge ID | [optional] |
|
17
|
+
| **livemode** | **Boolean** | Whether the charge was made in live mode or not | [optional] |
|
18
|
+
| **object** | **String** | | [optional] |
|
19
|
+
| **order_id** | **String** | Order ID | [optional] |
|
20
|
+
| **paid_at** | **Integer** | Payment date | [optional] |
|
21
|
+
| **payment_method** | [**ChargeResponsePaymentMethod**](ChargeResponsePaymentMethod.md) | | [optional] |
|
22
|
+
| **reference_id** | **String** | Reference ID of the charge | [optional] |
|
23
|
+
| **refunds** | [**ChargeResponseRefunds**](ChargeResponseRefunds.md) | | [optional] |
|
24
|
+
| **status** | **String** | | [optional] |
|
25
|
+
|
26
|
+
## Example
|
27
|
+
|
28
|
+
```ruby
|
29
|
+
require 'conekta'
|
30
|
+
|
31
|
+
instance = Conekta::ChargesOrderResponseAllOfData.new(
|
32
|
+
amount: 4321,
|
33
|
+
channel: null,
|
34
|
+
created_at: 1676386026,
|
35
|
+
currency: MXN,
|
36
|
+
customer_id: null,
|
37
|
+
description: Payment from order,
|
38
|
+
device_fingerprint: 6FR3chaU4Y1nGAW5NAGd1rcjAKa142Ba,
|
39
|
+
failure_code: suspected_fraud,
|
40
|
+
failure_message: Este cargo ha sido declinado porque el comportamiento del comprador es sospechoso.,
|
41
|
+
id: 63efa757cf65380001aec040,
|
42
|
+
livemode: false,
|
43
|
+
object: charge,
|
44
|
+
order_id: ord_2tN73UdUSNrYRPD9r,
|
45
|
+
paid_at: 1676390742,
|
46
|
+
payment_method: null,
|
47
|
+
reference_id: ref_2tN73UdUSNrYRPD9r,
|
48
|
+
refunds: null,
|
49
|
+
status: pending_payment
|
50
|
+
)
|
51
|
+
```
|
52
|
+
|
data/docs/Checkout.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
| **expires_at** | **Integer** | It is the time when the link will expire. It is expressed in seconds since the Unix epoch. The valid range is from 2 to 365 days (the valid range will be taken from the next day of the creation date at 00:01 hrs) | |
|
9
9
|
| **monthly_installments_enabled** | **Boolean** | This flag allows you to specify if months without interest will be active. | [optional] |
|
10
10
|
| **monthly_installments_options** | **Array<Integer>** | This field allows you to specify the number of months without interest. | [optional] |
|
11
|
+
| **three_ds_mode** | **String** | Indicates the 3DS2 mode for the order, either smart or strict. | [optional] |
|
11
12
|
| **name** | **String** | Reason for charge | |
|
12
13
|
| **needs_shipping_contact** | **Boolean** | This flag allows you to fill in the shipping information at checkout. | [optional] |
|
13
14
|
| **on_demand_enabled** | **Boolean** | This flag allows you to specify if the link will be on demand. | [optional] |
|
@@ -26,6 +27,7 @@ instance = Conekta::Checkout.new(
|
|
26
27
|
expires_at: 1680397724,
|
27
28
|
monthly_installments_enabled: true,
|
28
29
|
monthly_installments_options: [3,6,12],
|
30
|
+
three_ds_mode: null,
|
29
31
|
name: Payment Link Name 1594138857,
|
30
32
|
needs_shipping_contact: false,
|
31
33
|
on_demand_enabled: true,
|
data/docs/CheckoutRequest.md
CHANGED
@@ -9,6 +9,7 @@
|
|
9
9
|
| **failure_url** | **String** | Redirection url back to the site in case of failed payment, applies only to HostedPayment. | [optional] |
|
10
10
|
| **monthly_installments_enabled** | **Boolean** | | [optional] |
|
11
11
|
| **monthly_installments_options** | **Array<Integer>** | | [optional] |
|
12
|
+
| **max_failed_retries** | **Integer** | Number of retries allowed before the checkout is marked as failed | [optional] |
|
12
13
|
| **name** | **String** | Reason for payment | [optional] |
|
13
14
|
| **on_demand_enabled** | **Boolean** | | [optional] |
|
14
15
|
| **redirection_time** | **Integer** | number of seconds to wait before redirecting to the success_url | [optional] |
|
@@ -26,6 +27,7 @@ instance = Conekta::CheckoutRequest.new(
|
|
26
27
|
failure_url: null,
|
27
28
|
monthly_installments_enabled: false,
|
28
29
|
monthly_installments_options: [3,6,12],
|
30
|
+
max_failed_retries: 3,
|
29
31
|
name: null,
|
30
32
|
on_demand_enabled: true,
|
31
33
|
redirection_time: 10,
|
@@ -14,9 +14,9 @@ require 'conekta'
|
|
14
14
|
Conekta::CreateCustomerPaymentMethodsRequest.openapi_one_of
|
15
15
|
# =>
|
16
16
|
# [
|
17
|
-
# :'PaymentMethodCardRequest',
|
18
17
|
# :'PaymentMethodCashRequest',
|
19
|
-
# :'PaymentMethodSpeiRequest'
|
18
|
+
# :'PaymentMethodSpeiRequest',
|
19
|
+
# :'PaymentMethodTokenRequest'
|
20
20
|
# ]
|
21
21
|
```
|
22
22
|
|
@@ -30,7 +30,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
|
|
30
30
|
require 'conekta'
|
31
31
|
|
32
32
|
Conekta::CreateCustomerPaymentMethodsRequest.build(data)
|
33
|
-
# => #<
|
33
|
+
# => #<PaymentMethodCashRequest:0x00007fdd4aab02a0>
|
34
34
|
|
35
35
|
Conekta::CreateCustomerPaymentMethodsRequest.build(data_that_doesnt_match)
|
36
36
|
# => nil
|
@@ -44,8 +44,8 @@ Conekta::CreateCustomerPaymentMethodsRequest.build(data_that_doesnt_match)
|
|
44
44
|
|
45
45
|
#### Return type
|
46
46
|
|
47
|
-
- `PaymentMethodCardRequest`
|
48
47
|
- `PaymentMethodCashRequest`
|
49
48
|
- `PaymentMethodSpeiRequest`
|
49
|
+
- `PaymentMethodTokenRequest`
|
50
50
|
- `nil` (if no type matches)
|
51
51
|
|
data/docs/Customer.md
CHANGED
@@ -7,12 +7,14 @@
|
|
7
7
|
| **antifraud_info** | [**CustomerAntifraudInfo**](CustomerAntifraudInfo.md) | | [optional] |
|
8
8
|
| **corporate** | **Boolean** | It is a value that allows identifying if the email is corporate or not. | [optional][default to false] |
|
9
9
|
| **custom_reference** | **String** | It is an undefined value. | [optional] |
|
10
|
+
| **date_of_birth** | **String** | It is a parameter that allows to identify the date of birth of the client. | [optional] |
|
10
11
|
| **email** | **String** | An email address is a series of customizable characters followed by a universal Internet symbol, the at symbol (@), the name of a host server, and a web domain ending (.mx, .com, .org, . net, etc). | |
|
11
12
|
| **default_payment_source_id** | **String** | It is a parameter that allows to identify in the response, the Conekta ID of a payment method (payment_id) | [optional] |
|
12
13
|
| **default_shipping_contact_id** | **String** | It is a parameter that allows to identify in the response, the Conekta ID of the shipping address (shipping_contact) | [optional] |
|
13
14
|
| **fiscal_entities** | [**Array<CustomerFiscalEntitiesRequest>**](CustomerFiscalEntitiesRequest.md) | | [optional] |
|
14
15
|
| **metadata** | **Hash<String, Object>** | | [optional] |
|
15
16
|
| **name** | **String** | Client's name | |
|
17
|
+
| **national_id** | **String** | It is a parameter that allows to identify the national identification number of the client. | [optional] |
|
16
18
|
| **payment_sources** | [**Array<CustomerPaymentMethodsRequest>**](CustomerPaymentMethodsRequest.md) | Contains details of the payment methods that the customer has active or has used in Conekta | [optional] |
|
17
19
|
| **phone** | **String** | Is the customer's phone number | |
|
18
20
|
| **plan_id** | **String** | Contains the ID of a plan, which could together with name, email and phone create a client directly to a subscription | [optional] |
|
@@ -28,12 +30,14 @@ instance = Conekta::Customer.new(
|
|
28
30
|
antifraud_info: null,
|
29
31
|
corporate: false,
|
30
32
|
custom_reference: null,
|
33
|
+
date_of_birth: 24/07/1992,
|
31
34
|
email: miguel@gmail.com,
|
32
35
|
default_payment_source_id: src_1a2b3c4d5e6f7g8h,
|
33
36
|
default_shipping_contact_id: ship_cont_1a2b3c4d5e6f7g8h,
|
34
37
|
fiscal_entities: null,
|
35
38
|
metadata: null,
|
36
39
|
name: miguel,
|
40
|
+
national_id: HEGG560427MVZRRL04,
|
37
41
|
payment_sources: null,
|
38
42
|
phone: +5215555555555,
|
39
43
|
plan_id: plan_987234823,
|
@@ -14,9 +14,9 @@ require 'conekta'
|
|
14
14
|
Conekta::CustomerPaymentMethodsRequest.openapi_one_of
|
15
15
|
# =>
|
16
16
|
# [
|
17
|
-
# :'PaymentMethodCardRequest',
|
18
17
|
# :'PaymentMethodCashRequest',
|
19
|
-
# :'PaymentMethodSpeiRequest'
|
18
|
+
# :'PaymentMethodSpeiRequest',
|
19
|
+
# :'PaymentMethodTokenRequest'
|
20
20
|
# ]
|
21
21
|
```
|
22
22
|
|
@@ -30,7 +30,7 @@ Find the appropriate object from the `openapi_one_of` list and casts the data in
|
|
30
30
|
require 'conekta'
|
31
31
|
|
32
32
|
Conekta::CustomerPaymentMethodsRequest.build(data)
|
33
|
-
# => #<
|
33
|
+
# => #<PaymentMethodCashRequest:0x00007fdd4aab02a0>
|
34
34
|
|
35
35
|
Conekta::CustomerPaymentMethodsRequest.build(data_that_doesnt_match)
|
36
36
|
# => nil
|
@@ -44,8 +44,8 @@ Conekta::CustomerPaymentMethodsRequest.build(data_that_doesnt_match)
|
|
44
44
|
|
45
45
|
#### Return type
|
46
46
|
|
47
|
-
- `PaymentMethodCardRequest`
|
48
47
|
- `PaymentMethodCashRequest`
|
49
48
|
- `PaymentMethodSpeiRequest`
|
49
|
+
- `PaymentMethodTokenRequest`
|
50
50
|
- `nil` (if no type matches)
|
51
51
|
|
data/docs/CustomerResponse.md
CHANGED
@@ -8,6 +8,7 @@
|
|
8
8
|
| **corporate** | **Boolean** | true if the customer is a company | [optional] |
|
9
9
|
| **created_at** | **Integer** | Creation date of the object | |
|
10
10
|
| **custom_reference** | **String** | Custom reference | [optional] |
|
11
|
+
| **date_of_birth** | **String** | It is a parameter that allows to identify the date of birth of the client. | [optional] |
|
11
12
|
| **default_fiscal_entity_id** | **String** | | [optional] |
|
12
13
|
| **default_shipping_contact_id** | **String** | | [optional] |
|
13
14
|
| **default_payment_source_id** | **String** | | [optional] |
|
@@ -16,6 +17,7 @@
|
|
16
17
|
| **id** | **String** | Customer's ID | |
|
17
18
|
| **livemode** | **Boolean** | true if the object exists in live mode or the value false if the object exists in test mode | |
|
18
19
|
| **name** | **String** | Customer's name | |
|
20
|
+
| **national_id** | **String** | It is a parameter that allows to identify the national identification number of the client. | [optional] |
|
19
21
|
| **metadata** | **Hash<String, Object>** | | [optional] |
|
20
22
|
| **object** | **String** | | |
|
21
23
|
| **payment_sources** | [**CustomerPaymentMethodsResponse**](CustomerPaymentMethodsResponse.md) | | [optional] |
|
@@ -33,6 +35,7 @@ instance = Conekta::CustomerResponse.new(
|
|
33
35
|
corporate: null,
|
34
36
|
created_at: 1485151007,
|
35
37
|
custom_reference: custom_reference,
|
38
|
+
date_of_birth: 24/07/1992,
|
36
39
|
default_fiscal_entity_id: fis_ent_2tKqqAfqPi21oCmEJ,
|
37
40
|
default_shipping_contact_id: ship_cont_2tKZsTYcsryyu7Ah8,
|
38
41
|
default_payment_source_id: src_2tHJfJ79KyUwpxTio,
|
@@ -41,6 +44,7 @@ instance = Conekta::CustomerResponse.new(
|
|
41
44
|
id: cus_2tHJfJ79KyUwpxTik,
|
42
45
|
livemode: true,
|
43
46
|
name: Felipe,
|
47
|
+
national_id: HEGG560427MVZRRL04,
|
44
48
|
metadata: null,
|
45
49
|
object: customer,
|
46
50
|
payment_sources: null,
|
data/docs/OrderRefundRequest.md
CHANGED
@@ -4,9 +4,9 @@
|
|
4
4
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
|
-
| **amount** | **Integer** |
|
7
|
+
| **amount** | **Integer** | Amount to be refunded in cents | |
|
8
8
|
| **expires_at** | **Integer** | | [optional] |
|
9
|
-
| **reason** | **String** |
|
9
|
+
| **reason** | **String** | Reason for the refund | |
|
10
10
|
|
11
11
|
## Example
|
12
12
|
|
data/docs/OrderRequest.md
CHANGED
@@ -15,7 +15,7 @@
|
|
15
15
|
| **needs_shipping_contact** | **Boolean** | Allows you to fill out the shipping information at checkout | [optional] |
|
16
16
|
| **pre_authorize** | **Boolean** | Indicates whether the order charges must be preauthorized | [optional][default to false] |
|
17
17
|
| **processing_mode** | **String** | Indicates the processing mode for the order, either ecommerce, recurrent or validation. | [optional] |
|
18
|
-
| **return_url** | **String** | Indicates the redirection callback upon completion of the 3DS2 flow. | [optional] |
|
18
|
+
| **return_url** | **String** | Indicates the redirection callback upon completion of the 3DS2 flow. Do not use this parameter if your order has a checkout parameter | [optional] |
|
19
19
|
| **shipping_contact** | [**CustomerShippingContacts**](CustomerShippingContacts.md) | | [optional] |
|
20
20
|
| **shipping_lines** | [**Array<ShippingRequest>**](ShippingRequest.md) | List of [shipping costs](https://developers.conekta.com/v2.1.0/reference/orderscreateshipping). If the online store offers digital products. | [optional] |
|
21
21
|
| **tax_lines** | [**Array<OrderTaxRequest>**](OrderTaxRequest.md) | List of [taxes](https://developers.conekta.com/v2.1.0/reference/orderscreatetaxes) that are applied to the order. | [optional] |
|
@@ -14,6 +14,7 @@
|
|
14
14
|
| **id** | **String** | | [optional] |
|
15
15
|
| **is_redirect_on_failure** | **Boolean** | | [optional] |
|
16
16
|
| **livemode** | **Boolean** | | [optional] |
|
17
|
+
| **max_failed_retries** | **Integer** | Number of retries allowed before the checkout is marked as failed | [optional] |
|
17
18
|
| **metadata** | **Hash<String, Object>** | | [optional] |
|
18
19
|
| **monthly_installments_enabled** | **Boolean** | | [optional] |
|
19
20
|
| **monthly_installments_options** | **Array<Integer>** | | [optional] |
|
@@ -48,6 +49,7 @@ instance = Conekta::OrderResponseCheckout.new(
|
|
48
49
|
id: 6fca054a-8519-4c43-971e-cea35cc519bb,
|
49
50
|
is_redirect_on_failure: false,
|
50
51
|
livemode: false,
|
52
|
+
max_failed_retries: 3,
|
51
53
|
metadata: null,
|
52
54
|
monthly_installments_enabled: false,
|
53
55
|
monthly_installments_options: null,
|
@@ -22,6 +22,7 @@
|
|
22
22
|
| **receiving_account_tax_id** | **String** | | [optional] |
|
23
23
|
| **reference_number** | **String** | | [optional] |
|
24
24
|
| **tracking_code** | **String** | | [optional] |
|
25
|
+
| **customer_ip_address** | **String** | | [optional] |
|
25
26
|
|
26
27
|
## Example
|
27
28
|
|
@@ -46,7 +47,8 @@ instance = Conekta::PaymentMethodBankTransfer.new(
|
|
46
47
|
receiving_account_bank: STP,
|
47
48
|
receiving_account_tax_id: null,
|
48
49
|
reference_number: null,
|
49
|
-
tracking_code: null
|
50
|
+
tracking_code: null,
|
51
|
+
customer_ip_address: 0.0.0.0
|
50
52
|
)
|
51
53
|
```
|
52
54
|
|