Add description to params for api3 Payment.get
authorMatthew Wire <mjw@mjwconsult.co.uk>
Thu, 20 Feb 2020 17:12:50 +0000 (17:12 +0000)
committerMatthew Wire <mjw@mjwconsult.co.uk>
Thu, 20 Feb 2020 17:13:30 +0000 (17:13 +0000)
api/v3/Payment.php

index 4cc44800f4aac03c30a0d8c27a73d83d49619fba..cab15b3f3cd709a55bd4efda82455ef5ca1a53c5 100644 (file)
@@ -336,6 +336,7 @@ function _civicrm_api3_payment_get_spec(&$params) {
     ],
     'trxn_id' => [
       'title' => ts('Transaction ID'),
+      'description' => ts('Transaction id supplied by external processor. This may not be unique.'),
       'type' => CRM_Utils_Type::T_STRING,
     ],
     'trxn_date' => [
@@ -344,6 +345,7 @@ function _civicrm_api3_payment_get_spec(&$params) {
     ],
     'financial_trxn_id' => [
       'title' => ts('Payment ID'),
+      'description' => ts('The ID of the record in civicrm_financial_trxn'),
       'type' => CRM_Utils_Type::T_INT,
       'api.aliases' => ['payment_id', 'id'],
     ],