Skip to content

Latest commit

 

History

History
34 lines (28 loc) · 1.96 KB

PaymentInstructionV3.md

File metadata and controls

34 lines (28 loc) · 1.96 KB
Raw

VeloPayments::PaymentInstructionV3

Properties

Name Type Description Notes
remote_id String Your identifier for payee
currency String Valid ISO 4217 3 letter currency code. See the <a href=&quot;https://www.iso.org/iso-4217-currency-codes.html\" target=&quot;_blank&quot; a>ISO specification</a> for details.
amount Integer <p>Amount to send to Payee</p> <p>The maximum payment amount is dependent on the currency</p>
payment_memo String <p>Any value here will override the memo value in the parent payout</p> <p>This should be the reference field on the statement seen by the payee (but not via ACH)</p> [optional]
source_account_name String Must match a valid source account name belonging to the payor
payor_payment_id String A reference identifier for the payor for the given payee payment [optional]
transmission_type TransmissionType [optional]
remote_system_id String <p>The identifier for the remote payments system if not Velo</p> <p>Should only be used after consultation with Velo Payments</p> [optional]
payment_metadata String <p>Metadata about the payment that may be relevant to the specific rails or remote system making the payout</p> <p>The structure of the data will be dictated by the requirements of the payment rails</p> [optional]

Example

require 'velopayments'

instance = VeloPayments::PaymentInstructionV3.new(
  remote_id: remoteId1234,
  currency: USD,
  amount: 1299,
  payment_memo: my memo,
  source_account_name: MyAccountName,
  payor_payment_id: 123211321ABSD,
  transmission_type: null,
  remote_system_id: null,
  payment_metadata: invoiceeId_123|abc001:12345|xyz002:4567
)