class PaymentsApi::Requests::GetCardPayment
Attributes
payment_id[R]
Public Class Methods
new(payment_id:)
click to toggle source
Instantiate a get payment details request
@param payment_id
[String] The payment ID to retrieve their information
@raise [ArgumentError] if payment_id
is missing or nil
@return [PaymentsApi::Requests::GetCardPayment] instance
@see govukpay-api-browser.cloudapps.digital/#get-a-payment
# File lib/payments_api/requests/get_card_payment.rb, line 19 def initialize(payment_id:) @payment_id = payment_id raise ArgumentError, '`payment_id` cannot be nil' unless payment_id end
Public Instance Methods
call()
click to toggle source
Get existing payment details
@raise [PaymentsApi::Errors::ApiError] refer to lib/payments_api/errors.rb @return [Responses::PaymentResult] result response
@see govukpay-api-browser.cloudapps.digital/#tocsgetpaymentresult
# File lib/payments_api/requests/get_card_payment.rb, line 32 def call Responses::PaymentResult.new( http_client.get(endpoint) ) end
endpoint()
click to toggle source
# File lib/payments_api/requests/get_card_payment.rb, line 38 def endpoint format( '/v1/payments/%<payment_id>s', payment_id: payment_id ) end