docs/PaymentResponseV3.md in velopayments-2.17.8 vs docs/PaymentResponseV3.md in velopayments-2.18.31.beta1
- old
+ new
@@ -2,43 +2,46 @@
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
-**payment_id** | **String** | |
-**payee_id** | **String** | |
-**payor_id** | **String** | |
-**payor_name** | **String** | | [optional]
-**quote_id** | **String** | |
-**source_account_id** | **String** | |
-**source_account_name** | **String** | | [optional]
-**remote_id** | **String** | | [optional]
-**source_amount** | **Integer** | | [optional]
+**payment_id** | **String** | The id of the payment |
+**payee_id** | **String** | The id of the paymeee |
+**payor_id** | **String** | The id of the payor |
+**payor_name** | **String** | The name of the payor | [optional]
+**quote_id** | **String** | The quote Id used for the FX |
+**source_account_id** | **String** | The id of the source account from which the payment was taken |
+**source_account_name** | **String** | The name of the source account from which the payment was taken | [optional]
+**remote_id** | **String** | The remote id by which the payor refers to the payee. Only populated once payment is confirmed | [optional]
+**source_amount** | **Integer** | The source amount for the payment (amount debited to make the payment) | [optional]
**source_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) | | [optional]
-**payment_amount** | **Integer** | |
+**payment_amount** | **Integer** | The amount which the payee will receive |
**payment_currency** | [**PaymentAuditCurrencyV3**](PaymentAuditCurrencyV3.md) | | [optional]
-**rate** | **Float** | | [optional]
-**inverted_rate** | **Float** | | [optional]
+**rate** | **Float** | The FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed | [optional]
+**inverted_rate** | **Float** | The inverted FX rate for the payment, if FX was involved. **Note** that (depending on the role of the caller) this information may not be displayed | [optional]
**submitted_date_time** | **DateTime** | |
**status** | **String** | |
-**funding_status** | **String** | |
-**routing_number** | **String** | | [optional]
-**account_number** | **String** | | [optional]
-**iban** | **String** | | [optional]
-**payment_memo** | **String** | | [optional]
-**filename_reference** | **String** | | [optional]
-**individual_identification_number** | **String** | | [optional]
-**trace_number** | **String** | | [optional]
+**funding_status** | **String** | The funding status of the payment |
+**routing_number** | **String** | The routing number for the payment. | [optional]
+**account_number** | **String** | The account number for the account which will receive the payment. | [optional]
+**iban** | **String** | The iban for the payment. | [optional]
+**payment_memo** | **String** | The payment memo set by the payor | [optional]
+**filename_reference** | **String** | ACH file payment was submitted in, if applicable | [optional]
+**individual_identification_number** | **String** | Individual Identification Number assigned to the payment in the ACH file, if applicable | [optional]
+**trace_number** | **String** | Trace Number assigned to the payment in the ACH file, if applicable | [optional]
**payor_payment_id** | **String** | | [optional]
**payment_channel_id** | **String** | | [optional]
**payment_channel_name** | **String** | | [optional]
**account_name** | **String** | | [optional]
-**rails_id** | **String** | |
-**country_code** | **String** | | [optional]
+**rails_id** | **String** | The rails ID. Default value is RAILS ID UNAVAILABLE when not populated. | [default to 'RAILS ID UNAVAILABLE']
+**country_code** | **String** | The country code of the payment channel. | [optional]
**events** | [**Array<PaymentEventResponseV3>**](PaymentEventResponseV3.md) | |
-**return_cost** | **Integer** | | [optional]
+**return_cost** | **Integer** | The return cost if a returned payment. | [optional]
**return_reason** | **String** | | [optional]
+**rails_payment_id** | **String** | | [optional]
+**rails_batch_id** | **String** | | [optional]
+**rejection_reason** | **String** | | [optional]
## Code Sample
```ruby
require 'VeloPayments'
@@ -73,9 +76,12 @@
account_name: My Account Name,
rails_id: asdf123,
country_code: US,
events: null,
return_cost: 1232,
- return_reason: Some Reason Value)
+ return_reason: Some Reason Value,
+ rails_payment_id: null,
+ rails_batch_id: null,
+ rejection_reason: null)
```