Skip to content

Latest commit

 

History

History
165 lines (120 loc) · 4.84 KB

TransfersApi.md

File metadata and controls

165 lines (120 loc) · 4.84 KB
Raw

Conekta::TransfersApi

All URIs are relative to https://api.conekta.io

Method HTTP request Description
get_transfer GET /transfers/{id} Get Transfer
get_transfers GET /transfers Get a list of transfers

get_transfer

get_transfer(id, opts)

Get Transfer

Get the details of a Transfer

Examples

require 'time'
require 'conekta'
# setup authorization
Conekta.configure do |config|
  # Configure Bearer authorization: bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Conekta::TransfersApi.new
id = '6307a60c41de27127515a575' # String | Identifier of the resource
opts = {
  accept_language: 'es', # String | Use for knowing which language to use
  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.
}

begin
  # Get Transfer
  result = api_instance.get_transfer(id, opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling TransfersApi->get_transfer: #{e}"
end

Using the get_transfer_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_transfer_with_http_info(id, opts)

begin
  # Get Transfer
  data, status_code, headers = api_instance.get_transfer_with_http_info(id, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TransferResponse>
rescue Conekta::ApiError => e
  puts "Error when calling TransfersApi->get_transfer_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
id String Identifier of the resource
accept_language String Use for knowing which language to use [optional][default to 'es']
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]

Return type

TransferResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json

get_transfers

get_transfers(opts)

Get a list of transfers

Get transfers details in the form of a list

Examples

require 'time'
require 'conekta'
# setup authorization
Conekta.configure do |config|
  # Configure Bearer authorization: bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = Conekta::TransfersApi.new
opts = {
  accept_language: 'es', # String | Use for knowing which language to use
  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.
  limit: 56, # Integer | The numbers of items to return, the maximum value is 250
  search: 'search_example', # String | General order search, e.g. by mail, reference etc.
  _next: '_next_example', # String | next page
  previous: 'previous_example' # String | previous page
}

begin
  # Get a list of transfers
  result = api_instance.get_transfers(opts)
  p result
rescue Conekta::ApiError => e
  puts "Error when calling TransfersApi->get_transfers: #{e}"
end

Using the get_transfers_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> get_transfers_with_http_info(opts)

begin
  # Get a list of transfers
  data, status_code, headers = api_instance.get_transfers_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <GetTransfersResponse>
rescue Conekta::ApiError => e
  puts "Error when calling TransfersApi->get_transfers_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
accept_language String Use for knowing which language to use [optional][default to 'es']
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]
limit Integer The numbers of items to return, the maximum value is 250 [optional][default to 20]
search String General order search, e.g. by mail, reference etc. [optional]
_next String next page [optional]
previous String previous page [optional]

Return type

GetTransfersResponse

Authorization

bearerAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.conekta-v2.1.0+json