<?php
/*
* This file is part of the AuthnetJSON package.
*
* (c) John Conde <stymiee@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/*************************************************************************************************
Retrieves an existing ARB subscription.
SAMPLE REQUEST
--------------------------------------------------------------------------------------------------
{
"ARBGetSubscriptionRequest": {
"merchantAuthentication": {
"name": "",
"transactionKey": ""
},
"refId": "123456",
"subscriptionId": "4818507",
"includeTransactions": true
}
}
SAMPLE RESPONSE
--------------------------------------------------------------------------------------------------
{
"ARBGetSubscriptionResponse": {
"refId": "123456",
"messages": {
"resultCode": "Ok",
"message": {
"code": "I00001",
"text": "Successful."
}
},
"subscription": {
"name": "Sample subscription",
"paymentSchedule": {
"interval": {
"length": "7",
"unit": "days"
},
"startDate": "2017-09-09",
"totalOccurrences": "9999",
"trialOccurrences": "1"
},
"amount": "10.29",
"trialAmount": "1.00",
"status": "active",
"profile": {
"merchantCustomerId": "973",
"description": "Profile description here",
"email": "TestEmail5555@domain.com",
"customerProfileId": "1812912918",
"paymentProfile": {
"customerType": "individual",
"billTo": {
"firstName": "Arte",
"lastName": "Johnson",
"company": "test Co.",
"address": "123 Test St.",
"city": "Testville",
"state": "AZ",
"zip": "85282",
"country": "US"
},
"customerPaymentProfileId": "1807515631",
"payment": {
"creditCard": {
"cardNumber": "XXXX1111",
"expirationDate": "XXXX"
}
}
},
"shippingProfile": {
"firstName": "Aaron",
"lastName": "Wright",
"company": "Testing, Inc.",
"address": "123 Testing St.",
"city": "Lehi",
"state": "UT",
"zip": "84043",
"country": "US",
"phoneNumber": "520-254-5038",
"customerAddressId": "1811684122"
}
},
"arbTransactions": {
"arbTransaction": {
"response": "The credit card has expired.",
"submitTimeUTC": "2017-09-14T18:40:31.247",
"payNum": "2",
"attemptNum": "1"
}
}
}
}
}
*************************************************************************************************/
namespace Authnetjson;
use Exception;
require '../../config.inc.php';
try {
$request = AuthnetApiFactory::getJsonApiHandler(
AUTHNET_LOGIN,
AUTHNET_TRANSKEY,
AuthnetApiFactory::USE_DEVELOPMENT_SERVER
);
$response = $request->ARBGetSubscriptionRequest([
'refId' => 'Sample',
'subscriptionId' => '6662897',
'includeTransactions' => true
]);
} catch (Exception $e) {
echo $e;
exit;
}
?>
<!DOCTYPE html>
<html lang="en">
<head>
<title>ARB :: Get Subscription</title>
<style>
table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
pre { white-space: pre-wrap; }
table th { background: #e5e5e5; color: #666666; }
h1, h2 { text-align: center; }
</style>
</head>
<body>
<h1>
ARB :: Get Subscription
</h1>
<h2>
Results
</h2>
<table>
<tr>
<th>Successful?</th>
<td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
</tr>
<tr>
<th>Error?</th>
<td><?= $response->isError() ? 'yes' : 'no' ?></td>
</tr>
<tr>
<th>Result Code</th>
<td><?= $response->messages->resultCode ?></td>
</tr>
<tr>
<th>Message Code</th>
<td><?= $response->messages->message[0]->code ?></td>
</tr>
<tr>
<th>Message</th>
<td><?= $response->messages->message[0]->text ?></td>
</tr>
<tr>
<th>Name</th>
<td><?= $response->subscription->name ?></td>
</tr>
<tr>
<th>Amount</th>
<td><?= $response->subscription->amount ?></td>
</tr>
<tr>
<th>Trial Amount</th>
<td><?= $response->subscription->trialAmount ?></td>
</tr>
<tr>
<th>Status</th>
<td><?= $response->subscription->status ?></td>
</tr>
<tr>
<th>Payment Schedule Interval Unit</th>
<td><?= $response->subscription->paymentSchedule->interval->unit ?></td>
</tr>
<tr>
<th>Payment Schedule Interval Length</th>
<td><?= $response->subscription->paymentSchedule->interval->length ?></td>
</tr>
<tr>
<th>Payment Schedule Start Date</th>
<td><?= $response->subscription->paymentSchedule->startDate ?></td>
</tr>
<tr>
<th>Payment Schedule Total Occurrences</th>
<td><?= $response->subscription->paymentSchedule->totalOccurrences ?></td>
</tr>
<tr>
<th>Payment Schedule Trial Occurrences</th>
<td><?= $response->subscription->paymentSchedule->trialOccurrences ?></td>
</tr>
<tr>
<th>Profile ID</th>
<td><?= $response->subscription->profile->customerProfileId ?></td>
</tr>
<tr>
<th>Description</th>
<td><?= $response->subscription->profile->description ?></td>
</tr>
<tr>
<th>Payment Profile Id</th>
<td><?= $response->subscription->profile->paymentProfile->customerPaymentProfileId ?></td>
</tr>
<tr>
<th>Customer customerType</th>
<td><?= $response->subscription->profile->paymentProfile->customerPaymentProfileId ?></td>
</tr>
<tr>
<th>Bill To</th>
<td>
First Name: <?= $response->subscription->profile->paymentProfile->billTo->firstName ?><br>
Last Name: <?= $response->subscription->profile->paymentProfile->billTo->lastName ?>
</td>
</tr>
<tr>
<th>ARB Transactions</th>
<td>
<?php foreach ($response->subscription->arbTransactions as $arbTransaction) : ?>
<table>
<tr>
<th>ARB Transaction Response</th>
<td><?= $arbTransaction->response ?></td>
</tr>
<tr>
<th>ARB Transaction Submit Time UTC</th>
<td><?= $arbTransaction->submitTimeUTC ?></td>
</tr>
<tr>
<th>ARB Transaction Pay Num</th>
<td><?= $arbTransaction->payNum ?></td>
</tr>
<tr>
<th>ARB Transaction Attempt Num</th>
<td><?= $arbTransaction->attemptNum ?></td>
</tr>
</table>
<?php endforeach; ?>
</td>
</tr>
</table>
<h2>
Raw Input/Output
</h2>
<?= $request, $response ?>
</body>
</html>
|
Download
