Merge pull request moov-io#549 from adamdecaf/nil-returnCode

api,client: marshal null returnCode, not zero-value model

api/openapi.yaml

@@ -673,8 +673,6 @@ components:
             $ref: '#/components/schemas/Amount'
         status:
           $ref: '#/components/schemas/TransferStatus'
-        returnCode:
-          $ref: '#/components/schemas/ReturnCode'
         processedAt:
           type: string
           format: date-time
@@ -822,6 +820,7 @@ components:
           type: string
           description: Long form explanation of return code
           example: Previously active account has been closed by customer or RDFI
+      nullable: true
       required:
         - code
         - reason

pkg/client/docs/MicroDeposits.md

@@ -9,7 +9,6 @@ Name | Type | Description | Notes
 **Destination** | [**Destination**](Destination.md) |  | 
 **Amounts** | **[]string** |  | 
 **Status** | [**TransferStatus**](TransferStatus.md) |  | 
-**ReturnCode** | [**ReturnCode**](ReturnCode.md) |  | [optional] 
 **ProcessedAt** | Pointer to [**time.Time**](time.Time.md) |  | [optional] 
 **Created** | [**time.Time**](time.Time.md) |  | 
 

pkg/client/docs/Transfer.md

@@ -11,7 +11,7 @@ Name | Type | Description | Notes
 **Description** | **string** | Brief description of the transaction, that may appear on the receiving entity’s financial statement. This field is put into the Entry Detail's DiscretionaryData.  | 
 **Status** | [**TransferStatus**](TransferStatus.md) |  | 
 **SameDay** | **bool** | When set to true this indicates the transfer should be processed the same day if possible. | [default to false]
-**ReturnCode** | [**ReturnCode**](ReturnCode.md) |  | [optional] 
+**ReturnCode** | Pointer to [**ReturnCode**](ReturnCode.md) |  | [optional] 
 **ProcessedAt** | Pointer to [**time.Time**](time.Time.md) |  | [optional] 
 **Created** | [**time.Time**](time.Time.md) |  | 
 

pkg/client/model_micro_deposits.go

@@ -22,7 +22,6 @@ type MicroDeposits struct {
 	Destination Destination    `json:"destination"`
 	Amounts     []string       `json:"amounts"`
 	Status      TransferStatus `json:"status"`
-	ReturnCode  ReturnCode     `json:"returnCode,omitempty"`
 	ProcessedAt *time.Time     `json:"processedAt,omitempty"`
 	Created     time.Time      `json:"created"`
 }

pkg/client/model_transfer.go

@@ -25,8 +25,8 @@ type Transfer struct {
 	Description string         `json:"description"`
 	Status      TransferStatus `json:"status"`
 	// When set to true this indicates the transfer should be processed the same day if possible.
-	SameDay     bool       `json:"sameDay"`
-	ReturnCode  ReturnCode `json:"returnCode,omitempty"`
-	ProcessedAt *time.Time `json:"processedAt,omitempty"`
-	Created     time.Time  `json:"created"`
+	SameDay     bool        `json:"sameDay"`
+	ReturnCode  *ReturnCode `json:"returnCode,omitempty"`
+	ProcessedAt *time.Time  `json:"processedAt,omitempty"`
+	Created     time.Time   `json:"created"`
 }

pkg/database/mysql.go

@@ -97,6 +97,10 @@ var (
 			"add_processed_at__to__micro_deposits",
 			`alter table micro_deposits add column processed_at datetime;`,
 		),
+		execsql(
+			"drop_micro_deposit_return_code",
+			"alter table micro_deposits drop column return_code;",
+		),
 	)
 )
 

pkg/transfers/repository.go

@@ -127,7 +127,7 @@ limit 1`
 	}
 	if returnCode != nil {
 		if rc := ach.LookupReturnCode(*returnCode); rc != nil {
-			transfer.ReturnCode = client.ReturnCode{
+			transfer.ReturnCode = &client.ReturnCode{
 				Code:        rc.Code,
 				Reason:      rc.Reason,
 				Description: rc.Description,

pkg/validation/microdeposits/repository.go

@@ -8,7 +8,6 @@ import (
 	"database/sql"
 	"strings"
 
-	"github.com/moov-io/ach"
 	"github.com/moov-io/paygate/pkg/client"
 )
 
@@ -36,7 +35,7 @@ func (r *sqlRepo) Close() error {
 }
 
 func (r *sqlRepo) getMicroDeposits(microDepositID string) (*client.MicroDeposits, error) {
-	query := `select micro_deposit_id, destination_customer_id, destination_account_id, amounts, status, return_code, processed_at, created_at from micro_deposits
+	query := `select micro_deposit_id, destination_customer_id, destination_account_id, amounts, status, processed_at, created_at from micro_deposits
 where micro_deposit_id = ? and deleted_at is null limit 1;`
 	stmt, err := r.db.Prepare(query)
 	if err != nil {
@@ -47,7 +46,6 @@ where micro_deposit_id = ? and deleted_at is null limit 1;`
 	row := stmt.QueryRow(microDepositID)
 
 	var amounts string
-	var returnCode *string
 
 	var micro client.MicroDeposits
 	if err := row.Scan(
@@ -56,23 +54,13 @@ where micro_deposit_id = ? and deleted_at is null limit 1;`
 		&micro.Destination.AccountID,
 		&amounts,
 		&micro.Status,
-		&returnCode,
 		&micro.ProcessedAt,
 		&micro.Created,
 	); err != nil {
 		return nil, err
 	}
 
 	micro.Amounts = strings.Split(amounts, "|")
-	if returnCode != nil {
-		if rc := ach.LookupReturnCode(*returnCode); rc != nil {
-			micro.ReturnCode = client.ReturnCode{
-				Code:        rc.Code,
-				Reason:      rc.Reason,
-				Description: rc.Description,
-			}
-		}
-	}
 
 	micro.TransferIDs, err = r.getMicroDepositTransferIDs(microDepositID)
 	if err != nil {
@@ -128,7 +116,7 @@ func (r *sqlRepo) writeMicroDeposits(micro *client.MicroDeposits) error {
 		return err
 	}
 
-	query := `insert into micro_deposits (micro_deposit_id, destination_customer_id, destination_account_id, amounts, status, return_code, created_at) values (?, ?, ?, ?, ?, ?, ?);`
+	query := `insert into micro_deposits (micro_deposit_id, destination_customer_id, destination_account_id, amounts, status, created_at) values (?, ?, ?, ?, ?, ?);`
 	stmt, err := tx.Prepare(query)
 	if err != nil {
 		tx.Rollback()
@@ -142,7 +130,6 @@ func (r *sqlRepo) writeMicroDeposits(micro *client.MicroDeposits) error {
 		micro.Destination.AccountID,
 		strings.Join(micro.Amounts, "|"),
 		micro.Status,
-		micro.ReturnCode.Code,
 		micro.Created,
 	)
 	if err != nil {