Trouble working with Square Connect ChargeResponse object

Question

I'm able to successfully charge using the transaction API following the example on github. Executing the charge looks like this:

$result = $transaction_api->charge($access_token, $location_id, $request_body);
echo "<pre>";
print_r($result);
echo "</pre>";

Here's the output:

My problem is that, while some places (such as here) indicate that I'm supposed to get an array back from the charge method, I instead get a ChargeResponse object.

Within this object is a transaction object that contains all of the relevant information that I want to display to the customer once the transaction is complete, but it's protected, so trying to echo a transaction id, created_at time, or amount from this returned object fails.

I'm certain I'm doing something wrong, but I'm lost as to how to capture properties from the ChargeResponse object so that I can do useful things with it.

For instance, I've tried

echo($result->transaction['id']);

but all I get is:

Fatal error: Cannot access protected property

This may not even be the right way to attempt something like this, so I'm completely open to suggestions.

The first suggestion gives the same error about not being able to access the protected property and the second and third suggestions do not parse as valid php. — LoneWaffle, May 01 '16 at 02:51

score 9 · Answer 1 · answered May 01 '16 at 23:08

I managed to figure out that one must use the getTransaction method that's included in the object to get a usable form of the properties.

$transaction = $result->getTransaction();

Then you can just get properties out that you want:

$transactionID = $transaction["tenders"][0]["transaction_id"];

I'm rather annoyed that I didn't come across this anywhere in the documentation (in fact a google search of the entire docs.connect.squareup.com doesn't turn up a single reference to getTransaction). I had to stumble upon it when I was trying to reparse the original ChargeResponse object into an array using some other hack job.

Anyway, glad this is resolved. Wanted to leave this here for others.

This getTransaction function is documented in the Square Connect SDK at https://github.com/square/connect-php-sdk/blob/master/lib/Model/ChargeResponse.php#L136 You are right though that there are not many examples yet for actually using their SDK. — Joe, May 04 '16 at 16:10

score 2 · Answer 2 · edited Apr 17 '18 at 02:11

2

This will work.

$transaction_id = $result->getTransaction()->getId();

edited Apr 17 '18 at 02:11

Pang

9,564
146
81
122

answered Jan 13 '17 at 20:58

user3195905

71
1
1

Can you please format your code, and elaborate in more detail why you believe that this answers the question? – Joe C Jan 13 '17 at 22:12

score 2 · Answer 3 · edited Feb 14 '19 at 03:22

I came here with the same problem and then I had an aha moment.

Rather than point out a few of the function calls, here's how to find them all.

Simply look into the square library files that you have implemented in your solution. In this case "Transaction.php" found in the "model" folder.

Rinse and repeat for all the other objects (IE: Tenders.php).

I hope this saves time for some people because I wasted far too much before figuring it out.

Verbatim from Transaction.php

'id' => 'getId',
'location_id' => 'getLocationId',
'created_at' => 'getCreatedAt',
'tenders' => 'getTenders',
'refunds' => 'getRefunds',
'reference_id' => 'getReferenceId',
'product' => 'getProduct',
'client_id' => 'getClientId',
'shipping_address' => 'getShippingAddress',
'order_id' => 'getOrderId'

score 1 · Answer 4 · answered Sep 11 '19 at 11:21

If anyone looking for code with square connects v2 API than using this:

$payments_api = new \SquareConnect\Api\PaymentsApi($api_client);
$result = $payments_api->createPayment($request_body);
echo '<br/>';

// to get ID.
print_r( $result->getPayment()->getId() );
echo '<br/>';

// to get Reference ID.
print_r( $result->getPayment()->getReferenceId() );
echo '<br/>';

// to get Amount.
print_r( $result->getPayment()->getAmountMoney()->getAmount() );
echo '<br/>';

// to get Currency.
print_r( $result->getPayment()->getAmountMoney()->getCurrency() );
echo '<br/>';

// to get CreatedAt datetime.
print_r( $result->getPayment()->getCreatedAt() );

score 0 · Answer 5 · answered Nov 25 '19 at 10:44

If you install square connect through composer then you can use its pre-defined functions. $data holds the request for transaction

$body = new \SquareConnect\Model\ChargeRequest($data);
$transaction = $transactions_api->charge($location_id, $body);
$transactionId = $transaction->getTransaction()->getId();

Now you will be having transaction id in $transactionId variable.

score 0 · Answer 6 · edited Jan 15 '20 at 13:59

0

$result = $payments_api->createPayment($request_body);

print_r($result->getPayment()->getStatus());

print_r( $result->getPayment()->getId() );

print_r( $result->getPayment()->getReferenceId() );

print_r( $result->getPayment()->getAmountMoney()->getAmount() );

print_r( $result->getPayment()->getAmountMoney()->getCurrency() );

print_r( $result->getPayment()->getCreatedAt() );

edited Jan 15 '20 at 13:59

Dharman

30,962
25
85
135

answered Jan 15 '20 at 13:54

Jitendra

9
8

You should add some explanation. What's going on and how does this answer the question? – m02ph3u5 Jan 15 '20 at 14:13

Trouble working with Square Connect ChargeResponse object

6 Answers6

Verbatim from Transaction.php