OpenapiClient::SecureOutboundPaymentsApi

All URIs are relative to https://api.uat.anddone.com

Method	HTTP request	Description
vendorapi_secure_outbound_payments_timelines_post	POST /vendorapi/secure/outboundPayments/timelines	This API gets outbound payment timelines
vendorapi_secure_outboundpayments_cancel_post	POST /vendorapi/secure/outboundpayments/cancel	This API cancel outbound payment request
vendorapi_secure_outboundpayments_detail_post	POST /vendorapi/secure/outboundpayments/detail	This API fetch outbound payment by paymentId
vendorapi_secure_outboundpayments_image_post	POST /vendorapi/secure/outboundpayments/image	This API gets outbound payment JPG image in Base64 string format
vendorapi_secure_outboundpayments_post	POST /vendorapi/secure/outboundpayments	This API creates outbound payment request
vendorapi_secure_outboundpayments_search_post	POST /vendorapi/secure/outboundpayments/search	This API gets all outbound payment

vendorapi_secure_outbound_payments_timelines_post

<Array> vendorapi_secure_outbound_payments_timelines_post(x_api_key, x_app_key, x_version, origin, payment_time_line_request_dto)

This API gets outbound payment timelines

Examples

require 'time'
require 'openapi_client'

api_instance = OpenapiClient::SecureOutboundPaymentsApi.new
x_api_key = 'x_api_key_example' # String | an authorization header
x_app_key = 'x_app_key_example' # String | an authorization header
x_version = 8.14 # Float | x-version
origin = 'origin_example' # String | origin
payment_time_line_request_dto = OpenapiClient::PaymentTimeLineRequestDto.new({payment_id: 'payment_id_example'}) # PaymentTimeLineRequestDto | PaymentTimeLineRequestDto

begin
  # This API gets outbound payment timelines
  result = api_instance.vendorapi_secure_outbound_payments_timelines_post(x_api_key, x_app_key, x_version, origin, payment_time_line_request_dto)
  p result
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outbound_payments_timelines_post: #{e}"
end

Using the vendorapi_secure_outbound_payments_timelines_post_with_http_info variant

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

<Array(<Array>, Integer, Hash)> vendorapi_secure_outbound_payments_timelines_post_with_http_info(x_api_key, x_app_key, x_version, origin, payment_time_line_request_dto)

begin
  # This API gets outbound payment timelines
  data, status_code, headers = api_instance.vendorapi_secure_outbound_payments_timelines_post_with_http_info(x_api_key, x_app_key, x_version, origin, payment_time_line_request_dto)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<OutboundPaymentTimelineResponseDTOInner>>
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outbound_payments_timelines_post_with_http_info: #{e}"
end

Parameters

Name	Type	Description
x_api_key	String	an authorization header
x_app_key	String	an authorization header
x_version	Float	x-version
origin	String	origin
payment_time_line_request_dto	PaymentTimeLineRequestDto	PaymentTimeLineRequestDto

Return type

Array<OutboundPaymentTimelineResponseDTOInner>

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

vendorapi_secure_outboundpayments_cancel_post

vendorapi_secure_outboundpayments_cancel_post(x_api_key, x_app_key, x_version, origin, cancel_payment_request_dto)

This API cancel outbound payment request

Examples

require 'time'
require 'openapi_client'

api_instance = OpenapiClient::SecureOutboundPaymentsApi.new
x_api_key = 'x_api_key_example' # String | an authorization header
x_app_key = 'x_app_key_example' # String | an authorization header
x_version = 8.14 # Float | x-version
origin = 'origin_example' # String | origin
cancel_payment_request_dto = OpenapiClient::CancelPaymentRequestDTO.new({payment_id: 'payment_id_example'}) # CancelPaymentRequestDTO | CancelPaymentRequestDTO

begin
  # This API cancel outbound payment request
  api_instance.vendorapi_secure_outboundpayments_cancel_post(x_api_key, x_app_key, x_version, origin, cancel_payment_request_dto)
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outboundpayments_cancel_post: #{e}"
end

Using the vendorapi_secure_outboundpayments_cancel_post_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> vendorapi_secure_outboundpayments_cancel_post_with_http_info(x_api_key, x_app_key, x_version, origin, cancel_payment_request_dto)

begin
  # This API cancel outbound payment request
  data, status_code, headers = api_instance.vendorapi_secure_outboundpayments_cancel_post_with_http_info(x_api_key, x_app_key, x_version, origin, cancel_payment_request_dto)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outboundpayments_cancel_post_with_http_info: #{e}"
end

Parameters

Name	Type	Description
x_api_key	String	an authorization header
x_app_key	String	an authorization header
x_version	Float	x-version
origin	String	origin
cancel_payment_request_dto	CancelPaymentRequestDTO	CancelPaymentRequestDTO

Return type

