Add endpoint for Shopify Payments transactions

fixtures/payments_transaction.json

@@ -0,0 +1,16 @@
+{
+  "id": 54534554564,
+  "type": "charge",
+  "test": false,
+  "payout_id": 1234,
+  "payout_status": "scheduled",
+  "currency": "USD",
+  "amount": "102.53",
+  "fee": "3.07",
+  "net": "102.53",
+  "source_id": 1234,
+  "source_type": "charge",
+  "source_order_transaction_id": 12,
+  "source_order_id": 1,
+  "processed_at": "2018-03-23T16:32:45Z"
+}

fixtures/payments_transactions.json

@@ -0,0 +1,52 @@
+{
+  "transactions": [
+    {
+      "id": 699519475,
+      "type": "debit",
+      "test": false,
+      "payout_id": 623721858,
+      "payout_status": "paid",
+      "currency": "USD",
+      "amount": "-50.00",
+      "fee": "0.00",
+      "net": "-50.00",
+      "source_id": 460709370,
+      "source_type": "adjustment",
+      "source_order_id": null,
+      "source_order_transaction_id": null,
+      "processed_at": "2013-11-01"
+    },
+    {
+      "id": 77412310,
+      "type": "credit",
+      "test": false,
+      "payout_id": 623721858,
+      "payout_status": "paid",
+      "currency": "USD",
+      "amount": "50.00",
+      "fee": "0.00",
+      "net": "50.00",
+      "source_id": 374511569,
+      "source_type": "Payments::Balance::AdjustmentReversal",
+      "source_order_id": null,
+      "source_order_transaction_id": null,
+      "processed_at": "2013-11-01"
+    },
+    {
+      "id": 1006917261,
+      "type": "refund",
+      "test": false,
+      "payout_id": 623721858,
+      "payout_status": "paid",
+      "currency": "USD",
+      "amount": "-3.45",
+      "fee": "0.00",
+      "net": "-3.45",
+      "source_id": 1006917261,
+      "source_type": "Payments::Refund",
+      "source_order_id": 217130470,
+      "source_order_transaction_id": 1006917261,
+      "processed_at": "2013-11-01"
+    }
+  ]
+}

goshopify.go

@@ -128,6 +128,7 @@ type Client struct {
 	AssignedFulfillmentOrder   AssignedFulfillmentOrderService
 	FulfillmentEvent           FulfillmentEventService
 	FulfillmentRequest         FulfillmentRequestService
+	PaymentsTransactions       PaymentsTransactionsService
 }
 
 // A general response error that follows a similar layout to Shopify's response
