Module: QPay::Endpoints::Invoices

Included in:
Client
Defined in:
lib/qpay/endpoints/invoices.rb

Instance Method Summary collapse

Instance Method Details

#cancel_invoice(invoice_id) ⇒ void

This method returns an undefined value.

Cancels an existing invoice by ID. DELETE /v2/invoice/id

Parameters:

  • invoice_id (String) 


41
42
43
44
 
# File 'lib/qpay/endpoints/invoices.rb', line 41

def cancel_invoice(invoice_id)
  do_request("DELETE", "/v2/invoice/#{invoice_id}")
  nil
end

#create_ebarimt_invoice(request) ⇒ QPay::InvoiceResponse

Creates an invoice with ebarimt (tax) information. POST /v2/invoice

Parameters:

Returns:



31
32
33
34
 
# File 'lib/qpay/endpoints/invoices.rb', line 31

def create_ebarimt_invoice(request)
  data = do_request("POST", "/v2/invoice", body: serialize(request))
  build_invoice_response(data)
end

#create_invoice(request) ⇒ QPay::InvoiceResponse

Creates a detailed invoice with full options. POST /v2/invoice

Parameters:

Returns:



11
12
13
14
 
# File 'lib/qpay/endpoints/invoices.rb', line 11

def create_invoice(request)
  data = do_request("POST", "/v2/invoice", body: serialize(request))
  build_invoice_response(data)
end

#create_simple_invoice(request) ⇒ QPay::InvoiceResponse

Creates a simple invoice with minimal fields. POST /v2/invoice

Parameters:

Returns:



21
22
23
24
 
# File 'lib/qpay/endpoints/invoices.rb', line 21

def create_simple_invoice(request)
  data = do_request("POST", "/v2/invoice", body: serialize(request))
  build_invoice_response(data)
end