Class: GOBL::Pay::Instructions

Inherits:
Object show all
Defined in:
lib/gobl/pay/instructions.rb

Overview

Instructions holds a set of instructions that determine how the payment has or should be made.

Constant Summary collapse

SCHEMA_ID =

The Schema ID of the GOBL Instructions structure

'https://gobl.org/draft-0/pay/instructions'

Constants included from Hashme

Hashme::Boolean

Instance Attribute Summary collapse

Method Summary

Methods inherited from Object

new

Methods inherited from Struct

#as_json, from_data, from_json!, #to_json

Instance Attribute Details

#card ⇒ Card (readonly)

Details of the payment that will be made via a credit or debit card.

Returns:



40
 
# File 'lib/gobl/pay/instructions.rb', line 40

property :card, Card

#credit_transfer ⇒ Array<CreditTransfer> (readonly)

Instructions for sending payment via a bank transfer.

Returns:



35
 
# File 'lib/gobl/pay/instructions.rb', line 35

property :credit_transfer, [CreditTransfer]

#detail ⇒ String (readonly)

Optional text description of the payment method

Returns:

  • (String) 


25
 
# File 'lib/gobl/pay/instructions.rb', line 25

property :detail, String

#direct_debit ⇒ DirectDebit (readonly)

A group of terms that can be used by the customer or payer to consolidate direct debit payments.

Returns:



45
 
# File 'lib/gobl/pay/instructions.rb', line 45

property :direct_debit, DirectDebit

#key ⇒ MethodKey (readonly)

How payment is expected or has been arranged to be collected

Returns:



19
 
# File 'lib/gobl/pay/instructions.rb', line 19

property :key, MethodKey

#meta ⇒ GOBL::CBC::Meta (readonly)

Non-structured additional data that may be useful.

Returns:



60
 
# File 'lib/gobl/pay/instructions.rb', line 60

property :meta, GOBL::CBC::Meta

#notes ⇒ String (readonly)

Any additional instructions that may be required to make the payment.

Returns:

  • (String) 


55
 
# File 'lib/gobl/pay/instructions.rb', line 55

property :notes, String

#online ⇒ Array<Online> (readonly)

Array of online payment options

Returns:



50
 
# File 'lib/gobl/pay/instructions.rb', line 50

property :online, [Online]

#ref ⇒ String (readonly)

Remittance information, a text value used to link the payment with the invoice.

Returns:

  • (String) 


30
 
# File 'lib/gobl/pay/instructions.rb', line 30

property :ref, String