@@ -314,6 +315,7 @@ func NewClient(app App, shopName, token string, opts ...Option) *Client {
 	c.AssignedFulfillmentOrder = &AssignedFulfillmentOrderServiceOp{client: c}
 	c.FulfillmentEvent = &FulfillmentEventServiceOp{client: c}
 	c.FulfillmentRequest = &FulfillmentRequestServiceOp{client: c}
+	c.PaymentsTransactions = &PaymentsTransactionsServiceOp{client: c}
 
 	// apply any options
 	for _, opt := range opts {

payments_transactions.go

@@ -0,0 +1,108 @@
+package goshopify
+
+import (
+	"fmt"
+)
+
+const paymentsTransactionsBasePath = "shopify_payments/balance/transactions"
+
+// PaymentsTransactionsService is an interface for interfacing with the PaymentsTransactions endpoints of
+// the Shopify API.
+// See: https://shopify.dev/docs/api/admin-rest/2023-01/resources/transactions
+type PaymentsTransactionsService interface {
+	List(interface{}) ([]PaymentsTransactions, error)
+	ListWithPagination(interface{}) ([]PaymentsTransactions, *Pagination, error)
+	Get(int64, interface{}) (*PaymentsTransactions, error)
+}
+
+// PaymentsTransactionsServiceOp handles communication with the payout related methods of the
+// Shopify API.
+type PaymentsTransactionsServiceOp struct {
+	client *Client
+}
+
+// A struct for all available payout list options
+type PaymentsTransactionsListOptions struct {
+	PageInfo     string       `url:"page_info,omitempty"`
+	Limit        int          `url:"limit,omitempty"`
+	Fields       string       `url:"fields,omitempty"`
+	LastId       int64        `url:"last_id,omitempty"`
+	SinceId      int64        `url:"since_id,omitempty"`
+	PayoutId     int64        `url:"payout_id,omitempty"`
+	PayoutStatus PayoutStatus `url:"payout_status,omitempty"`
+	DateMin      *OnlyDate    `url:"date_min,omitempty"`
+	DateMax      *OnlyDate    `url:"date_max,omitempty"`
+	Date         *OnlyDate    `url:"date,omitempty"`
+}
+
+// PaymentsTransactions represents a Shopify payout
+type PaymentsTransactions struct {
+	ID                       int64                     `json:"id"`
+	Type                     PaymentsTransactionsTypes `json:"type"`
+	Test                     bool                      `json:"test"`
+	PayoutID                 int                       `json:"payout_id"`
+	PayoutStatus             PayoutStatus              `json:"payout_status"`
+	Currency                 string                    `json:"currency"`
+	Amount                   string                    `json:"amount"`
+	Fee                      string                    `json:"fee"`
+	Net                      string                    `json:"net"`
+	SourceID                 int                       `json:"source_id"`
+	SourceType               string                    `json:"source_type"`
+	SourceOrderTransactionID int                       `json:"source_order_transaction_id"`
+	SourceOrderID            int                       `json:"source_order_id"`
+	ProcessedAt              OnlyDate                  `json:"processed_at"`
+}
+
+type PaymentsTransactionsTypes string
+
+const (
+	PaymentsTransactionsCharge             PaymentsTransactionsTypes = "charge"
+	PaymentsTransactionsRefund             PaymentsTransactionsTypes = "refund"
+	PaymentsTransactionsDispute            PaymentsTransactionsTypes = "dispute"
+	PaymentsTransactionsReserve            PaymentsTransactionsTypes = "reserve"
+	PaymentsTransactionsAdjustment         PaymentsTransactionsTypes = "adjustment"
+	PaymentsTransactionsCredit             PaymentsTransactionsTypes = "credit"
+	PaymentsTransactionsDebit              PaymentsTransactionsTypes = "debit"
+	PaymentsTransactionsPayout             PaymentsTransactionsTypes = "payout"
+	PaymentsTransactionsPayoutFailure      PaymentsTransactionsTypes = "payout_failure"
+	PaymentsTransactionsPayoutCancellation PaymentsTransactionsTypes = "payout_cancellation"
+)
+
+// Represents the result from the PaymentsTransactions/X.json endpoint
+type PaymentsTransactionResource struct {
+	PaymentsTransaction *PaymentsTransactions `json:"transaction"`
+}
+
+// Represents the result from the PaymentsTransactions.json endpoint
+type PaymentsTransactionsResource struct {
+	PaymentsTransactions []PaymentsTransactions `json:"transactions"`
+}
+
+// List PaymentsTransactions
+func (s *PaymentsTransactionsServiceOp) List(options interface{}) ([]PaymentsTransactions, error) {
+	PaymentsTransactions, _, err := s.ListWithPagination(options)
+	if err != nil {
+		return nil, err
+	}
+	return PaymentsTransactions, nil
+}
+
+func (s *PaymentsTransactionsServiceOp) ListWithPagination(options interface{}) ([]PaymentsTransactions, *Pagination, error) {
+	path := fmt.Sprintf("%s.json", paymentsTransactionsBasePath)
+	resource := new(PaymentsTransactionsResource)
+
+	pagination, err := s.client.ListWithPagination(path, resource, options)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	return resource.PaymentsTransactions, pagination, nil
+}
+
+// Get individual payout
+func (s *PaymentsTransactionsServiceOp) Get(payoutID int64, options interface{}) (*PaymentsTransactions, error) {
+	path := fmt.Sprintf("%s/%d.json", paymentsTransactionsBasePath, payoutID)
+	resource := new(PaymentsTransactionResource)
+	err := s.client.Get(path, resource, options)
+	return resource.PaymentsTransaction, err
+}

payments_transactions_test.go

@@ -0,0 +1,76 @@
+package goshopify
+
+import (
+	"fmt"
+	"github.com/jarcoal/httpmock"
+	"reflect"
+	"testing"
+	"time"
+)
+
+func TestPaymentsTransactionsList(t *testing.T) {
+	setup()
+	defer teardown()
+
+	httpmock.RegisterResponder("GET", fmt.Sprintf("https://fooshop.myshopify.com/%s/shopify_payments/balance/transactions.json", client.pathPrefix),
+		httpmock.NewBytesResponder(200, loadFixture("payments_transactions.json")))
+	date1 := OnlyDate{time.Date(2013, 11, 01, 0, 0, 0, 0, time.UTC)}
+	paymentsTransactions, err := client.PaymentsTransactions.List(PaymentsTransactionsListOptions{PayoutId: 623721858})
+	if err != nil {
+		t.Errorf("PaymentsTransactions.List returned error: %v", err)
+	}
+
+	expected := []PaymentsTransactions{
+		{
+			ID:                       699519475,
+			Type:                     PaymentsTransactionsDebit,
+			Test:                     false,
+			PayoutID:                 623721858,
+			PayoutStatus:             PayoutStatusPaid,
+			Currency:                 "USD",
+			Amount:                   "-50.00",
+			Fee:                      "0.00",
+			Net:                      "-50.00",
+			SourceID:                 460709370,
+			SourceType:               "adjustment",
+			SourceOrderID:            0,
+			SourceOrderTransactionID: 0,
+			ProcessedAt:              date1,
+		},
+		{
+			ID:                       77412310,
+			Type:                     PaymentsTransactionsCredit,
+			Test:                     false,
+			PayoutID:                 623721858,
+			PayoutStatus:             PayoutStatusPaid,
+			Currency:                 "USD",
+			Amount:                   "50.00",
+			Fee:                      "0.00",
+			Net:                      "50.00",
+			SourceID:                 374511569,
+			SourceType:               "Payments::Balance::AdjustmentReversal",
+			SourceOrderID:            0,
+			SourceOrderTransactionID: 0,
+			ProcessedAt:              date1,
+		},
+		{
+			ID:                       1006917261,
+			Type:                     PaymentsTransactionsRefund,
+			Test:                     false,
+			PayoutID:                 623721858,
+			PayoutStatus:             PayoutStatusPaid,
+			Currency:                 "USD",
+			Amount:                   "-3.45",
+			Fee:                      "0.00",
+			Net:                      "-3.45",
+			SourceID:                 1006917261,
+			SourceType:               "Payments::Refund",
+			SourceOrderID:            217130470,
+			SourceOrderTransactionID: 1006917261,
+			ProcessedAt:              date1,
+		},
+	}
+	if !reflect.DeepEqual(paymentsTransactions, expected) {
+		t.Errorf("PaymentsTransactions.List returned %+v, expected %+v", paymentsTransactions, expected)
+	}
+}