Skip to content

PaymentTransactionsApi.md

Latest commit

 

History

History
159 lines (116 loc) · 4.74 KB

PaymentTransactionsApi.md

File metadata and controls

159 lines (116 loc) · 4.74 KB

PAYJPv2::PaymentTransactionsApi

All URIs are relative to http://localhost

Method HTTP request Description
get_all_payment_transactions GET /v2/payment_transactions Get All Payment Transactions
get_payment_transaction GET /v2/payment_transactions/{payment_transaction_id} Get Payment Transaction

get_all_payment_transactions

get_all_payment_transactions(opts)

Get All Payment Transactions

Examples

require 'time'
require 'payjpv2'
# setup authorization
PAYJPv2.configure do |config|
  # Configure HTTP basic authorization: HTTPBasic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure Bearer authorization: HTTPBearer
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PAYJPv2::PaymentTransactionsApi.new
opts = {
  limit: 56, # Integer | 取得するデータの最大件数
  starting_after: 'starting_after_example', # String | このIDより後のデータを取得
  ending_before: 'ending_before_example', # String | このIDより前のデータを取得
  term_id: 'term_id_example', # String | 集計区間 ID
  type: 'type_example', # String | 取引タイプ
  payment_method_type: 'payment_method_type_example' # String | 支払い方法タイプ
}

begin
  # Get All Payment Transactions
  result = api_instance.get_all_payment_transactions(opts)
  p result
rescue PAYJPv2::ApiError => e
  puts "Error when calling PaymentTransactionsApi->get_all_payment_transactions: #{e}"
end

Using the include_http_info option

To get response data along with status code and headers, use the include_http_info: true option.

begin
  # Get All Payment Transactions
  data, status_code, headers = api_instance.get_all_payment_transactions(opts.merge(include_http_info: true))
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaymentTransactionListResponse>
rescue PAYJPv2::ApiError => e
  puts "Error when calling PaymentTransactionsApi->get_all_payment_transactions: #{e}"
end

Parameters

Name Type Description Notes
limit Integer 取得するデータの最大件数 [optional][default to 10]
starting_after String このIDより後のデータを取得 [optional]
ending_before String このIDより前のデータを取得 [optional]
term_id String 集計区間 ID [optional]
type String 取引タイプ [optional]
payment_method_type String 支払い方法タイプ [optional]

Return type

PaymentTransactionListResponse

Authorization

HTTPBasic, HTTPBearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json

get_payment_transaction

get_payment_transaction(payment_transaction_id)

Get Payment Transaction

Examples

require 'time'
require 'payjpv2'
# setup authorization
PAYJPv2.configure do |config|
  # Configure HTTP basic authorization: HTTPBasic
  config.username = 'YOUR USERNAME'
  config.password = 'YOUR PASSWORD'

  # Configure Bearer authorization: HTTPBearer
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = PAYJPv2::PaymentTransactionsApi.new
payment_transaction_id = 'payment_transaction_id_example' # String | 

begin
  # Get Payment Transaction
  result = api_instance.get_payment_transaction(payment_transaction_id)
  p result
rescue PAYJPv2::ApiError => e
  puts "Error when calling PaymentTransactionsApi->get_payment_transaction: #{e}"
end

Using the include_http_info option

To get response data along with status code and headers, use the include_http_info: true option.

begin
  # Get Payment Transaction
  data, status_code, headers = api_instance.get_payment_transaction(payment_transaction_id, { include_http_info: true })
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaymentTransactionResponse>
rescue PAYJPv2::ApiError => e
  puts "Error when calling PaymentTransactionsApi->get_payment_transaction: #{e}"
end

Parameters

Name Type Description Notes
payment_transaction_id String

Return type

PaymentTransactionResponse

Authorization

HTTPBasic, HTTPBearer

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/problem+json