nil (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: Not defined

vendorapi_secure_outboundpayments_detail_post

vendorapi_secure_outboundpayments_detail_post(x_api_key, x_app_key, x_version, origin, payment_request_detail_dto)

This API fetch outbound payment by paymentId

Examples

require 'time'
require 'openapi_client'

api_instance = OpenapiClient::SecureOutboundPaymentsApi.new
x_api_key = 'x_api_key_example' # String | an authorization header
x_app_key = 'x_app_key_example' # String | an authorization header
x_version = 8.14 # Float | x-version
origin = 'origin_example' # String | origin
payment_request_detail_dto = OpenapiClient::PaymentRequestDetailDTO.new({payment_id: 'payment_id_example'}) # PaymentRequestDetailDTO | PaymentRequestDetailDTO

begin
  # This API fetch outbound payment by paymentId
  result = api_instance.vendorapi_secure_outboundpayments_detail_post(x_api_key, x_app_key, x_version, origin, payment_request_detail_dto)
  p result
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outboundpayments_detail_post: #{e}"
end

Using the vendorapi_secure_outboundpayments_detail_post_with_http_info variant

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

<Array(, Integer, Hash)> vendorapi_secure_outboundpayments_detail_post_with_http_info(x_api_key, x_app_key, x_version, origin, payment_request_detail_dto)

begin
  # This API fetch outbound payment by paymentId
  data, status_code, headers = api_instance.vendorapi_secure_outboundpayments_detail_post_with_http_info(x_api_key, x_app_key, x_version, origin, payment_request_detail_dto)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaymentDetailResponseDTO>
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outboundpayments_detail_post_with_http_info: #{e}"
end

Parameters

Name	Type	Description
x_api_key	String	an authorization header
x_app_key	String	an authorization header
x_version	Float	x-version
origin	String	origin
payment_request_detail_dto	PaymentRequestDetailDTO	PaymentRequestDetailDTO

Return type

PaymentDetailResponseDTO

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

vendorapi_secure_outboundpayments_image_post

vendorapi_secure_outboundpayments_image_post(x_api_key, x_app_key, x_version, origin, payment_time_line_request_dto)

This API gets outbound payment JPG image in Base64 string format

Examples

require 'time'
require 'openapi_client'

api_instance = OpenapiClient::SecureOutboundPaymentsApi.new
x_api_key = 'x_api_key_example' # String | an authorization header
x_app_key = 'x_app_key_example' # String | an authorization header
x_version = 8.14 # Float | x-version
origin = 'origin_example' # String | origin
payment_time_line_request_dto = OpenapiClient::PaymentTimeLineRequestDto.new({payment_id: 'payment_id_example'}) # PaymentTimeLineRequestDto | OutboundPaymentImageRequestDto

begin
  # This API gets outbound payment JPG image in Base64 string format
  result = api_instance.vendorapi_secure_outboundpayments_image_post(x_api_key, x_app_key, x_version, origin, payment_time_line_request_dto)
  p result
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outboundpayments_image_post: #{e}"
end

Using the vendorapi_secure_outboundpayments_image_post_with_http_info variant

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

<Array(, Integer, Hash)> vendorapi_secure_outboundpayments_image_post_with_http_info(x_api_key, x_app_key, x_version, origin, payment_time_line_request_dto)

begin
  # This API gets outbound payment JPG image in Base64 string format
  data, status_code, headers = api_instance.vendorapi_secure_outboundpayments_image_post_with_http_info(x_api_key, x_app_key, x_version, origin, payment_time_line_request_dto)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OutboundPaymentImageResponseDTO>
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outboundpayments_image_post_with_http_info: #{e}"
end

Parameters

Name	Type	Description
x_api_key	String	an authorization header
x_app_key	String	an authorization header
x_version	Float	x-version
origin	String	origin
payment_time_line_request_dto	PaymentTimeLineRequestDto	OutboundPaymentImageRequestDto

Return type

OutboundPaymentImageResponseDTO

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

vendorapi_secure_outboundpayments_post

vendorapi_secure_outboundpayments_post(x_api_key, x_app_key, x_version, origin, payment_request_dto)

This API creates outbound payment request

Examples

require 'time'
require 'openapi_client'

api_instance = OpenapiClient::SecureOutboundPaymentsApi.new
x_api_key = 'x_api_key_example' # String | an authorization header
x_app_key = 'x_app_key_example' # String | an authorization header
x_version = 8.14 # Float | x-version
origin = 'origin_example' # String | origin
payment_request_dto = OpenapiClient::PaymentRequestDto.new({vendor_id: 'vendor_id_example', payment_method: 'Check', amount: 3.56, data: OpenapiClient::PaymentRequestDtoData.new}) # PaymentRequestDto | PaymentRequestDto

begin
  # This API creates outbound payment request
  result = api_instance.vendorapi_secure_outboundpayments_post(x_api_key, x_app_key, x_version, origin, payment_request_dto)
  p result
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outboundpayments_post: #{e}"
end

Using the vendorapi_secure_outboundpayments_post_with_http_info variant

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

<Array(, Integer, Hash)> vendorapi_secure_outboundpayments_post_with_http_info(x_api_key, x_app_key, x_version, origin, payment_request_dto)

begin
  # This API creates outbound payment request
  data, status_code, headers = api_instance.vendorapi_secure_outboundpayments_post_with_http_info(x_api_key, x_app_key, x_version, origin, payment_request_dto)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PaymentResponseDto>
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outboundpayments_post_with_http_info: #{e}"
end

Parameters

Name	Type	Description
x_api_key	String	an authorization header
x_app_key	String	an authorization header
x_version	Float	x-version
origin	String	origin
payment_request_dto	PaymentRequestDto	PaymentRequestDto

Return type

PaymentResponseDto

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

vendorapi_secure_outboundpayments_search_post

vendorapi_secure_outboundpayments_search_post(x_api_key, x_app_key, x_version, origin, opts)

This API gets all outbound payment

Examples

require 'time'
require 'openapi_client'

api_instance = OpenapiClient::SecureOutboundPaymentsApi.new
x_api_key = 'x_api_key_example' # String | an authorization header
x_app_key = 'x_app_key_example' # String | an authorization header
x_version = 8.14 # Float | x-version
origin = 'origin_example' # String | origin
opts = {
  vendor_id: 'vendor_id_example', # String | sets vendorId
  payment_based_id: 'payment_based_id_example', # String | sets paymentBasedId
  payment_id: 'payment_id_example', # String | sets paymentId
  vendor_name: 'vendor_name_example', # String | sets vendorName
  payment_method_type: 'Check', # String | sets paymentMethodType
  payment_method_status: 'payment_method_status_example', # String | sets paymentMethodStatus
  amount: 8.14, # Float | sets amount
  from_amount: 8.14, # Float | sets fromAmount
  to_amount: 8.14, # Float | sets toAmount
  start_date: 'start_date_example', # String | sets startDate
  end_date: 'end_date_example', # String | sets endDate
  search_text: 'search_text_example', # String | sets searchText
  start_row: 56, # Integer | sets startRow
  page_size: 56, # Integer | sets pageSize
  sort_field: 'sort_field_example', # String | sets sortField
  asc: true # Boolean | Set Asc
}

begin
  # This API gets all outbound payment
  result = api_instance.vendorapi_secure_outboundpayments_search_post(x_api_key, x_app_key, x_version, origin, opts)
  p result
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outboundpayments_search_post: #{e}"
end

Using the vendorapi_secure_outboundpayments_search_post_with_http_info variant

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

<Array(, Integer, Hash)> vendorapi_secure_outboundpayments_search_post_with_http_info(x_api_key, x_app_key, x_version, origin, opts)

begin
  # This API gets all outbound payment
  data, status_code, headers = api_instance.vendorapi_secure_outboundpayments_search_post_with_http_info(x_api_key, x_app_key, x_version, origin, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <PagePaymentListResponseDTO>
rescue OpenapiClient::ApiError => e
  puts "Error when calling SecureOutboundPaymentsApi->vendorapi_secure_outboundpayments_search_post_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
x_api_key	String	an authorization header
x_app_key	String	an authorization header
x_version	Float	x-version
origin	String	origin
vendor_id	String	sets vendorId	[optional]
payment_based_id	String	sets paymentBasedId	[optional]
payment_id	String	sets paymentId	[optional]
vendor_name	String	sets vendorName	[optional]
payment_method_type	String	sets paymentMethodType	[optional]
payment_method_status	String	sets paymentMethodStatus	[optional]
amount	Float	sets amount	[optional]
from_amount	Float	sets fromAmount	[optional]
to_amount	Float	sets toAmount	[optional]
start_date	String	sets startDate	[optional]
end_date	String	sets endDate	[optional]
search_text	String	sets searchText	[optional]
start_row	Integer	sets startRow	[optional]
page_size	Integer	sets pageSize	[optional]
sort_field	String	sets sortField	[optional]
asc	Boolean	Set Asc	[optional]

Return type

PagePaymentListResponseDTO

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

FilesExpand file tree

SecureOutboundPaymentsApi.md

Latest commit

History

SecureOutboundPaymentsApi.md

File metadata and controls

OpenapiClient::SecureOutboundPaymentsApi

vendorapi_secure_outbound_payments_timelines_post

Examples

Using the vendorapi_secure_outbound_payments_timelines_post_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

vendorapi_secure_outboundpayments_cancel_post

Examples

Using the vendorapi_secure_outboundpayments_cancel_post_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

vendorapi_secure_outboundpayments_detail_post

Examples

Using the vendorapi_secure_outboundpayments_detail_post_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

vendorapi_secure_outboundpayments_image_post

Examples

Using the vendorapi_secure_outboundpayments_image_post_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

vendorapi_secure_outboundpayments_post

Examples

Using the vendorapi_secure_outboundpayments_post_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers

vendorapi_secure_outboundpayments_search_post

Examples

Using the vendorapi_secure_outboundpayments_search_post_with_http_info variant

Parameters

Return type

Authorization

HTTP request headers