├── .editorconfig
├── .github
    └── workflows
    │   └── php.yml
├── CHANGELOG
├── CONTRIBUTING.md
├── HELP.md
├── README.md
├── SECURITY.md
├── build
    ├── coverage
    │   └── .keep
    ├── insights
    │   └── .keep
    ├── phpcs
    │   └── .keep
    └── phpmd
    │   └── .keep
├── composer.json
├── config.inc.php.dist
├── examples
    ├── acceptjs
    │   ├── getHostedPaymentPageRequest.php
    │   ├── getHostedProfilePageRequest.php
    │   └── selfHostedPaymentForm.php
    ├── aim
    │   ├── authenticateTestRequest.php
    │   ├── createTransactionRequest_authCapture.php
    │   ├── createTransactionRequest_authOnly.php
    │   ├── createTransactionRequest_captureOnly.php
    │   ├── createTransactionRequest_partialAuth.php
    │   ├── createTransactionRequest_paypalAuthCapture.php
    │   ├── createTransactionRequest_paypalAuthCaptureContinue.php
    │   ├── createTransactionRequest_paypalAuthOnly.php
    │   ├── createTransactionRequest_paypalAuthOnlyContinue.php
    │   ├── createTransactionRequest_paypalGetDetails.php
    │   ├── createTransactionRequest_paypalPriorAuthCapture.php
    │   ├── createTransactionRequest_paypalRefund.php
    │   ├── createTransactionRequest_paypalVoid.php
    │   ├── createTransactionRequest_priorAuthCapture.php
    │   ├── createTransactionRequest_refund.php
    │   ├── createTransactionRequest_visaCheckout.php
    │   ├── createTransactionRequest_void.php
    │   ├── decryptPaymentDataRequest.php
    │   └── sendCustomerTransactionReceiptRequest.php
    ├── arb
    │   ├── ARBCancelSubscriptionRequest.php
    │   ├── ARBCreateSubscriptionRequest.php
    │   ├── ARBCreateSubscriptionRequestFromProfile.php
    │   ├── ARBGetSubscriptionListRequest.php
    │   ├── ARBGetSubscriptionRequest.php
    │   ├── ARBGetSubscriptionStatusRequest.php
    │   └── ARBUpdateSubscriptionRequest.php
    ├── cim
    │   ├── createCustomerPaymentProfileRequest.php
    │   ├── createCustomerProfileRequest.php
    │   ├── createCustomerProfileRequestMultiplePayAccounts.php
    │   ├── createCustomerProfileTransactionRequest_authCapture.php
    │   ├── createCustomerProfileTransactionRequest_authOnly.php
    │   ├── createCustomerProfileTransactionRequest_captureOnly.php
    │   ├── createCustomerProfileTransactionRequest_priorAuthCapture.php
    │   ├── createCustomerProfileTransactionRequest_refund.php
    │   ├── createCustomerProfileTransactionRequest_void.php
    │   ├── createCustomerShippingAddressRequest.php
    │   ├── deleteCustomerPaymentProfileRequest.php
    │   ├── deleteCustomerProfileRequest.php
    │   ├── deleteCustomerShippingAddressRequest.php
    │   ├── getCustomerPaymentProfileRequest.php
    │   ├── getCustomerProfileIdsRequest.php
    │   ├── getCustomerProfileRequest.php
    │   ├── getCustomerShippingAddressRequest.php
    │   ├── getHostedProfilePageRequest.php
    │   ├── updateCustomerPaymentProfileRequest.php
    │   ├── updateCustomerProfileRequest.php
    │   ├── updateCustomerShippingAddressRequest.php
    │   ├── updateSplitTenderGroupRequest.php
    │   └── validateCustomerPaymentProfileRequest.php
    ├── fraud
    │   ├── getUnsettledTransactionListRequest.php
    │   └── updateHeldTransactionRequest.php
    ├── reporting
    │   ├── getAUJobDetailsRequest.php
    │   ├── getAUJobSummaryRequest.php
    │   ├── getBatchStatisticsRequest.php
    │   ├── getMerchantDetailsRequest.php
    │   ├── getSettledBatchListRequest.php
    │   ├── getTransactionDetailsRequest.php
    │   ├── getTransactionListRequest.php
    │   └── getUnsettledTransactionListRequest.php
    ├── sim
    │   └── sim.php
    └── webhooks
    │   ├── createWebhook.php
    │   ├── deleteWebhook.php
    │   ├── getEventTypes.php
    │   ├── getWebhook.php
    │   ├── listWebhooks.php
    │   ├── notificationHistory.php
    │   ├── ping.php
    │   └── updateWebhook.php
├── license.txt
├── phpdoc.xml
├── phpunit.xml
├── src
    └── Authnetjson
    │   ├── AuthnetAcceptJs.php
    │   ├── AuthnetApiFactory.php
    │   ├── AuthnetJson.php
    │   ├── AuthnetJsonRequest.php
    │   ├── AuthnetJsonResponse.php
    │   ├── AuthnetSim.php
    │   ├── AuthnetWebhook.php
    │   ├── AuthnetWebhooksRequest.php
    │   ├── AuthnetWebhooksResponse.php
    │   ├── Exception
    │       ├── AuthnetCannotSetParamsException.php
    │       ├── AuthnetCurlException.php
    │       ├── AuthnetException.php
    │       ├── AuthnetInvalidAmountException.php
    │       ├── AuthnetInvalidCredentialsException.php
    │       ├── AuthnetInvalidJsonException.php
    │       ├── AuthnetInvalidServerException.php
    │       └── AuthnetTransactionResponseCallException.php
    │   └── TransactionResponse.php
└── tests
    └── Authnetjson
        ├── AuthnetApiFactoryTest.php
        ├── AuthnetJsonAimPaypalTest.php
        ├── AuthnetJsonAimTest.php
        ├── AuthnetJsonArbTest.php
        ├── AuthnetJsonCimTest.php
        ├── AuthnetJsonReportingTest.php
        ├── AuthnetJsonRequestTest.php
        ├── AuthnetJsonResponseTest.php
        ├── AuthnetSimTest.php
        ├── AuthnetWebhookTest.php
        ├── AuthnetWebhooksRequestTest.php
        ├── AuthnetWebhooksResponseTest.php
        └── TransactionResponseTest.php


/.editorconfig:
--------------------------------------------------------------------------------
 1 | root = true
 2 | 
 3 | [*]
 4 | charset = utf-8
 5 | end_of_line = lf
 6 | indent_style = space
 7 | indent_size = 4
 8 | insert_final_newline = true
 9 | trim_trailing_whitespace = true
10 | 
11 | [*.md]
12 | trim_trailing_whitespace = false
13 | 
14 | [*.php]
15 | indent_style = space
16 | indent_size = 4
17 | end_of_line = lf
18 | charset = utf-8
19 | trim_trailing_whitespace = true
20 | insert_final_newline = true
21 | max_line_length = 120
22 | 


--------------------------------------------------------------------------------
/.github/workflows/php.yml:
--------------------------------------------------------------------------------
 1 | name: Build
 2 | 
 3 | on:
 4 |   push:
 5 |     branches: [ master ]
 6 |   pull_request:
 7 |     branches: [ master ]
 8 | 
 9 | jobs:
10 |   build:
11 | 
12 |     runs-on: ubuntu-latest
13 | 
14 |     steps:
15 |     - uses: actions/checkout@v2
16 | 
17 |     - uses: shivammathur/setup-php@v2
18 |       with:
19 |         php-version: '7.4'
20 | 
21 |     - name: Validate composer.json and composer.lock
22 |       run: composer validate
23 | 
24 |     - name: Suppress composer error message
25 |       run: composer config --no-plugins allow-plugins.dealerdirect/phpcodesniffer-composer-installer true
26 | 
27 |     - name: Install dependencies
28 |       run: composer install --prefer-dist --no-progress
29 | 
30 |     # Add a test script to composer.json, for instance: "test": "vendor/bin/phpunit"
31 |     # Docs: https://getcomposer.org/doc/articles/scripts.md
32 | 
33 |     - name: Run test suite
34 |       run: composer run-script test
35 | 
36 |     - name: Run PHP Code Sniffer
37 |       run: composer run-script phpcs
38 | 
39 |     - name: Run PHP Mess Detecter
40 |       run: composer run-script phpmd
41 | 


--------------------------------------------------------------------------------
/CONTRIBUTING.md:
--------------------------------------------------------------------------------
 1 | # Contributing
 2 | 
 3 | When contributing to this repository, please first discuss the change you wish to make via issue,
 4 | email, or any other method with the owners of this repository before making a change. 
 5 | 
 6 | Please note we have a code of conduct, please follow it in all your interactions with the project.
 7 | 
 8 | ## Code of Conduct
 9 | 
10 | ### Our Pledge
11 | 
12 | In the interest of fostering an open and welcoming environment, we as
13 | contributors and maintainers pledge to making participation in our project and
14 | our community a harassment-free experience for everyone, regardless of age, body
15 | size, disability, ethnicity, gender identity and expression, level of experience,
16 | nationality, personal appearance, race, religion, or sexual identity and
17 | orientation.
18 | 
19 | ### Our Standards
20 | 
21 | Examples of behavior that contributes to creating a positive environment
22 | include:
23 | 
24 | * Using welcoming and inclusive language
25 | * Being respectful of differing viewpoints and experiences
26 | * Gracefully accepting constructive criticism
27 | * Focusing on what is best for the community
28 | * Showing empathy towards other community members
29 | 
30 | Examples of unacceptable behavior by participants include:
31 | 
32 | * The use of sexualized language or imagery and unwelcome sexual attention or
33 | advances
34 | * Trolling, insulting/derogatory comments, and personal or political attacks
35 | * Public or private harassment
36 | * Publishing others' private information, such as a physical or electronic
37 |   address, without explicit permission
38 | * Other conduct which could reasonably be considered inappropriate in a
39 |   professional setting
40 | 
41 | ### Our Responsibilities
42 | 
43 | Project maintainers are responsible for clarifying the standards of acceptable
44 | behavior and are expected to take appropriate and fair corrective action in
45 | response to any instances of unacceptable behavior.
46 | 
47 | Project maintainers have the right and responsibility to remove, edit, or
48 | reject comments, commits, code, wiki edits, issues, and other contributions
49 | that are not aligned to this Code of Conduct, or to ban temporarily or
50 | permanently any contributor for other behaviors that they deem inappropriate,
51 | threatening, offensive, or harmful.
52 | 
53 | ### Scope
54 | 
55 | This Code of Conduct applies both within project spaces and in public spaces
56 | when an individual is representing the project or its community. Examples of
57 | representing a project or community include using an official project e-mail
58 | address, posting via an official social media account, or acting as an appointed
59 | representative at an online or offline event. Representation of a project may be
60 | further defined and clarified by project maintainers.
61 | 
62 | ### Enforcement
63 | 
64 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
65 | reported by contacting the project team at stymiee@gmail.com. All
66 | complaints will be reviewed and investigated and will result in a response that
67 | is deemed necessary and appropriate to the circumstances. The project team is
68 | obligated to maintain confidentiality with regard to the reporter of an incident.
69 | Further details of specific enforcement policies may be posted separately.
70 | 
71 | Project maintainers who do not follow or enforce the Code of Conduct in good
72 | faith may face temporary or permanent repercussions as determined by other
73 | members of the project's leadership.
74 | 
75 | ### Attribution
76 | 
77 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
78 | available at [http://contributor-covenant.org/version/1/4][version]
79 | 
80 | [homepage]: http://contributor-covenant.org
81 | [version]: http://contributor-covenant.org/version/1/4/
82 | 


--------------------------------------------------------------------------------
/HELP.md:
--------------------------------------------------------------------------------
 1 | # Help
 2 | 
 3 | Here are some tips, solutions to common problems, and guides for testing.
 4 | 
 5 | ## Tips
 6 | 
 7 | ### Create a Sandbox Account
 8 | 
 9 | Before doing any development for the Authorize.Net suite of APIs, be sure to create a 
10 | [Sandbox Account](https://developer.authorize.net/hello_world/sandbox/) with Authorize.Net. With it you can simulate 
11 | virtually every aspect of the Authorize.Net production APIs without incurring any fees.
12 | 
13 | ### Use a webhook testing site to test webhooks
14 | 
15 | Having a full understanding of what a webhook looks like makes working with webhooks easier. You can inspect an 
16 | Authorize.Net webhook using a third party service like [webhook.site](https://webhook.site/).
17 | 
18 | ## FAQ
19 | 
20 | Solutions to common problems when integrating the [AuthnetJSON](https://github.com/stymiee/authnetjson) library into 
21 | your project.
22 | 
23 | ### php://input is empty, POST is empty, webhook has no data
24 | This may happen because a redirect occurred and steps were not taken to persist that data across the redirect. 
25 | Look for redirects to HTTPS or to/from the `www` subdomain in your .htaccess or web.config file. 
26 | 
27 | ### Class 'authnet\className' not found
28 | - This may happen if you did not include the Composer autoload.php file in your project
29 | 
30 |       require __DIR__.'/vendor/autoload.php';
31 | 
32 | ## Support
33 | 
34 | If you require assistance using this library I can be found at Stack Overflow. Be sure when you
35 | [ask a question](http://stackoverflow.com/questions/ask?tags=php,authorize.net) pertaining to the usage of
36 | this class to tag your question with the **PHP** and **Authorize.Net** tags. Make sure you follow their
37 | [guide for asking a good question](http://stackoverflow.com/help/how-to-ask) as poorly asked questions will be closed
38 | and I will not be able to assist you.
39 | 
40 | **Do not use Stack Overflow to report bugs.** Bugs may be reported [here](https://github.com/stymiee/authnetjson/issues/new).
41 | 
42 | ## Helpful Links
43 | 
44 | * [Authorize.Net Developer Guides](https://developer.authorize.net/api/)
45 | * [Authorize.Net Testing Guide](https://developer.authorize.net/hello_world/testing_guide/)
46 | * [Response Codes](https://developer.authorize.net/api/reference/responseCodes.html)
47 | 


--------------------------------------------------------------------------------
/SECURITY.md:
--------------------------------------------------------------------------------
 1 | # Security Policy
 2 | 
 3 | ## Supported Versions
 4 | 
 5 | The following versions of AuthnetJSON are currently being supported with security updates.
 6 | 
 7 | | Version | Supported          |
 8 | | ------- | ------------------ |
 9 | | 4.0.x   | :white_check_mark: |
10 | | 3.1.x   | :white_check_mark: |
11 | | < 3.1   | :x:                |
12 | 
13 | ## Reporting a Vulnerability
14 | 
15 | To report a security vulnerability please email me at stymiee@gmail.com.
16 | 


--------------------------------------------------------------------------------
/build/coverage/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/stymiee/authnetjson/17546b05ef98be07cb2e32a16a578ac0b9dd47cf/build/coverage/.keep


--------------------------------------------------------------------------------
/build/insights/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/stymiee/authnetjson/17546b05ef98be07cb2e32a16a578ac0b9dd47cf/build/insights/.keep


--------------------------------------------------------------------------------
/build/phpcs/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/stymiee/authnetjson/17546b05ef98be07cb2e32a16a578ac0b9dd47cf/build/phpcs/.keep


--------------------------------------------------------------------------------
/build/phpmd/.keep:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/stymiee/authnetjson/17546b05ef98be07cb2e32a16a578ac0b9dd47cf/build/phpmd/.keep


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "stymiee/authnetjson",
 3 |     "type": "library",
 4 |     "description": "Library that abstracts Authorize.Net's JSON APIs. This includes the Advanced Integration Method (AIM), Automated Recurring Billing (ARB), Customer Information Manager (CIM), Transaction Reporting, Simple Integration Method (SIM), and Webhooks.",
 5 |     "keywords": [
 6 |         "PHP",
 7 |         "authnetjson",
 8 |         "Authorize.Net",
 9 |         "JSON",
10 |         "json-api",
11 |         "webhook",
12 |         "capture-transaction",
13 |         "authorize-net",
14 |         "authorizenet",
15 |         "authnet",
16 |         "payment",
17 |         "payment-gateway"
18 |     ],
19 |     "homepage": "https://github.com/stymiee/authnetjson",
20 |     "license": "Apache-2.0",
21 |     "authors": [
22 |         {
23 |             "name": "John Conde",
24 |             "email": "stymiee@gmail.com",
25 |             "homepage": "https://stymiee.dev",
26 |             "role": "Developer"
27 |         }
28 |     ],
29 |     "require": {
30 |         "php": ">=7.2.0",
31 |         "curl/curl": "^2",
32 |         "ext-curl": "*",
33 |         "ext-json": "*"
34 |     },
35 |     "require-dev": {
36 |         "phpunit/phpunit": "^8",
37 |         "squizlabs/php_codesniffer": "3.*",
38 |         "phpmd/phpmd" : "@stable",
39 |         "nunomaduro/phpinsights": "@stable"
40 |     },
41 |     "autoload": {
42 |         "psr-4": {
43 |             "Authnetjson\\": [
44 |                 "src/Authnetjson/"
45 |             ]
46 |         }
47 |     },
48 |     "scripts": {
49 |         "test": "phpunit",
50 |         "phpcs": "php vendor/squizlabs/php_codesniffer/bin/phpcs ./src --report-file=build/phpcs/report.txt --runtime-set ignore_warnings_on_exit 1 --runtime-set ignore_errors_on_exit 1",
51 |         "phpmd": "php vendor/phpmd/phpmd/src/bin/phpmd src/ html cleancode --reportfile build/phpmd/report.html --ignore-violations-on-exit",
52 |         "insights": ".\\vendor\\bin\\phpinsights.bat analyse src --format=console > build/insights/report.txt"
53 |     }
54 | }
55 | 


--------------------------------------------------------------------------------
/config.inc.php.dist:
--------------------------------------------------------------------------------
 1 | <?php
 2 |     /*
 3 |      * This file is NOT required to use the AuthnetJson package.
 4 |      * It exists solely for the examples to work "out of the box".
 5 |      */
 6 | 
 7 |     require(__DIR__ . '/vendor/autoload.php');
 8 | 
 9 |     defined('AUTHNET_LOGIN')     || define('AUTHNET_LOGIN', '');
10 |     defined('AUTHNET_TRANSKEY')  || define('AUTHNET_TRANSKEY', '');
11 |     defined('AUTHNET_SIGNATURE') || define('AUTHNET_SIGNATURE', '');
12 | 
13 |     if (version_compare(PHP_VERSION, '7.2.0') < 0) {
14 |         throw new \RuntimeException('AuthnetJson requires PHP 7.2 or greater');
15 |     }
16 | 


--------------------------------------------------------------------------------
/examples/acceptjs/getHostedProfilePageRequest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*************************************************************************************************
 4 | 
 5 | Use this function to initiate a request for direct access to the Authorize.Net website.
 6 | 
 7 | SAMPLE REQUEST
 8 | --------------------------------------------------------------------------------------------------
 9 | {
10 |     "getHostedProfilePageRequest": {
11 |         "merchantAuthentication": {
12 |             "name": "5KP3u95bQpv",
13 |             "transactionKey": "346HZ32z3fP4hTG2"
14 |         },
15 |         "customerProfileId": "YourProfileID",
16 |         "hostedProfileSettings": {
17 |             "setting": [
18 |                 {
19 |                     "settingName": "hostedProfileReturnUrl",
20 |                     "settingValue": "https://returnurl.com/return/"
21 |                 },
22 |                 {
23 |                     "settingName": "hostedProfileReturnUrlText",
24 |                     "settingValue": "Continue to confirmation page."
25 |                 },
26 |                 {
27 |                     "settingName": "hostedProfilePageBorderVisible",
28 |                     "settingValue": "true"
29 |                 }
30 |             ]
31 |         }
32 |     }
33 | }
34 | 
35 | SAMPLE RESPONSE
36 | --------------------------------------------------------------------------------------------------
37 | {
38 |     "token": "e3X1JmlCM01EV4HVLqJhdbfStNUmKMkeQ/bm+jBGrFwpeLnaX3E6wmquJZtLXEyMHlcjhNPx471VoGzyrYF1/VIDKk/qcDKT9BShN64Noft0toiYq07nn1CD+w4AzK2kwpSJkjS3I92h9YompnDXSkPKJWopwUesi6n/trJ96CP/m4rf4Xv6vVQqS0DEu+e+foNGkobJwjop2qHPYOp6e+oNGNIYcGYc06VkwE3kQ+ZbBpBhlkKRYdjJdBYRwdSRtcE7YPia2ENTFGNuMYZvFv7rBaoBftWMvapK7Leb1QcE1uQ+t/9X0wlamazbJmubdiE4Gg5GSiFFeVMcMEhUGJyloDCkTzY/Yv1tg0kAK7GfLXLcD+1pwu+YAR4MasCwnFMduwOc3sFOEWmhnU/cvQ==",
39 |     "messages": {
40 |         "resultCode": "Ok",
41 |         "message": [
42 |             {
43 |                 "code": "I00001",
44 |                 "text": "Successful."
45 |             }
46 |         ]
47 |     }
48 | }
49 | 
50 |  *************************************************************************************************/
51 | 
52 | namespace Authnetjson;
53 | 
54 | use Exception;
55 | 
56 | require '../../config.inc.php';
57 | 
58 | try {
59 |     $request = AuthnetApiFactory::getJsonApiHandler(
60 |         AUTHNET_LOGIN,
61 |         AUTHNET_TRANSKEY,
62 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
63 |     );
64 |     $response = $request->getHostedProfilePageRequest([
65 |         "customerProfileId" => "1511887405",
66 |         "hostedProfileSettings" => [
67 |             "setting" => [[
68 |                 "settingName" => "hostedProfileReturnUrl",
69 |                 "settingValue" => "https://returnurl.com/return/"
70 |             ], [
71 |                 "settingName" => "hostedProfileReturnUrlText",
72 |                 "settingValue" => "Continue to confirmation page."
73 |             ], [
74 |                 "settingName" => "hostedProfilePageBorderVisible",
75 |                 "settingValue" => "true"
76 |             ]]
77 |         ]
78 |     ]);
79 | } catch (Exception $e) {
80 |     echo $e;
81 |     exit;
82 | }
83 | ?>
84 | 
85 | <!doctype html>
86 | <html lang="en">
87 | <head>
88 |     <meta charset="utf-8">
89 |     <title>Hosted Accept.js Payment Form</title>
90 | </head>
91 | <body>
92 |     <form id="paymentForm" method="POST" action="<?= AuthnetAcceptJs::PRODUCTION_HOSTED_CIM_URL ?>">
93 |         <input type="hidden" name="token" id="token" value="<?= $response->token ?>" />
94 |         <button>Go to Authorize.Net hosted payment form</button>
95 |     </form>
96 | </body>
97 | </html>
98 | 


--------------------------------------------------------------------------------
/examples/aim/authenticateTestRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Use the AIM JSON API to process an Authorization and Capture transaction (Sale)
 15 | 
 16 | SAMPLE REQUEST
 17 | --------------------------------------------------------------------------------------------------
 18 | {
 19 |    "createTransactionRequest":{
 20 |       "merchantAuthentication":{
 21 |          "name":"5KP3u95bQpv",
 22 |          "transactionKey":"346HZ32z3fP4hTG2"
 23 |       }
 24 |    }
 25 | }
 26 | 
 27 | SAMPLE RESPONSE
 28 | --------------------------------------------------------------------------------------------------
 29 | {
 30 | "messages": {
 31 |     "resultCode": "Ok",
 32 |     "message": [
 33 |         {
 34 |             "code": "I00001",
 35 |             "text": "Successful."
 36 |         }
 37 |     ]
 38 | }
 39 | 
 40 | *************************************************************************************************/
 41 | 
 42 | namespace Authnetjson;
 43 | 
 44 | use Exception;
 45 | 
 46 | require '../../config.inc.php';
 47 | 
 48 | try {
 49 |     $request = AuthnetApiFactory::getJsonApiHandler(
 50 |         AUTHNET_LOGIN,
 51 |         AUTHNET_TRANSKEY,
 52 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 53 |     );
 54 |     $response = $request->authenticateTestRequest();
 55 | } catch (Exception $e) {
 56 |     echo $e;
 57 |     exit;
 58 | }
 59 | ?>
 60 | 
 61 | <!DOCTYPE html>
 62 | <html lang="en">
 63 | <head>
 64 |     <title>Authenticate Credentials</title>
 65 |     <style>
 66 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 67 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 68 |         pre { white-space: pre-wrap; }
 69 |         table th { background: #e5e5e5; color: #666666; }
 70 |         h1, h2 { text-align: center; }
 71 |     </style>
 72 | </head>
 73 | <body>
 74 |     <h1>
 75 |         Payment :: Authorize and Capture (AUTH_CAPTURE)
 76 |     </h1>
 77 |     <h2>
 78 |         Results
 79 |     </h2>
 80 |     <table>
 81 |         <tr>
 82 |             <th>Response</th>
 83 |             <td><?= $response->messages->resultCode ?></td>
 84 |         </tr>
 85 |         <tr>
 86 |             <th>Successful?</th>
 87 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 88 |         </tr>
 89 |         <tr>
 90 |             <th>Error?</th>
 91 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
 92 |         </tr>
 93 |         <?php if ($response->isError()) : ?>
 94 |         <tr>
 95 |             <th>Error Code</th>
 96 |             <td><?= $response->getErrorCode() ?></td>
 97 |         </tr>
 98 |         <tr>
 99 |             <th>Error Message</th>
100 |             <td><?=  $response->getErrorText() ?></td>
101 |         </tr>
102 |         <?php endif; ?>
103 |     </table>
104 |     <h2>
105 |         Raw Input/Output
106 |     </h2>
107 | <?= $request, $response ?>
108 | </body>
109 | </html>
110 | 


--------------------------------------------------------------------------------
/examples/aim/createTransactionRequest_paypalAuthOnly.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | 
  4 | /*
  5 |  * This file is part of the AuthnetJSON package.
  6 |  *
  7 |  * (c) John Conde <stymiee@gmail.com>
  8 |  *
  9 |  * For the full copyright and license information, please view the LICENSE
 10 |  * file that was distributed with this source code.
 11 |  */
 12 | 
 13 | /*************************************************************************************************
 14 | 
 15 | Use the AIM JSON API to process an Auth Only transaction through Paypal
 16 | 
 17 | SAMPLE REQUEST
 18 | --------------------------------------------------------------------------------------------------
 19 | {
 20 |     "createTransactionRequest": {
 21 |         "merchantAuthentication": {
 22 |             "name": "cnpdev4289",
 23 |             "transactionKey": "SR2P8g4jdEn7vFLQ"
 24 |         },
 25 |         "transactionRequest": {
 26 |             "transactionType": "authOnlyTransaction",
 27 |             "amount": "5",
 28 |             "payment": {
 29 |                 "payPal": {
 30 |                     "successUrl": "https://my.server.com/success.html",
 31 |                     "cancelUrl": "https://my.server.com/cancel.html"
 32 |                 }
 33 |             }
 34 |         }
 35 |     }
 36 | }
 37 | 
 38 | SAMPLE RESPONSE
 39 | --------------------------------------------------------------------------------------------------
 40 | {
 41 |     "transactionResponse": {
 42 |         "responseCode": "5",
 43 |         "rawResponseCode": "0",
 44 |         "transId": "2149186954",
 45 |         "refTransID": "",
 46 |         "transHash": "A719785EE9752530FDCE67695E9A56EE",
 47 |         "testRequest": "0",
 48 |         "accountType": "PayPal",
 49 |         "messages": [
 50 |             {
 51 |                 "code": "2000",
 52 |                 "description": "Need payer consent."
 53 |             }
 54 |         ],
 55 |         "secureAcceptance": {
 56 |             "SecureAcceptanceUrl": "https://www.sandbox.paypal.com/cgi-bin/webscr?cmd=_express-checkout&token=EC-C506B0LGTG2J800OK"
 57 |         }
 58 |     },
 59 |     "messages": {
 60 |         "resultCode": "Ok",
 61 |         "message": [
 62 |             {
 63 |                 "code": "I00001",
 64 |                 "text": "Successful."
 65 |             }
 66 |         ]
 67 |     }
 68 | }
 69 | 
 70 | *************************************************************************************************/
 71 | 
 72 | namespace Authnetjson;
 73 | 
 74 | use Exception;
 75 | 
 76 | require '../../config.inc.php';
 77 | 
 78 | try {
 79 |     $request = AuthnetApiFactory::getJsonApiHandler(
 80 |         AUTHNET_LOGIN,
 81 |         AUTHNET_TRANSKEY,
 82 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 83 |     );
 84 |     $response = $request->createTransactionRequest([
 85 |         'transactionRequest' => [
 86 |             'transactionType' => 'authOnlyTransaction',
 87 |             'amount' => 5,
 88 |             'payment' => [
 89 |                 'payPal' => [
 90 |                     'successUrl' => 'https://my.server.com/success.html',
 91 |                     'cancelUrl' => 'https://my.server.com/cancel.html'
 92 |                 ]
 93 |             ]
 94 |         ]
 95 |     ]);
 96 | } catch (Exception $e) {
 97 |     echo $e;
 98 |     exit;
 99 | }
100 | ?>
101 | 
102 | <!DOCTYPE html>
103 | <html lang="en">
104 | <head>
105 |     <title>Payment :: Paypal :: Authorize Only</title>
106 |     <style>
107 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
108 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
109 |         pre { white-space: pre-wrap; }
110 |         table th { background: #e5e5e5; color: #666666; }
111 |         h1, h2 { text-align: center; }
112 |     </style>
113 | </head>
114 | <body>
115 |     <h1>
116 |         Payment :: Paypal :: Authorize Only
117 |     </h1>
118 |     <h2>
119 |         Results
120 |     </h2>
121 |     <table>
122 |         <tr>
123 |             <th>Response</th>
124 |             <td><?= $response->messages->resultCode ?></td>
125 |         </tr>
126 |         <tr>
127 |             <th>Successful?</th>
128 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
129 |         </tr>
130 |         <tr>
131 |             <th>Error?</th>
132 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
133 |         </tr>
134 |         <?php if ($response->isSuccessful()) : ?>
135 |         <tr>
136 |             <th>Description</th>
137 |             <td><?= $response->transactionResponse->messages[0]->description ?></td>
138 |         </tr>
139 |         <tr>
140 |             <th>Authorization Code</th>
141 |             <td><?= $response->transactionResponse->authCode ?></td>
142 |         </tr>
143 |         <tr>
144 |             <th>Transaction ID</th>
145 |             <td><?= $response->transactionResponse->transId ?></td>
146 |         </tr>
147 |         <tr>
148 |             <th>Reference Transaction ID</th>
149 |             <td><?= $response->transactionResponse->refTransID ?></td>
150 |         </tr>
151 |         <tr>
152 |             <th>Transaction Hash</th>
153 |             <td><?= $response->transactionResponse->transHash ?></td>
154 |         </tr>
155 |         <tr>
156 |             <th>Is Test Request?</th>
157 |             <td><?= $response->transactionResponse->testRequest ? 'yes' : 'no' ?></td>
158 |         </tr>
159 |         <tr>
160 |             <th>Account Type</th>
161 |             <td><?= $response->transactionResponse->accountType ?></td>
162 |         </tr>
163 |         <?php elseif ($response->isError()) : ?>
164 |         <tr>
165 |             <th>Error Code</th>
166 |             <td><?= $response->getErrorCode() ?></td>
167 |         </tr>
168 |         <tr>
169 |             <th>Error Message</th>
170 |             <td><?= $response->getErrorText() ?></td>
171 |         </tr>
172 |         <?php endif; ?>
173 |     </table>
174 |     <h2>
175 |         Raw Input/Output
176 |     </h2>
177 | <?= $request, $response ?>
178 | </body>
179 | </html>
180 | 


--------------------------------------------------------------------------------
/examples/aim/createTransactionRequest_paypalGetDetails.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Use the AIM JSON API to process a Get Details transaction through Paypal
 15 | 
 16 | SAMPLE REQUEST
 17 | --------------------------------------------------------------------------------------------------
 18 | {
 19 |     "createTransactionRequest": {
 20 |         "merchantAuthentication": {
 21 |             "name": "cnpdev4289",
 22 |             "transactionKey": "SR2P8g4jdEn7vFLQ"
 23 |         },
 24 |         "transactionRequest": {
 25 |             "transactionType": "getDetailsTransaction",
 26 |             "refTransId": "128"
 27 |         }
 28 |     }
 29 | }
 30 | 
 31 | SAMPLE RESPONSE
 32 | --------------------------------------------------------------------------------------------------
 33 | {
 34 |     "transactionResponse": {
 35 |         "responseCode": "1",
 36 |         "authCode": "HH5414",
 37 |         "avsResultCode": "P",
 38 |         "cvvResultCode": "",
 39 |         "cavvResultCode": "",
 40 |         "transId": "2149186848",
 41 |         "refTransID": "2149186848",
 42 |         "transHash": "D3A855F0934EB404DE3B13508D0E3826",
 43 |         "testRequest": "0",
 44 |         "accountNumber": "XXXX0015",
 45 |         "accountType": "MasterCard",
 46 |         "messages": [
 47 |             {
 48 |                 "code": "1",
 49 |                 "description": "This transaction has been approved."
 50 |             }
 51 |         ]
 52 |     },
 53 |     "refId": "123456",
 54 |     "messages": {
 55 |         "resultCode": "Ok",
 56 |         "message": [
 57 |             {
 58 |                 "code": "I00001",
 59 |                 "text": "Successful."
 60 |             }
 61 |         ]
 62 |     }
 63 | }
 64 | 
 65 | *************************************************************************************************/
 66 | 
 67 | namespace Authnetjson;
 68 | 
 69 | use Exception;
 70 | 
 71 | require '../../config.inc.php';
 72 | 
 73 | try {
 74 |     $request = AuthnetApiFactory::getJsonApiHandler(
 75 |         AUTHNET_LOGIN,
 76 |         AUTHNET_TRANSKEY,
 77 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 78 |     );
 79 |     $response = $request->createTransactionRequest([
 80 |         'transactionRequest' => [
 81 |             'transactionType' => 'getDetailsTransaction',
 82 |             'refTransId' => '128'
 83 |         ]
 84 |     ]);
 85 | } catch (Exception $e) {
 86 |     echo $e;
 87 |     exit;
 88 | }
 89 | ?>
 90 | 
 91 | <!DOCTYPE html>
 92 | <html lang="en">
 93 | <head>
 94 |     <title>Payment :: Paypal :: Get Details</title>
 95 |     <style>
 96 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 97 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 98 |         pre { white-space: pre-wrap; }
 99 |         table th { background: #e5e5e5; color: #666666; }
100 |         h1, h2 { text-align: center; }
101 |     </style>
102 | </head>
103 | <body>
104 |     <h1>
105 |         Payment :: Paypal :: Get Details
106 |     </h1>
107 |     <h2>
108 |         Results
109 |     </h2>
110 |     <table>
111 |         <tr>
112 |             <th>Response</th>
113 |             <td><?= $response->messages->resultCode ?></td>
114 |         </tr>
115 |         <tr>
116 |             <th>Successful?</th>
117 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
118 |         </tr>
119 |         <tr>
120 |             <th>Error?</th>
121 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
122 |         </tr>
123 |         <?php if ($response->isSuccessful()) : ?>
124 |         <tr>
125 |             <th>Description</th>
126 |             <td><?= $response->transactionResponse->messages[0]->description ?></td>
127 |         </tr>
128 |         <tr>
129 |             <th>Authorization Code</th>
130 |             <td><?= $response->transactionResponse->authCode ?></td>
131 |         </tr>
132 |         <tr>
133 |             <th>Transaction ID</th>
134 |             <td><?= $response->transactionResponse->transId ?></td>
135 |         </tr>
136 |         <tr>
137 |             <th>Reference Transaction ID</th>
138 |             <td><?= $response->transactionResponse->refTransID ?></td>
139 |         </tr>
140 |         <tr>
141 |             <th>Transaction Hash</th>
142 |             <td><?= $response->transactionResponse->transHash ?></td>
143 |         </tr>
144 |         <tr>
145 |             <th>AVS Result Code</th>
146 |             <td><?= $response->transactionResponse->avsResultCode ?></td>
147 |         </tr>
148 |         <tr>
149 |             <th>CVV Result Code</th>
150 |             <td><?= $response->transactionResponse->cvvResultCode ?></td>
151 |         </tr>
152 |         <tr>
153 |             <th>CAVV Result Code</th>
154 |             <td><?= $response->transactionResponse->cavvResultCode ?></td>
155 |         </tr>
156 |         <tr>
157 |             <th>Is Test Request?</th>
158 |             <td><?= $response->transactionResponse->testRequest ? 'yes' : 'no' ?></td>
159 |         </tr>
160 |         <tr>
161 |             <th>Account Type</th>
162 |             <td><?= $response->transactionResponse->accountType ?></td>
163 |         </tr>
164 |         <?php elseif ($response->isError()) : ?>
165 |         <tr>
166 |             <th>Error Code</th>
167 |             <td><?= $response->getErrorCode() ?></td>
168 |         </tr>
169 |         <tr>
170 |             <th>Error Message</th>
171 |             <td><?= $response->getErrorText() ?></td>
172 |         </tr>
173 |         <?php endif; ?>
174 |     </table>
175 |     <h2>
176 |         Raw Input/Output
177 |     </h2>
178 | <?= $request, $response ?>
179 | </body>
180 | </html>
181 | 


--------------------------------------------------------------------------------
/examples/aim/createTransactionRequest_paypalRefund.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Use the AIM JSON API to process a Credit transaction through Paypal
 15 | 
 16 | SAMPLE REQUEST
 17 | --------------------------------------------------------------------------------------------------
 18 | {
 19 |     "createTransactionRequest": {
 20 |         "merchantAuthentication": {
 21 |             "name": "cnpdev4289",
 22 |             "transactionKey": "SR2P8g4jdEn7vFLQ"
 23 |         },
 24 |         "transactionRequest": {
 25 |             "transactionType": "refundTransaction",
 26 |             "refTransId": "138"
 27 |         }
 28 |     }
 29 | }
 30 | 
 31 | SAMPLE RESPONSE
 32 | --------------------------------------------------------------------------------------------------
 33 | {
 34 |     "transactionResponse": {
 35 |         "responseCode": "1",
 36 |         "transId": "2149186848",
 37 |         "refTransID": "2149186775",
 38 |         "transHash": "D6C9036F443BADE785D57DA2B44CD190",
 39 |         "testRequest": "0",
 40 |         "accountType": "PayPal",
 41 |         "messages": [
 42 |             {
 43 |                 "code": "1",
 44 |                 "description": "This transaction has been approved."
 45 |             }
 46 |         ]
 47 |     },
 48 |     "refId": "123456",
 49 |     "messages": {
 50 |         "resultCode": "Ok",
 51 |         "message": [
 52 |             {
 53 |                 "code": "I00001",
 54 |                 "text": "Successful."
 55 |             }
 56 |         ]
 57 |     }
 58 | }
 59 | 
 60 | *************************************************************************************************/
 61 | 
 62 | namespace Authnetjson;
 63 | 
 64 | use Exception;
 65 | 
 66 | require '../../config.inc.php';
 67 | 
 68 | try {
 69 |     $request = AuthnetApiFactory::getJsonApiHandler(
 70 |         AUTHNET_LOGIN,
 71 |         AUTHNET_TRANSKEY,
 72 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 73 |     );
 74 |     $response = $request->createTransactionRequest([
 75 |         'transactionRequest' => [
 76 |             'transactionType' => 'refundTransaction',
 77 |             'refTransId' => '138'
 78 |         ]
 79 |     ]);
 80 | } catch (Exception $e) {
 81 |     echo $e;
 82 |     exit;
 83 | }
 84 | ?>
 85 | 
 86 | <!DOCTYPE html>
 87 | <html lang="en">
 88 | <head>
 89 |     <title>Payment :: Paypal :: Refund</title>
 90 |     <style>
 91 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 92 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 93 |         pre { white-space: pre-wrap; }
 94 |         table th { background: #e5e5e5; color: #666666; }
 95 |         h1, h2 { text-align: center; }
 96 |     </style>
 97 | </head>
 98 | <body>
 99 |     <h1>
100 |         Payment :: Paypal :: Refund
101 |     </h1>
102 |     <h2>
103 |         Results
104 |     </h2>
105 |     <table>
106 |         <tr>
107 |             <th>Response</th>
108 |             <td><?= $response->messages->resultCode ?></td>
109 |         </tr>
110 |         <tr>
111 |             <th>Successful?</th>
112 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
113 |         </tr>
114 |         <tr>
115 |             <th>Error?</th>
116 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
117 |         </tr>
118 |         <?php if ($response->isSuccessful()) : ?>
119 |         <tr>
120 |             <th>Description</th>
121 |             <td><?= $response->transactionResponse->messages[0]->description ?></td>
122 |         </tr>
123 |         <tr>
124 |             <th>Authorization Code</th>
125 |             <td><?= $response->transactionResponse->authCode ?></td>
126 |         </tr>
127 |         <tr>
128 |             <th>Transaction ID</th>
129 |             <td><?= $response->transactionResponse->transId ?></td>
130 |         </tr>
131 |         <tr>
132 |             <th>Reference Transaction ID</th>
133 |             <td><?= $response->transactionResponse->refTransID ?></td>
134 |         </tr>
135 |         <tr>
136 |             <th>Transaction Hash</th>
137 |             <td><?= $response->transactionResponse->transHash ?></td>
138 |         </tr>
139 |         <tr>
140 |             <th>Account Type</th>
141 |             <td><?= $response->transactionResponse->accountType ?></td>
142 |         </tr>
143 |         <?php elseif ($response->isError()) : ?>
144 |         <tr>
145 |             <th>Error Code</th>
146 |             <td><?= $response->getErrorCode() ?></td>
147 |         </tr>
148 |         <tr>
149 |             <th>Error Message</th>
150 |             <td><?= $response->getErrorText() ?></td>
151 |         </tr>
152 |         <?php endif; ?>
153 |     </table>
154 |     <h2>
155 |         Raw Input/Output
156 |     </h2>
157 | <?= $request, $response ?>
158 | </body>
159 | </html>
160 | 


--------------------------------------------------------------------------------
/examples/aim/createTransactionRequest_paypalVoid.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Use the AIM JSON API to process a Void transaction through Paypal
 15 | 
 16 | SAMPLE REQUEST
 17 | --------------------------------------------------------------------------------------------------
 18 | {
 19 |     "createTransactionRequest": {
 20 |         "merchantAuthentication": {
 21 |             "name": "cnpdev4289",
 22 |             "transactionKey": "SR2P8g4jdEn7vFLQ"
 23 |         },
 24 |         "transactionRequest": {
 25 |             "transactionType": "voidTransaction",
 26 |             "refTransId": "138"
 27 |         }
 28 |     }
 29 | }
 30 | 
 31 | SAMPLE RESPONSE
 32 | --------------------------------------------------------------------------------------------------
 33 | {
 34 |     "transactionResponse": {
 35 |         "responseCode": "1",
 36 |         "authCode": "HH5414",
 37 |         "avsResultCode": "P",
 38 |         "cvvResultCode": "",
 39 |         "cavvResultCode": "",
 40 |         "transId": "2149186848",
 41 |         "refTransID": "2149186848",
 42 |         "transHash": "D3A855F0934EB404DE3B13508D0E3826",
 43 |         "testRequest": "0",
 44 |         "accountNumber": "XXXX0015",
 45 |         "accountType": "MasterCard",
 46 |         "messages": [
 47 |             {
 48 |                 "code": "1",
 49 |                 "description": "This transaction has been approved."
 50 |             }
 51 |         ]
 52 |     },
 53 |     "refId": "123456",
 54 |     "messages": {
 55 |         "resultCode": "Ok",
 56 |         "message": [
 57 |             {
 58 |                 "code": "I00001",
 59 |                 "text": "Successful."
 60 |             }
 61 |         ]
 62 |     }
 63 | }
 64 | 
 65 | *************************************************************************************************/
 66 | 
 67 | namespace Authnetjson;
 68 | 
 69 | use Exception;
 70 | 
 71 | require '../../config.inc.php';
 72 | 
 73 | try {
 74 |     $request = AuthnetApiFactory::getJsonApiHandler(
 75 |         AUTHNET_LOGIN,
 76 |         AUTHNET_TRANSKEY,
 77 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 78 |     );
 79 |     $response = $request->createTransactionRequest([
 80 |         'transactionRequest' => [
 81 |             'transactionType' => 'voidTransaction',
 82 |             'refTransId' => '138'
 83 |         ]
 84 |     ]);
 85 | } catch (Exception $e) {
 86 |     echo $e;
 87 |     exit;
 88 | }
 89 | ?>
 90 | 
 91 | <!DOCTYPE html>
 92 | <html lang="en">
 93 | <head>
 94 |     <title>Payment :: Paypal :: Void</title>
 95 |     <style>
 96 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 97 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 98 |         pre { white-space: pre-wrap; }
 99 |         table th { background: #e5e5e5; color: #666666; }
100 |         h1, h2 { text-align: center; }
101 |     </style>
102 | </head>
103 | <body>
104 |     <h1>
105 |         Payment :: Paypal :: Void
106 |     </h1>
107 |     <h2>
108 |         Results
109 |     </h2>
110 |     <table>
111 |         <tr>
112 |             <th>Response</th>
113 |             <td><?= $response->messages->resultCode ?></td>
114 |         </tr>
115 |         <tr>
116 |             <th>Successful?</th>
117 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
118 |         </tr>
119 |         <tr>
120 |             <th>Error?</th>
121 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
122 |         </tr>
123 |         <?php if ($response->isSuccessful()) : ?>
124 |         <tr>
125 |             <th>Description</th>
126 |             <td><?= $response->transactionResponse->messages[0]->description ?></td>
127 |         </tr>
128 |         <tr>
129 |             <th>Authorization Code</th>
130 |             <td><?= $response->transactionResponse->authCode ?></td>
131 |         </tr>
132 |         <tr>
133 |             <th>Transaction ID</th>
134 |             <td><?= $response->transactionResponse->transId ?></td>
135 |         </tr>
136 |         <tr>
137 |             <th>Reference Transaction ID</th>
138 |             <td><?= $response->transactionResponse->refTransID ?></td>
139 |         </tr>
140 |         <tr>
141 |             <th>Transaction Hash</th>
142 |             <td><?= $response->transactionResponse->transHash ?></td>
143 |         </tr>
144 |         <tr>
145 |             <th>AVS Result Code</th>
146 |             <td><?= $response->transactionResponse->avsResultCode ?></td>
147 |         </tr>
148 |         <tr>
149 |             <th>CVV Result Code</th>
150 |             <td><?= $response->transactionResponse->cvvResultCode ?></td>
151 |         </tr>
152 |         <tr>
153 |             <th>CAVV Result Code</th>
154 |             <td><?= $response->transactionResponse->cavvResultCode ?></td>
155 |         </tr>
156 |         <tr>
157 |             <th>Is Test Request?</th>
158 |             <td><?= $response->transactionResponse->testRequest ? 'yes' : 'no' ?></td>
159 |         </tr>
160 |         <tr>
161 |             <th>Account Type</th>
162 |             <td><?= $response->transactionResponse->accountType ?></td>
163 |         </tr>
164 |         <?php elseif ($response->isError()) : ?>
165 |         <tr>
166 |             <th>Error Code</th>
167 |             <td><?= $response->getErrorCode() ?></td>
168 |         </tr>
169 |         <tr>
170 |             <th>Error Message</th>
171 |             <td><?= $response->getErrorText() ?></td>
172 |         </tr>
173 |         <?php endif; ?>
174 |     </table>
175 |     <h2>
176 |         Raw Input/Output
177 |     </h2>
178 | <?= $request, $response ?>
179 | </body>
180 | </html>
181 | 


--------------------------------------------------------------------------------
/examples/aim/createTransactionRequest_priorAuthCapture.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the AIM JSON API to process an Prior Authorization Capture transaction
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "createTransactionRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "refId":14254181,
 15 |       "transactionRequest":{
 16 |          "transactionType":"priorAuthCaptureTransaction",
 17 |          "refTransId":"2165665234"
 18 |       }
 19 |    }
 20 | }
 21 | 
 22 | SAMPLE RESPONSE
 23 | --------------------------------------------------------------------------------------------------
 24 | {
 25 |    "transactionResponse":{
 26 |       "responseCode":"1",
 27 |       "authCode":"1VT65S",
 28 |       "avsResultCode":"P",
 29 |       "cvvResultCode":"",
 30 |       "cavvResultCode":"",
 31 |       "transId":"2230581333",
 32 |       "refTransID":"2230581333",
 33 |       "transHash":"414220CECDB539F68435A4830246BDA5",
 34 |       "testRequest":"0",
 35 |       "accountNumber":"XXXX0015",
 36 |       "accountType":"MasterCard",
 37 |       "messages":[
 38 |          {
 39 |             "code":"1",
 40 |             "description":"This transaction has been approved."
 41 |          }
 42 |       ]
 43 |    },
 44 |    "refId":"34913421",
 45 |    "messages":{
 46 |       "resultCode":"Ok",
 47 |       "message":[
 48 |          {
 49 |             "code":"I00001",
 50 |             "text":"Successful."
 51 |          }
 52 |       ]
 53 |    }
 54 | }
 55 | 
 56 |  *************************************************************************************************/
 57 | 
 58 | namespace Authnetjson;
 59 | 
 60 | use Exception;
 61 | 
 62 | require '../../config.inc.php';
 63 | 
 64 | try {
 65 |     $request = AuthnetApiFactory::getJsonApiHandler(
 66 |         AUTHNET_LOGIN,
 67 |         AUTHNET_TRANSKEY,
 68 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 69 |     );
 70 |     $response = $request->createTransactionRequest([
 71 |         'refId' => random_int(1000000, 100000000),
 72 |         'transactionRequest' => [
 73 |             'transactionType' => 'priorAuthCaptureTransaction',
 74 |             'refTransId' => '2230581333'
 75 |         ],
 76 |     ]);
 77 | } catch (Exception $e) {
 78 |     echo $e;
 79 |     exit;
 80 | }
 81 | ?>
 82 | 
 83 | <!DOCTYPE html>
 84 | <html lang="en">
 85 | <head>
 86 |     <title>Payment :: Prior Authorization Capture</title>
 87 |     <style>
 88 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 89 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 90 |         pre { white-space: pre-wrap; }
 91 |         table th { background: #e5e5e5; color: #666666; }
 92 |         h1, h2 { text-align: center; }
 93 |     </style>
 94 | </head>
 95 | <body>
 96 |     <h1>
 97 |         Payment :: Prior Authorization Capture
 98 |     </h1>
 99 |     <h2>
100 |         Results
101 |     </h2>
102 |     <table>
103 |         <tr>
104 |             <th>Response</th>
105 |             <td><?= $response->messages->resultCode ?></td>
106 |         </tr>
107 |         <tr>
108 |             <th>Successful?</th>
109 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
110 |         </tr>
111 |         <tr>
112 |             <th>Error?</th>
113 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
114 |         </tr>
115 |         <?php if ($response->isSuccessful()) : ?>
116 |         <tr>
117 |             <th>Description</th>
118 |             <td><?= $response->transactionResponse->messages[0]->description ?></td>
119 |         </tr>
120 |         <tr>
121 |             <th>Authorization Code</th>
122 |             <td><?= $response->transactionResponse->authCode ?></td>
123 |         </tr>
124 |         <tr>
125 |             <th>Transaction ID</th>
126 |             <td><?= $response->transactionResponse->transId ?></td>
127 |         </tr>
128 |         <tr>
129 |             <th>Reference Transaction ID</th>
130 |             <td><?= $response->transactionResponse->refTransID ?></td>
131 |         </tr>
132 |         <tr>
133 |             <th>Transaction Hash</th>
134 |             <td><?= $response->transactionResponse->transHash ?></td>
135 |         </tr>
136 |         <tr>
137 |             <th>AVS Result Code</th>
138 |             <td><?= $response->transactionResponse->avsResultCode ?></td>
139 |         </tr>
140 |         <tr>
141 |             <th>CVV Result Code</th>
142 |             <td><?= $response->transactionResponse->cvvResultCode ?></td>
143 |         </tr>
144 |         <tr>
145 |             <th>CAVV Result Code</th>
146 |             <td><?= $response->transactionResponse->cavvResultCode ?></td>
147 |         </tr>
148 |         <tr>
149 |             <th>Is Test Request?</th>
150 |             <td><?= $response->transactionResponse->testRequest ? 'yes' : 'no' ?></td>
151 |         </tr>
152 |         <tr>
153 |             <th>Account Type</th>
154 |             <td><?= $response->transactionResponse->accountType ?></td>
155 |         </tr>
156 |         <?php elseif ($response->isError()) : ?>
157 |         <tr>
158 |             <th>Error Code</th>
159 |             <td><?= $response->getErrorCode() ?></td>
160 |         </tr>
161 |         <tr>
162 |             <th>Error Message</th>
163 |             <td><?= $response->getErrorText() ?></td>
164 |         </tr>
165 |         <?php endif; ?>
166 |     </table>
167 |     <h2>
168 |         Raw Input/Output
169 |     </h2>
170 |     <?= $request, $response ?>
171 | </body>
172 | </html>
173 | 


--------------------------------------------------------------------------------
/examples/aim/createTransactionRequest_void.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the AIM JSON API to Void a transaction
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "createTransactionRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "refId":35481415,
 15 |       "transactionRequest":{
 16 |          "transactionType":"voidTransaction",
 17 |          "refTransId":"2230581408"
 18 |       }
 19 |    }
 20 | }
 21 | 
 22 | SAMPLE RESPONSE
 23 | --------------------------------------------------------------------------------------------------
 24 | {
 25 |    "transactionResponse":{
 26 |       "responseCode":"1",
 27 |       "authCode":"QCG7TB",
 28 |       "avsResultCode":"P",
 29 |       "cvvResultCode":"",
 30 |       "cavvResultCode":"",
 31 |       "transId":"2230581408",
 32 |       "refTransID":"2230581408",
 33 |       "transHash":"39C62AE0EC82B749CC6D3324BE263CC6",
 34 |       "testRequest":"0",
 35 |       "accountNumber":"XXXX1111",
 36 |       "accountType":"Visa",
 37 |       "messages":[
 38 |          {
 39 |             "code":"1",
 40 |             "description":"This transaction has been approved."
 41 |          }
 42 |       ]
 43 |    },
 44 |    "refId":"35481415",
 45 |    "messages":{
 46 |       "resultCode":"Ok",
 47 |       "message":[
 48 |          {
 49 |             "code":"I00001",
 50 |             "text":"Successful."
 51 |          }
 52 |       ]
 53 |    }
 54 | }
 55 | 
 56 | **************************************************************************************************/
 57 | 
 58 | namespace Authnetjson;
 59 | 
 60 | use Exception;
 61 | 
 62 | require '../../config.inc.php';
 63 | 
 64 | try {
 65 |     $request = AuthnetApiFactory::getJsonApiHandler(
 66 |         AUTHNET_LOGIN,
 67 |         AUTHNET_TRANSKEY,
 68 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 69 |     );
 70 |     $response = $request->createTransactionRequest([
 71 |         'refId' => random_int(1000000, 100000000),
 72 |         'transactionRequest' => [
 73 |             'transactionType' => 'voidTransaction',
 74 |             'refTransId' => '2230581408'
 75 |         ],
 76 |     ]);
 77 | } catch (Exception $e) {
 78 |     echo $e;
 79 |     exit;
 80 | }
 81 | ?>
 82 | 
 83 | <!DOCTYPE html>
 84 | <html lang="en">
 85 | <head>
 86 |     <title>Payment :: Void</title>
 87 |     <style>
 88 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 89 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 90 |         pre { white-space: pre-wrap; }
 91 |         table th { background: #e5e5e5; color: #666666; }
 92 |         h1, h2 { text-align: center; }
 93 |     </style>
 94 | </head>
 95 | <body>
 96 |     <h1>
 97 |         Payment :: Void
 98 |     </h1>
 99 |     <h2>
100 |         Results
101 |     </h2>
102 |     <table>
103 |         <tr>
104 |             <th>Response</th>
105 |             <td><?= $response->messages->resultCode ?></td>
106 |         </tr>
107 |         <tr>
108 |             <th>Successful?</th>
109 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
110 |         </tr>
111 |         <tr>
112 |             <th>Error?</th>
113 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
114 |         </tr>
115 |         <?php if ($response->isSuccessful()) : ?>
116 |         <tr>
117 |             <th>Description</th>
118 |             <td><?= $response->transactionResponse->messages[0]->description ?></td>
119 |         </tr>
120 |         <tr>
121 |             <th>Authorization Code</th>
122 |             <td><?= $response->transactionResponse->authCode ?></td>
123 |         </tr>
124 |         <tr>
125 |             <th>Transaction ID</th>
126 |             <td><?= $response->transactionResponse->transId ?></td>
127 |         </tr>
128 |         <tr>
129 |             <th>Reference Transaction ID</th>
130 |             <td><?= $response->transactionResponse->refTransID ?></td>
131 |         </tr>
132 |         <tr>
133 |             <th>Transaction Hash</th>
134 |             <td><?= $response->transactionResponse->transHash ?></td>
135 |         </tr>
136 |         <tr>
137 |             <th>AVS Result Code</th>
138 |             <td><?= $response->transactionResponse->avsResultCode ?></td>
139 |         </tr>
140 |         <tr>
141 |             <th>CVV Result Code</th>
142 |             <td><?= $response->transactionResponse->cvvResultCode ?></td>
143 |         </tr>
144 |         <tr>
145 |             <th>CAVV Result Code</th>
146 |             <td><?= $response->transactionResponse->cavvResultCode ?></td>
147 |         </tr>
148 |         <tr>
149 |             <th>Is Test Request?</th>
150 |             <td><?= $response->transactionResponse->testRequest ? 'yes' : 'no' ?></td>
151 |         </tr>
152 |         <tr>
153 |             <th>Account Type</th>
154 |             <td><?= $response->transactionResponse->accountType ?></td>
155 |         </tr>
156 |         <?php elseif ($response->isError()) : ?>
157 |         <tr>
158 |             <th>Error Code</th>
159 |             <td><?= $response->getErrorCode() ?></td>
160 |         </tr>
161 |         <tr>
162 |             <th>Error Message</th>
163 |             <td><?= $response->getErrorText() ?></td>
164 |         </tr>
165 |         <?php endif; ?>
166 |     </table>
167 |     <h2>
168 |         Raw Input/Output
169 |     </h2>
170 | <?= $request, $response ?>
171 | </body>
172 | </html>
173 | 


--------------------------------------------------------------------------------
/examples/aim/sendCustomerTransactionReceiptRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the AIM JSON API to send a customer a transaction receipt
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "sendCustomerTransactionReceiptRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "refId":2241729,
 15 |       "transId":"2165665581",
 16 |       "customerEmail":"user@example.com",
 17 |       "emailSettings":{
 18 |          "setting":{
 19 |             "settingName":"footerEmailReceipt",
 20 |             "settingValue":"some FOOTER stuff"
 21 |          }
 22 |       }
 23 |    }
 24 | }
 25 | 
 26 | SAMPLE RESPONSE
 27 | --------------------------------------------------------------------------------------------------
 28 | {
 29 |    "refId":"2241729",
 30 |    "messages":{
 31 |       "resultCode":"Ok",
 32 |       "message":[
 33 |          {
 34 |             "code":"I00001",
 35 |             "text":"Successful."
 36 |          }
 37 |       ]
 38 |    }
 39 | }
 40 | 
 41 | **************************************************************************************************/
 42 | 
 43 | namespace Authnetjson;
 44 | 
 45 | use Exception;
 46 | 
 47 | require '../../config.inc.php';
 48 | 
 49 | try {
 50 |     $request = AuthnetApiFactory::getJsonApiHandler(
 51 |         AUTHNET_LOGIN,
 52 |         AUTHNET_TRANSKEY,
 53 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 54 |     );
 55 |     $response = $request->sendCustomerTransactionReceiptRequest([
 56 |         'refId' => random_int(1000000, 100000000),
 57 |         'transId' => '2165665581',
 58 |         'customerEmail' => 'user@example.com',
 59 |         'emailSettings' => [
 60 |             [
 61 |                 'settingName' => 'headerEmailReceipt',
 62 |                 'settingValue' => 'some HEADER stuff'
 63 |             ],
 64 |         ],
 65 |     ]);
 66 | } catch (Exception $e) {
 67 |     echo $e;
 68 |     exit;
 69 | }
 70 | ?>
 71 | 
 72 | <!DOCTYPE html>
 73 | <html lang="en">
 74 | <head>
 75 |     <title> Payment :: Receipt Request</title>
 76 |     <style>
 77 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 78 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 79 |         pre { white-space: pre-wrap; }
 80 |         table th { background: #e5e5e5; color: #666666; }
 81 |         h1, h2 { text-align: center; }
 82 |     </style>
 83 | </head>
 84 | <body>
 85 |     <h1>
 86 |         Payment :: Receipt Request
 87 |     </h1>
 88 |     <h2>
 89 |         Results
 90 |     </h2>
 91 |     <table>
 92 |         <tr>
 93 |             <th>Response</th>
 94 |             <td><?= $response->messages->resultCode ?></td>
 95 |         </tr>
 96 |         <tr>
 97 |             <th>Successful?</th>
 98 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 99 |         </tr>
100 |         <tr>
101 |             <th>Error?</th>
102 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
103 |         </tr>
104 |         <?php if ($response->isSuccessful()) : ?>
105 |         <tr>
106 |             <th>Reference Transaction ID</th>
107 |             <td><?= $response->transactionResponse->refTransID ?></td>
108 |         </tr>
109 |         <?php elseif ($response->isError()) : ?>
110 |         <tr>
111 |             <th>Error Code</th>
112 |             <td><?= $response->getErrorCode() ?></td>
113 |         </tr>
114 |         <tr>
115 |             <th>Error Message</th>
116 |             <td><?= $response->getErrorText() ?></td>
117 |         </tr>
118 |         <?php endif; ?>
119 |     </table>
120 |     <h2>
121 |         Raw Input/Output
122 |     </h2>
123 | <?= $request, $response ?>
124 | </body>
125 | </html>
126 | 


--------------------------------------------------------------------------------
/examples/arb/ARBCancelSubscriptionRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Use the ARB XML API to cancel a subscription
 15 | 
 16 | SAMPLE REQUEST
 17 | --------------------------------------------------------------------------------------------------
 18 | {
 19 |    "ARBCancelSubscriptionRequest":{
 20 |       "merchantAuthentication":{
 21 |          "name":"",
 22 |          "transactionKey":""
 23 |       },
 24 |       "refId":"Sample",
 25 |       "subscriptionId":"2341621"
 26 |    }
 27 | }
 28 | 
 29 | SAMPLE RESPONSE
 30 | --------------------------------------------------------------------------------------------------
 31 | {
 32 |    "refId":"Sample",
 33 |    "messages":{
 34 |       "resultCode":"Ok",
 35 |       "message":[
 36 |          {
 37 |             "code":"I00001",
 38 |             "text":"Successful."
 39 |          }
 40 |       ]
 41 |    }
 42 | }
 43 | 
 44 | *************************************************************************************************/
 45 | 
 46 | namespace Authnetjson;
 47 | 
 48 | use Exception;
 49 | 
 50 | require '../../config.inc.php';
 51 | 
 52 | try {
 53 |     $request = AuthnetApiFactory::getJsonApiHandler(
 54 |         AUTHNET_LOGIN,
 55 |         AUTHNET_TRANSKEY,
 56 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 57 |     );
 58 |     $response = $request->ARBCancelSubscriptionRequest([
 59 |         'refId' => 'Sample',
 60 |         'subscriptionId' => '2341621'
 61 |     ]);
 62 | } catch (Exception $e) {
 63 |     echo $e;
 64 |     exit;
 65 | }
 66 | ?>
 67 | 
 68 | <!DOCTYPE html>
 69 | <html lang="en">
 70 | <head>
 71 |     <title>ARB :: Cancel Subscription</title>
 72 |     <style>
 73 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 74 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 75 |         pre { white-space: pre-wrap; }
 76 |         table th { background: #e5e5e5; color: #666666; }
 77 |         h1, h2 { text-align: center; }
 78 |     </style>
 79 | </head>
 80 | <body>
 81 |     <h1>
 82 |         ARB :: Cancel Subscription
 83 |     </h1>
 84 |     <h2>
 85 |         Results
 86 |     </h2>
 87 |     <table>
 88 |         <tr>
 89 |             <th>Successful?</th>
 90 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 91 |         </tr>
 92 |         <tr>
 93 |             <th>Error?</th>
 94 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
 95 |         </tr>
 96 |         <tr>
 97 |             <th>Result Code</th>
 98 |             <td><?= $response->messages->resultCode ?></td>
 99 |         </tr>
100 |         <tr>
101 |             <th>Message Code</th>
102 |             <td><?= $response->messages->message[0]->code ?></td>
103 |         </tr>
104 |         <tr>
105 |             <th>Message</th>
106 |             <td><?= $response->messages->message[0]->text ?></td>
107 |         </tr>
108 |     </table>
109 |     <h2>
110 |         Raw Input/Output
111 |     </h2>
112 | <?= $request, $response ?>
113 | </body>
114 | </html>
115 | 


--------------------------------------------------------------------------------
/examples/arb/ARBCreateSubscriptionRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Use the ARB JSON API to create a subscription
 15 | 
 16 | SAMPLE REQUEST
 17 | --------------------------------------------------------------------------------------------------
 18 | {
 19 |    "ARBCreateSubscriptionRequest":{
 20 |       "merchantAuthentication":{
 21 |          "name":"",
 22 |          "transactionKey":""
 23 |       },
 24 |       "refId":"Sample",
 25 |       "subscription":{
 26 |          "name":"Sample subscription",
 27 |          "paymentSchedule":{
 28 |             "interval":{
 29 |                "length":"1",
 30 |                "unit":"months"
 31 |             },
 32 |             "startDate":"2012-03-15",
 33 |             "totalOccurrences":"12",
 34 |             "trialOccurrences":"1"
 35 |          },
 36 |          "amount":"10.29",
 37 |          "trialAmount":"0.00",
 38 |          "payment":{
 39 |             "creditCard":{
 40 |                "cardNumber":"4111111111111111",
 41 |                "expirationDate":"2016-08"
 42 |             }
 43 |          },
 44 |          "billTo":{
 45 |             "firstName":"John",
 46 |             "lastName":"Smith"
 47 |          }
 48 |       }
 49 |    }
 50 | }
 51 | 
 52 | SAMPLE RESPONSE
 53 | --------------------------------------------------------------------------------------------------
 54 | {
 55 |    "subscriptionId":"2341621",
 56 |    "refId":"Sample",
 57 |    "messages":{
 58 |       "resultCode":"Ok",
 59 |       "message":[
 60 |          {
 61 |             "code":"I00001",
 62 |             "text":"Successful."
 63 |          }
 64 |       ]
 65 |    }
 66 | }
 67 | 
 68 | *************************************************************************************************/
 69 | 
 70 | namespace Authnetjson;
 71 | 
 72 | use Exception;
 73 | 
 74 | require '../../config.inc.php';
 75 | 
 76 | try {
 77 |     $request = AuthnetApiFactory::getJsonApiHandler(
 78 |         AUTHNET_LOGIN,
 79 |         AUTHNET_TRANSKEY,
 80 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 81 |     );
 82 |     $response = $request->ARBCreateSubscriptionRequest([
 83 |         'refId' => 'Sample',
 84 |         'subscription' => [
 85 |             'name' => 'Sample subscription',
 86 |             'paymentSchedule' => [
 87 |                 'interval' => [
 88 |                     'length' => '1',
 89 |                     'unit' => 'months'
 90 |                 ],
 91 |                 'startDate' => '2015-04-18',
 92 |                 'totalOccurrences' => AuthnetJson::BOUNDLESS_OCCURRENCES,
 93 |                 'trialOccurrences' => '1'
 94 |             ],
 95 |             'amount' => '10.29',
 96 |             'trialAmount' => '0.00',
 97 |             'payment' => [
 98 |                 'creditCard' => [
 99 |                     'cardNumber' => '4111111111111111',
100 |                     'expirationDate' => '2016-08'
101 |                 ]
102 |             ],
103 |             'billTo' => [
104 |                 'firstName' => 'John',
105 |                 'lastName' => 'Smith'
106 |             ]
107 |         ]
108 |     ]);
109 | } catch (Exception $e) {
110 |     echo $e;
111 |     exit;
112 | }
113 | ?>
114 | 
115 | <!DOCTYPE html>
116 | <html lang="en">
117 | <head>
118 |     <title>ARB :: Create Subscription</title>
119 |     <style>
120 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
121 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
122 |         pre { white-space: pre-wrap; }
123 |         table th { background: #e5e5e5; color: #666666; }
124 |         h1, h2 { text-align: center; }
125 |     </style>
126 | </head>
127 | <body>
128 |     <h1>
129 |         ARB :: Create Subscription
130 |     </h1>
131 |     <h2>
132 |         Results
133 |     </h2>
134 |     <table>
135 |         <tr>
136 |             <th>Successful?</th>
137 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
138 |         </tr>
139 |         <tr>
140 |             <th>Error?</th>
141 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
142 |         </tr>
143 |         <tr>
144 |             <th>Result Code</th>
145 |             <td><?= $response->messages->resultCode ?></td>
146 |         </tr>
147 |         <tr>
148 |             <th>Message Code</th>
149 |             <td><?= $response->messages->message[0]->code ?></td>
150 |         </tr>
151 |         <tr>
152 |             <th>Message</th>
153 |             <td><?= $response->messages->message[0]->text ?></td>
154 |         </tr>
155 |         <tr>
156 |             <th>Subscription ID</th>
157 |             <td><?= $response->subscriptionId ?></td>
158 |         </tr>
159 |     </table>
160 |     <h2>
161 |         Raw Input/Output
162 |     </h2>
163 | <?= $request, $response ?>
164 | </body>
165 | </html>
166 | 


--------------------------------------------------------------------------------
/examples/arb/ARBCreateSubscriptionRequestFromProfile.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | This request enables you to create a recurring billing subscription from an existing customer profile. NOTE: The
 15 | customer payment profile first and last name fields must be populated, these are required for a subscription.
 16 | For subscriptions with a monthly interval, whose payments begin on the 31st of a month, payments for months with
 17 | fewer than 31 days occur on the last day of the month.
 18 | 
 19 | SAMPLE REQUEST
 20 | --------------------------------------------------------------------------------------------------
 21 | {
 22 |     "ARBCreateSubscriptionRequest": {
 23 |         "merchantAuthentication": {
 24 |             "name": "",
 25 |             "transactionKey": ""
 26 |         },
 27 |         "refId": "123456",
 28 |         "subscription": {
 29 |             "name": "Sample subscription",
 30 |             "paymentSchedule": {
 31 |                 "interval": {
 32 |                     "length": "1",
 33 |                     "unit": "months"
 34 |                 },
 35 |                 "startDate": "2020-08-30",
 36 |                 "totalOccurrences": "12",
 37 |                 "trialOccurrences": "1"
 38 |             },
 39 |             "amount": "10.29",
 40 |             "trialAmount": "0.00",
 41 |             "profile": {
 42 |                 "customerProfileId": "39931060",
 43 |                 "customerPaymentProfileId": "36223863",
 44 |                 "customerAddressId": "37726371"
 45 |             }
 46 |         }
 47 |     }
 48 | }
 49 | 
 50 | SAMPLE RESPONSE
 51 | --------------------------------------------------------------------------------------------------
 52 | {
 53 |     "subscriptionId": "158383",
 54 |     profile": {
 55 |         "customerProfileId": "39931060",
 56 |         "customerPaymentProfileId": "36223863",
 57 |         "customerAddressId": "37726371"
 58 |     },
 59 |     "refId": "123456",
 60 |     "messages": {
 61 |         "resultCode": "Ok",
 62 |         "message": [
 63 |             {
 64 |                 "code": "I00001",
 65 |                 "text": "Successful."
 66 |             }
 67 |         ]
 68 |     }
 69 | }
 70 | 
 71 | *************************************************************************************************/
 72 | 
 73 | namespace Authnetjson;
 74 | 
 75 | use Exception;
 76 | 
 77 | require '../../config.inc.php';
 78 | 
 79 | try {
 80 |     $request = AuthnetApiFactory::getJsonApiHandler(
 81 |         AUTHNET_LOGIN,
 82 |         AUTHNET_TRANSKEY,
 83 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 84 |     );
 85 |     $response = $request->ARBCreateSubscriptionRequest([
 86 |         'refId' => 'Sample',
 87 |         'subscription' => [
 88 |             'name' => 'Sample subscription',
 89 |             'paymentSchedule' => [
 90 |                 'interval' => [
 91 |                     'length' => '1',
 92 |                     'unit' => 'months'
 93 |                 ],
 94 |                 'startDate' => '2020-07-15',
 95 |                 'totalOccurrences' => AuthnetJson::BOUNDLESS_OCCURRENCES,
 96 |                 'trialOccurrences' => '1'
 97 |             ],
 98 |             'amount' => '10.29',
 99 |             'trialAmount' => '0.00',
100 |             'profile' => [
101 |                 'customerProfileId' => '1512256927',
102 |                 'customerPaymentProfileId' => '1512285006',
103 |             ]
104 |         ]
105 |     ]);
106 | } catch (Exception $e) {
107 |     echo $e;
108 |     exit;
109 | }
110 | ?>
111 | 
112 | <!DOCTYPE html>
113 | <html lang="en">
114 | <head>
115 |     <title>ARB :: Create Subscription from Customer Profile</title>
116 |     <style>
117 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
118 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
119 |         pre { white-space: pre-wrap; }
120 |         table th { background: #e5e5e5; color: #666666; }
121 |         h1, h2 { text-align: center; }
122 |     </style>
123 | </head>
124 | <body>
125 |     <h1>
126 |         ARB :: Create Subscription from Customer Profile
127 |     </h1>
128 |     <h2>
129 |         Results
130 |     </h2>
131 |     <table>
132 |         <tr>
133 |             <th>Response</th>
134 |             <td><?= $response->messages->resultCode ?></td>
135 |         </tr>
136 |         <tr>
137 |             <th>Successful?</th>
138 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
139 |         </tr>
140 |         <tr>
141 |             <th>Error?</th>
142 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
143 |         </tr>
144 |         <tr>
145 |             <th>Code</th>
146 |             <td><?= $response->messages->message[0]->code ?></td>
147 |         </tr>
148 |         <tr>
149 |             <th>Message</th>
150 |             <td><?= $response->messages->message[0]->text ?></td>
151 |         </tr>
152 |         <tr>
153 |             <th>Subscription ID</th>
154 |             <td><?= $response->subscriptionId ?></td>
155 |         </tr>
156 |         <tr>
157 |             <th>Profile</th>
158 |             <td>
159 |                 Customer Profile Id: <?= $response->profile->customerProfileId ?><br>
160 |                 Customer PaymentProfile Id: <?= $response->profile->customerPaymentProfileId ?><br>
161 |                 Customer Address Id: <?= $response->profile->customerAddressId ?><br>
162 |             </td>
163 |         </tr>
164 |     </table>
165 |     <h2>
166 |         Raw Input/Output
167 |     </h2>
168 | <?= $request, $response ?>
169 | </body>
170 | </html>
171 | 


--------------------------------------------------------------------------------
/examples/arb/ARBGetSubscriptionStatusRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Use the ARB API to get a subscription's status
 15 | 
 16 | SAMPLE REQUEST
 17 | --------------------------------------------------------------------------------------------------
 18 | {
 19 |    "ARBGetSubscriptionStatusRequest":{
 20 |       "merchantAuthentication":{
 21 |          "name":"",
 22 |          "transactionKey":""
 23 |       },
 24 |       "refId":"Sample",
 25 |       "subscriptionId":"1207505"
 26 |    }
 27 | }
 28 | 
 29 | SAMPLE RESPONSE
 30 | --------------------------------------------------------------------------------------------------
 31 | {
 32 |    "note":"Status with a capital 'S' is obsolete.",
 33 |    "status":"canceled",
 34 |    "Status":"canceled",
 35 |    "statusSpecified":true,
 36 |    "StatusSpecified":true,
 37 |    "refId":"Sample",
 38 |    "messages":{
 39 |       "resultCode":"Ok",
 40 |       "message":[
 41 |          {
 42 |             "code":"I00001",
 43 |             "text":"Successful."
 44 |          }
 45 |       ]
 46 |    }
 47 | }
 48 | 
 49 | *************************************************************************************************/
 50 | 
 51 | namespace Authnetjson;
 52 | 
 53 | use Exception;
 54 | 
 55 | require '../../config.inc.php';
 56 | 
 57 | try {
 58 |     $request = AuthnetApiFactory::getJsonApiHandler(
 59 |         AUTHNET_LOGIN,
 60 |         AUTHNET_TRANSKEY,
 61 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 62 |     );
 63 |     $response = $request->ARBGetSubscriptionStatusRequest([
 64 |         'refId' => 'Sample',
 65 |         'subscriptionId' => '1207505'
 66 |     ]);
 67 | } catch (Exception $e) {
 68 |     echo $e;
 69 |     exit;
 70 | }
 71 | ?>
 72 | 
 73 | <!DOCTYPE html>
 74 | <html lang="en">
 75 | <head>
 76 |     <title>ARB :: Get Subscription Status</title>
 77 |     <style>
 78 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 79 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 80 |         pre { white-space: pre-wrap; }
 81 |         table th { background: #e5e5e5; color: #666666; }
 82 |         h1, h2 { text-align: center; }
 83 |     </style>
 84 | </head>
 85 | <body>
 86 |     <h1>
 87 |         ARB :: Get Subscription Status
 88 |     </h1>
 89 |     <h2>
 90 |         Results
 91 |     </h2>
 92 |     <table>
 93 |         <tr>
 94 |             <th>Response</th>
 95 |             <td><?= $response->messages->resultCode ?></td>
 96 |         </tr>
 97 |         <tr>
 98 |             <th>Message Code</th>
 99 |             <td><?= $response->messages->message[0]->code ?></td>
100 |         </tr>
101 |         <tr>
102 |             <th>Message Text</th>
103 |             <td><?= $response->messages->message[0]->text ?></td>
104 |         </tr>
105 |         <tr>
106 |             <th>Successful?</th>
107 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
108 |         </tr>
109 |         <tr>
110 |             <th>Error?</th>
111 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
112 |         </tr>
113 |         <tr>
114 |             <th>Reference ID</th>
115 |             <td><?= $response->refId ?></td>
116 |         </tr>
117 |         <tr>
118 |             <th>Status</th>
119 |             <td><?= $response->status ?></td>
120 |         </tr>
121 |         <tr>
122 |             <th>Status Specified</th>
123 |             <td><?= $response->statusSpecified ?></td>
124 |         </tr>
125 |     </table>
126 |     <h2>
127 |         Raw Input/Output
128 |     </h2>
129 | <?= $request, $response ?>
130 | </body>
131 | </html>
132 | 


--------------------------------------------------------------------------------
/examples/arb/ARBUpdateSubscriptionRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Use the ARB JSON API to update a subscription
 15 | 
 16 | SAMPLE REQUEST
 17 | --------------------------------------------------------------------------------------------------
 18 | {
 19 |    "ARBUpdateSubscriptionRequest":{
 20 |       "merchantAuthentication":{
 21 |          "name":"",
 22 |          "transactionKey":""
 23 |       },
 24 |       "refId":"Sample",
 25 |       "subscriptionId":"2342682",
 26 |       "subscription":{
 27 |          "payment":{
 28 |             "creditCard":{
 29 |                "cardNumber":"6011000000000012",
 30 |                "expirationDate":"2016-08"
 31 |             }
 32 |          }
 33 |       }
 34 |    }
 35 | }
 36 | 
 37 | SAMPLE RESPONSE
 38 | --------------------------------------------------------------------------------------------------
 39 | {
 40 |    "refId":"Sample",
 41 |    "messages":{
 42 |       "resultCode":"Ok",
 43 |       "message":[
 44 |          {
 45 |             "code":"I00001",
 46 |             "text":"Successful."
 47 |          }
 48 |       ]
 49 |    }
 50 | }
 51 | 
 52 | *************************************************************************************************/
 53 | 
 54 | namespace Authnetjson;
 55 | 
 56 | use Exception;
 57 | 
 58 | require '../../config.inc.php';
 59 | 
 60 | try {
 61 |     $request = AuthnetApiFactory::getJsonApiHandler(
 62 |         AUTHNET_LOGIN,
 63 |         AUTHNET_TRANSKEY,
 64 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 65 |     );
 66 |     $response = $request->ARBUpdateSubscriptionRequest([
 67 |         'refId' => 'Sample',
 68 |         'subscriptionId' => '2342682',
 69 |         'subscription' => [
 70 |             'payment' => [
 71 |                 'creditCard' => [
 72 |                     'cardNumber' => '6011000000000012',
 73 |                     'expirationDate' => '2016-08'
 74 |                 ],
 75 |             ],
 76 |         ],
 77 |     ]);
 78 | } catch (Exception $e) {
 79 |     echo $e;
 80 |     exit;
 81 | }
 82 | ?>
 83 | 
 84 | <!DOCTYPE html>
 85 | <html lang="en">
 86 | <head>
 87 |     <title>ARB :: Update Subscription</title>
 88 |     <style>
 89 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 90 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 91 |         pre { white-space: pre-wrap; }
 92 |         table th { background: #e5e5e5; color: #666666; }
 93 |         h1, h2 { text-align: center; }
 94 |     </style>
 95 | </head>
 96 | <body>
 97 |     <h1>
 98 |         ARB :: Update Subscription
 99 |     </h1>
100 |     <h2>
101 |         Results
102 |     </h2>
103 |     <table>
104 |         <tr>
105 |             <th>Successful?</th>
106 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
107 |         </tr>
108 |         <tr>
109 |             <th>Error?</th>
110 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
111 |         </tr>
112 |         <tr>
113 |             <th>Result Code</th>
114 |             <td><?= $response->messages->resultCode ?></td>
115 |         </tr>
116 |         <tr>
117 |             <th>Message Code</th>
118 |             <td><?= $response->messages->message[0]->code ?></td>
119 |         </tr>
120 |         <tr>
121 |             <th>Message</th>
122 |             <td><?= $response->messages->message[0]->text ?></td>
123 |         </tr>
124 |         <tr>
125 |             <th>Reference ID</th>
126 |             <td><?= $response->refId ?></td>
127 |         </tr>
128 |     </table>
129 |     <h2>
130 |         Raw Input/Output
131 |     </h2>
132 | <?= $request, $response ?>
133 | </body>
134 | </html>
135 | 


--------------------------------------------------------------------------------
/examples/cim/createCustomerPaymentProfileRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to create a payment profile
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "createCustomerPaymentProfileRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "customerProfileId":"30582495",
 15 |       "paymentProfile":{
 16 |          "billTo":{
 17 |             "firstName":"John",
 18 |             "lastName":"Doe",
 19 |             "company":"",
 20 |             "address":"123 Main St.",
 21 |             "city":"Bellevue",
 22 |             "state":"WA",
 23 |             "zip":"98004",
 24 |             "country":"USA",
 25 |             "phoneNumber":"800-555-1234",
 26 |             "faxNumber":"800-555-1234"
 27 |          },
 28 |          "payment":{
 29 |             "creditCard":{
 30 |                "cardNumber":"4111111111111111",
 31 |                "expirationDate":"2016-08"
 32 |             }
 33 |          }
 34 |       },
 35 |       "validationMode":"liveMode"
 36 |    }
 37 | }
 38 | 
 39 | SAMPLE RESPONSE
 40 | --------------------------------------------------------------------------------------------------
 41 | {
 42 |    "customerPaymentProfileId":"28821903",
 43 |    "validationDirectResponse":"1,1,1,This transaction has been approved.,4DHVNH,Y,2230582188,none,Test transaction for ValidateCustomerPaymentProfile.,0.00,CC,auth_only,none,John,Doe,,123 Main St.,Bellevue,WA,98004,USA,800-555-1234,800-555-1234,email@example.com,,,,,,,,,0.00,0.00,0.00,FALSE,none,E440D094322A0D406E01EDF9CE871A4F,,2,,,,,,,,,,,XXXX1111,Visa,,,,,,,,,,,,,,,,",
 44 |    "messages":{
 45 |       "resultCode":"Ok",
 46 |       "message":[
 47 |          {
 48 |             "code":"I00001",
 49 |             "text":"Successful."
 50 |          }
 51 |       ]
 52 |    }
 53 | }
 54 | 
 55 | 
 56 | *************************************************************************************************/
 57 | 
 58 | namespace Authnetjson;
 59 | 
 60 | use Exception;
 61 | 
 62 | require '../../config.inc.php';
 63 | 
 64 | try {
 65 |     $request = AuthnetApiFactory::getJsonApiHandler(
 66 |         AUTHNET_LOGIN,
 67 |         AUTHNET_TRANSKEY,
 68 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 69 |     );
 70 |     $response = $request->createCustomerPaymentProfileRequest([
 71 |         'customerProfileId' => '30582495',
 72 |         'paymentProfile' => [
 73 |             'billTo' => [
 74 |                 'firstName' => 'John',
 75 |                 'lastName' => 'Doe',
 76 |                 'company' => '',
 77 |                 'address' => '123 Main St.',
 78 |                 'city' => 'Bellevue',
 79 |                 'state' => 'WA',
 80 |                 'zip' => '98004',
 81 |                 'country' => 'USA',
 82 |                 'phoneNumber' => '800-555-1234',
 83 |                 'faxNumber' => '800-555-1234'
 84 |             ],
 85 |             'payment' => [
 86 |                 'creditCard' => [
 87 |                     'cardNumber' => '4111111111111111',
 88 |                     'expirationDate' => '2026-08'
 89 |                 ]
 90 |             ]
 91 |         ],
 92 |         'validationMode' => 'liveMode'
 93 |     ]);
 94 | } catch (Exception $e) {
 95 |     echo $e;
 96 |     exit;
 97 | }
 98 | ?>
 99 | 
100 | <!DOCTYPE html>
101 | <html lang="en">
102 | <head>
103 |     <title>CIM :: Create Payment Profile</title>
104 |     <style>
105 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
106 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
107 |         pre { white-space: pre-wrap; }
108 |         table th { background: #e5e5e5; color: #666666; }
109 |         h1, h2 { text-align: center; }
110 |     </style>
111 | </head>
112 | <body>
113 |     <h1>
114 |         CIM :: Create Payment Profile
115 |     </h1>
116 |     <h2>
117 |         Results
118 |     </h2>
119 |     <table>
120 |         <tr>
121 |             <th>Successful?</th>
122 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
123 |         </tr>
124 |         <tr>
125 |             <th>Error?</th>
126 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
127 |         </tr>
128 |         <tr>
129 |             <th>Result Code</th>
130 |             <td><?= $response->messages->resultCode ?></td>
131 |         </tr>
132 |         <tr>
133 |             <th>Message Code</th>
134 |             <td><?= $response->messages->message[0]->code ?></td>
135 |         </tr>
136 |         <tr>
137 |             <th>Message</th>
138 |             <td><?= $response->messages->message[0]->text ?></td>
139 |         </tr>
140 |         <?php if ($response->isSuccessful()) : ?>
141 |         <tr>
142 |             <th>customerProfileId</th>
143 |             <td><?= $response->customerPaymentProfileId ?></td>
144 |         </tr>
145 |         <?php endif; ?>
146 |         <tr>
147 |             <th>Transaction Approved?</th>
148 |             <td><?php echo ($response->isApproved()) ? 'yes' : 'no' ?></td>
149 |         </tr>
150 |         <tr>
151 |             <th>Authorization Code</th>
152 |             <td><?= $response->getTransactionResponseField('AuthorizationCode') ?></td>
153 |         </tr>
154 |         <tr>
155 |             <th>AVS Response</th>
156 |             <td><?= $response->getTransactionResponseField('AVSResponse') ?></td>
157 |         </tr>
158 |         <tr>
159 |             <th>Transaction ID</th>
160 |             <td><?= $response->getTransactionResponseField('TransactionID') ?></td>
161 |         </tr>
162 |     </table>
163 |     <h2>
164 |         Raw Input/Output
165 |     </h2>
166 |     <?= $request, $response ?>
167 | </body>
168 | </html>
169 | 


--------------------------------------------------------------------------------
/examples/cim/createCustomerProfileTransactionRequest_void.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to void a transaction
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "createCustomerProfileTransactionRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "transaction":{
 15 |          "profileTransVoid":{
 16 |             "customerProfileId":"31390172",
 17 |             "customerPaymentProfileId":"28393490",
 18 |             "customerShippingAddressId":"29366174",
 19 |             "transId":"2230582868"
 20 |          }
 21 |       },
 22 |       "extraOptions":"x_customer_ip=100.0.0.1"
 23 |    }
 24 | }
 25 | 
 26 | SAMPLE RESPONSE
 27 | --------------------------------------------------------------------------------------------------
 28 | {
 29 |    "directResponse":"1,1,1,This transaction has been approved.,OWW0UU,P,2230582868,INV000001,,0.00,CC,void,12345,,,,,,,12345,,,,,,,,,,,,,,,,,,0C7394DFC38A5BDC5737A354CE67B421,,,,,,,,,,,,,XXXX1111,Visa,,,,,,,,,,,,,,,,,29366174",
 30 |    "messages":{
 31 |       "resultCode":"Ok",
 32 |       "message":[
 33 |          {
 34 |             "code":"I00001",
 35 |             "text":"Successful."
 36 |          }
 37 |       ]
 38 |    }
 39 | }
 40 | 
 41 | *************************************************************************************************/
 42 | 
 43 | namespace Authnetjson;
 44 | 
 45 | use Exception;
 46 | 
 47 | require '../../config.inc.php';
 48 | 
 49 | try {
 50 |     $request = AuthnetApiFactory::getJsonApiHandler(
 51 |         AUTHNET_LOGIN,
 52 |         AUTHNET_TRANSKEY,
 53 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 54 |     );
 55 |     $response = $request->createCustomerProfileTransactionRequest([
 56 |         'transaction' => [
 57 |             'profileTransVoid' => [
 58 |                 'customerProfileId' => '31390172',
 59 |                 'customerPaymentProfileId' => '28393490',
 60 |                 'customerShippingAddressId' => '29366174',
 61 |                 'transId' => '2230582868'
 62 |             ]
 63 |         ],
 64 |         'extraOptions' => 'x_customer_ip=100.0.0.1'
 65 |     ]);
 66 | } catch (Exception $e) {
 67 |     echo $e;
 68 |     exit;
 69 | }
 70 | ?>
 71 | 
 72 | <!DOCTYPE html>
 73 | <html lang="en">
 74 | <head>
 75 |     <title>CIM :: Void</title>
 76 |     <style>
 77 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 78 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 79 |         pre { white-space: pre-wrap; }
 80 |         table th { background: #e5e5e5; color: #666666; }
 81 |         h1, h2 { text-align: center; }
 82 |     </style>
 83 | </head>
 84 | <body>
 85 |     <h1>
 86 |         CIM :: Void
 87 |     </h1>
 88 |     <h2>
 89 |         Results
 90 |     </h2>
 91 |     <table>
 92 |         <tr>
 93 |             <th>Successful?</th>
 94 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 95 |         </tr>
 96 |         <tr>
 97 |             <th>Error?</th>
 98 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
 99 |         </tr>
100 |         <tr>
101 |             <th>Result Code</th>
102 |             <td><?= $response->messages->resultCode ?></td>
103 |         </tr>
104 |         <tr>
105 |             <th>Message Code</th>
106 |             <td><?= $response->messages->message[0]->code ?></td>
107 |         </tr>
108 |         <tr>
109 |             <th>Message</th>
110 |             <td><?= $response->messages->message[0]->text ?></td>
111 |         </tr>
112 |         <tr>
113 |             <th>Transaction Approved?</th>
114 |             <td><?php echo ($response->isApproved()) ? 'yes' : 'no' ?></td>
115 |         </tr>
116 |         <tr>
117 |             <th>Authorization Code</th>
118 |             <td><?= $response->getTransactionResponseField('AuthorizationCode') ?></td>
119 |         </tr>
120 |         <tr>
121 |             <th>AVS Response</th>
122 |             <td><?= $response->getTransactionResponseField('AVSResponse') ?></td>
123 |         </tr>
124 |         <tr>
125 |             <th>Transaction ID</th>
126 |             <td><?= $response->getTransactionResponseField('TransactionID') ?></td>
127 |         </tr>
128 |     </table>
129 |     <h2>
130 |         Raw Input/Output
131 |     </h2>
132 |     <?= $request, $response ?>
133 | </body>
134 | </html>
135 | 


--------------------------------------------------------------------------------
/examples/cim/createCustomerShippingAddressRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to create a shipping profile
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "createCustomerShippingAddressRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "customerProfileId":"31390172",
 15 |       "address":{
 16 |          "firstName":"John",
 17 |          "lastName":"Doe",
 18 |          "company":"",
 19 |          "address":"123 Main St.",
 20 |          "city":"Bellevue",
 21 |          "state":"WA",
 22 |          "zip":"98004",
 23 |          "country":"USA",
 24 |          "phoneNumber":"800-555-1234",
 25 |          "faxNumber":"800-555-1234"
 26 |       }
 27 |    }
 28 | }
 29 | 
 30 | SAMPLE RESPONSE
 31 | --------------------------------------------------------------------------------------------------
 32 | {
 33 |    "customerAddressId":"29870028",
 34 |    "messages":{
 35 |       "resultCode":"Ok",
 36 |       "message":[
 37 |          {
 38 |             "code":"I00001",
 39 |             "text":"Successful."
 40 |          }
 41 |       ]
 42 |    }
 43 | }
 44 | 
 45 | *************************************************************************************************/
 46 | 
 47 | namespace Authnetjson;
 48 | 
 49 | use Exception;
 50 | 
 51 | require '../../config.inc.php';
 52 | 
 53 | try {
 54 |     $request = AuthnetApiFactory::getJsonApiHandler(
 55 |         AUTHNET_LOGIN,
 56 |         AUTHNET_TRANSKEY,
 57 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 58 |     );
 59 |     $response = $request->createCustomerShippingAddressRequest([
 60 |         'customerProfileId' => '31390172',
 61 |         'address' => [
 62 |             'firstName' => 'John',
 63 |             'lastName' => 'Doe',
 64 |             'company' => '',
 65 |             'address' => '123 Main St.',
 66 |             'city' => 'Bellevue',
 67 |             'state' => 'WA',
 68 |             'zip' => '98004',
 69 |             'country' => 'USA',
 70 |             'phoneNumber' => '800-555-1234',
 71 |             'faxNumber' => '800-555-1234'
 72 |         ]
 73 |     ]);
 74 | } catch (Exception $e) {
 75 |     echo $e;
 76 |     exit;
 77 | }
 78 | ?>
 79 | 
 80 | <!DOCTYPE html>
 81 | <html lang="en">
 82 | <head>
 83 |     <title>CIM :: Create Shipping Profile</title>
 84 |     <style>
 85 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 86 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 87 |         pre { white-space: pre-wrap; }
 88 |         table th { background: #e5e5e5; color: #666666; }
 89 |         h1, h2 { text-align: center; }
 90 |     </style>
 91 | </head>
 92 | <body>
 93 |     <h1>
 94 |         CIM :: Create Shipping Profile
 95 |     </h1>
 96 |     <h2>
 97 |         Results
 98 |     </h2>
 99 |     <table>
100 |         <tr>
101 |             <th>Successful?</th>
102 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
103 |         </tr>
104 |         <tr>
105 |             <th>Error?</th>
106 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
107 |         </tr>
108 |         <tr>
109 |             <th>Result Code</th>
110 |             <td><?= $response->messages->resultCode ?></td>
111 |         </tr>
112 |         <tr>
113 |             <th>Message Code</th>
114 |             <td><?= $response->messages->message[0]->code ?></td>
115 |         </tr>
116 |         <tr>
117 |             <th>Message</th>
118 |             <td><?= $response->messages->message[0]->text ?></td>
119 |         </tr>
120 |         <?php if ($response->isSuccessful()) : ?>
121 |         <tr>
122 |             <th>Customer Address ID</th>
123 |             <td><?= $response->customerAddressId ?></td>
124 |         </tr>
125 |         <?php endif; ?>
126 |     </table>
127 |     <h2>
128 |         Raw Input/Output
129 |     </h2>
130 |     <?= $request, $response ?>
131 | </body>
132 | </html>
133 | 


--------------------------------------------------------------------------------
/examples/cim/deleteCustomerPaymentProfileRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to delete a payment profile
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "deleteCustomerPaymentProfileRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "customerProfileId":"31390172",
 15 |       "customerPaymentProfileId":"28393490"
 16 |    }
 17 | }
 18 | 
 19 | SAMPLE RESPONSE
 20 | --------------------------------------------------------------------------------------------------
 21 | {
 22 |    "messages":{
 23 |       "resultCode":"Ok",
 24 |       "message":[
 25 |          {
 26 |             "code":"I00001",
 27 |             "text":"Successful."
 28 |          }
 29 |       ]
 30 |    }
 31 | }
 32 | 
 33 | *************************************************************************************************/
 34 | 
 35 | namespace Authnetjson;
 36 | 
 37 | use Exception;
 38 | 
 39 | require '../../config.inc.php';
 40 | 
 41 | try {
 42 |     $request = AuthnetApiFactory::getJsonApiHandler(
 43 |         AUTHNET_LOGIN,
 44 |         AUTHNET_TRANSKEY,
 45 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 46 |     );
 47 |     $response = $request->deleteCustomerPaymentProfileRequest([
 48 |         'customerProfileId' => '31390172',
 49 |         'customerPaymentProfileId' => '28393490'
 50 |     ]);
 51 | } catch (Exception $e) {
 52 |     echo $e;
 53 |     exit;
 54 | }
 55 | ?>
 56 | 
 57 | <!DOCTYPE html>
 58 | <html lang="en">
 59 | <head>
 60 |     <title>CIM :: Delete Payment Profile</title>
 61 |     <style>
 62 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 63 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 64 |         pre { white-space: pre-wrap; }
 65 |         table th { background: #e5e5e5; color: #666666; }
 66 |         h1, h2 { text-align: center; }
 67 |     </style>
 68 | </head>
 69 | <body>
 70 |     <h1>
 71 |         CIM :: Delete Payment Profile
 72 |     </h1>
 73 |     <h2>
 74 |         Results
 75 |     </h2>
 76 |     <table>
 77 |         <tr>
 78 |             <th>Successful?</th>
 79 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 80 |         </tr>
 81 |         <tr>
 82 |             <th>Error?</th>
 83 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
 84 |         </tr>
 85 |         <tr>
 86 |             <th>Result Code</th>
 87 |             <td><?= $response->messages->resultCode ?></td>
 88 |         </tr>
 89 |         <tr>
 90 |             <th>Message Code</th>
 91 |             <td><?= $response->messages->message[0]->code ?></td>
 92 |         </tr>
 93 |         <tr>
 94 |             <th>Message</th>
 95 |             <td><?= $response->messages->message[0]->text ?></td>
 96 |         </tr>
 97 |     </table>
 98 |     <h2>
 99 |         Raw Input/Output
100 |     </h2>
101 |     <?= $request, $response ?>
102 | </body>
103 | </html>
104 | 


--------------------------------------------------------------------------------
/examples/cim/deleteCustomerProfileRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to delete a customer profile
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "deleteCustomerProfileRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "customerProfileId":"31390172"
 15 |    }
 16 | }
 17 | 
 18 | SAMPLE RESPONSE
 19 | --------------------------------------------------------------------------------------------------
 20 | {
 21 |    "messages":{
 22 |       "resultCode":"Ok",
 23 |       "message":[
 24 |          {
 25 |             "code":"I00001",
 26 |             "text":"Successful."
 27 |          }
 28 |       ]
 29 |    }
 30 | }
 31 | 
 32 | *************************************************************************************************/
 33 | 
 34 | namespace Authnetjson;
 35 | 
 36 | use Exception;
 37 | 
 38 | require '../../config.inc.php';
 39 | 
 40 | try {
 41 |     $request = AuthnetApiFactory::getJsonApiHandler(
 42 |         AUTHNET_LOGIN,
 43 |         AUTHNET_TRANSKEY,
 44 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 45 |     );
 46 |     $response = $request->deleteCustomerProfileRequest([
 47 |         'customerProfileId' => '31390172'
 48 |     ]);
 49 | } catch (Exception $e) {
 50 |     echo $e;
 51 |     exit;
 52 | }
 53 | ?>
 54 | 
 55 | <!DOCTYPE html>
 56 | <html lang="en">
 57 | <head>
 58 |     <title>CIM :: Delete Customer Profile</title>
 59 |     <style>
 60 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 61 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 62 |         pre { white-space: pre-wrap; }
 63 |         table th { background: #e5e5e5; color: #666666; }
 64 |         h1, h2 { text-align: center; }
 65 |     </style>
 66 | </head>
 67 | <body>
 68 |     <h1>
 69 |         CIM :: Delete Customer Profile
 70 |     </h1>
 71 |     <h2>
 72 |         Results
 73 |     </h2>
 74 |     <table>
 75 |         <tr>
 76 |             <th>Successful?</th>
 77 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 78 |         </tr>
 79 |         <tr>
 80 |             <th>Error?</th>
 81 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
 82 |         </tr>
 83 |         <tr>
 84 |             <th>Result Code</th>
 85 |             <td><?= $response->messages->resultCode ?></td>
 86 |         </tr>
 87 |         <tr>
 88 |             <th>Message Code</th>
 89 |             <td><?= $response->messages->message[0]->code ?></td>
 90 |         </tr>
 91 |         <tr>
 92 |             <th>Message</th>
 93 |             <td><?= $response->messages->message[0]->text ?></td>
 94 |         </tr>
 95 |     </table>
 96 |     <h2>
 97 |         Raw Input/Output
 98 |     </h2>
 99 |     <?= $request, $response ?>
100 | </body>
101 | </html>
102 | 


--------------------------------------------------------------------------------
/examples/cim/deleteCustomerShippingAddressRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to delete a shipping profile
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "deleteCustomerShippingAddressRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "customerProfileId":"31390172",
 15 |       "customerAddressId":"29366174"
 16 |    }
 17 | }
 18 | 
 19 | SAMPLE RESPONSE
 20 | --------------------------------------------------------------------------------------------------
 21 | {
 22 |    "messages":{
 23 |       "resultCode":"Ok",
 24 |       "message":[
 25 |          {
 26 |             "code":"I00001",
 27 |             "text":"Successful."
 28 |          }
 29 |       ]
 30 |    }
 31 | }
 32 | 
 33 | *************************************************************************************************/
 34 | 
 35 | namespace Authnetjson;
 36 | 
 37 | use Exception;
 38 | 
 39 | require '../../config.inc.php';
 40 | 
 41 | try {
 42 |     $request = AuthnetApiFactory::getJsonApiHandler(
 43 |         AUTHNET_LOGIN,
 44 |         AUTHNET_TRANSKEY,
 45 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 46 |     );
 47 |     $response = $request->deleteCustomerShippingAddressRequest([
 48 |         'customerProfileId' => '31390172',
 49 |         'customerAddressId' => '29366174'
 50 |     ]);
 51 | } catch (Exception $e) {
 52 |     echo $e;
 53 |     exit;
 54 | }
 55 | ?>
 56 | 
 57 | <!DOCTYPE html>
 58 | <html lang="en">
 59 | <head>
 60 |     <title>CIM :: Delete Shipping Profile</title>
 61 |     <style>
 62 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 63 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 64 |         pre { white-space: pre-wrap; }
 65 |         table th { background: #e5e5e5; color: #666666; }
 66 |         h1, h2 { text-align: center; }
 67 |     </style>
 68 | </head>
 69 | <body>
 70 |     <h1>
 71 |         CIM :: Delete Shipping Profile
 72 |     </h1>
 73 |     <h2>
 74 |         Results
 75 |     </h2>
 76 |     <table>
 77 |         <tr>
 78 |             <th>Successful?</th>
 79 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 80 |         </tr>
 81 |         <tr>
 82 |             <th>Error?</th>
 83 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
 84 |         </tr>
 85 |         <tr>
 86 |             <th>Result Code</th>
 87 |             <td><?= $response->messages->resultCode ?></td>
 88 |         </tr>
 89 |         <tr>
 90 |             <th>Message Code</th>
 91 |             <td><?= $response->messages->message[0]->code ?></td>
 92 |         </tr>
 93 |         <tr>
 94 |             <th>Message</th>
 95 |             <td><?= $response->messages->message[0]->text ?></td>
 96 |         </tr>
 97 |     </table>
 98 |     <h2>
 99 |         Raw Input/Output
100 |     </h2>
101 |     <?= $request, $response ?>
102 | </body>
103 | </html>
104 | 


--------------------------------------------------------------------------------
/examples/cim/getCustomerPaymentProfileRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to retrieve a payment profile
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "getCustomerPaymentProfileRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "customerProfileId":"31390172",
 15 |       "customerPaymentProfileId":"28393490"
 16 |    }
 17 | }
 18 | 
 19 | SAMPLE RESPONSE
 20 | --------------------------------------------------------------------------------------------------
 21 | {
 22 |    "paymentProfile":{
 23 |       "customerPaymentProfileId":"28393490",
 24 |       "payment":{
 25 |          "creditCard":{
 26 |             "cardNumber":"XXXX1111",
 27 |             "expirationDate":"XXXX"
 28 |          }
 29 |       },
 30 |       "customerTypeSpecified":false,
 31 |       "billTo":{
 32 |          "phoneNumber":"800-555-1234",
 33 |          "firstName":"John",
 34 |          "lastName":"Smith",
 35 |          "address":"123 Main Street",
 36 |          "city":"Townsville",
 37 |          "state":"NJ",
 38 |          "zip":"12345"
 39 |       }
 40 |    },
 41 |    "messages":{
 42 |       "resultCode":"Ok",
 43 |       "message":[
 44 |          {
 45 |             "code":"I00001",
 46 |             "text":"Successful."
 47 |          }
 48 |       ]
 49 |    }
 50 | }
 51 | 
 52 | *************************************************************************************************/
 53 | 
 54 | namespace Authnetjson;
 55 | 
 56 | use Exception;
 57 | 
 58 | require '../../config.inc.php';
 59 | 
 60 | try {
 61 |     $request = AuthnetApiFactory::getJsonApiHandler(
 62 |         AUTHNET_LOGIN,
 63 |         AUTHNET_TRANSKEY,
 64 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 65 |     );
 66 |     $response = $request->getCustomerPaymentProfileRequest([
 67 |         'customerProfileId' => '31390172',
 68 |         'customerPaymentProfileId' => '28393490'
 69 |     ]);
 70 | } catch (Exception $e) {
 71 |     echo $e;
 72 |     exit;
 73 | }
 74 | ?>
 75 | 
 76 | <!DOCTYPE html>
 77 | <html lang="en">
 78 | <head>
 79 |     <title>CIM :: Get Payment Profile</title>
 80 |     <style>
 81 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 82 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 83 |         pre { white-space: pre-wrap; }
 84 |         table th { background: #e5e5e5; color: #666666; }
 85 |         h1, h2 { text-align: center; }
 86 |     </style>
 87 | </head>
 88 | <body>
 89 |     <h1>
 90 |         CIM :: Get Payment Profile
 91 |     </h1>
 92 |     <h2>
 93 |         Results
 94 |     </h2>
 95 |     <table>
 96 |         <tr>
 97 |             <th>Successful?</th>
 98 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 99 |         </tr>
100 |         <tr>
101 |             <th>Error?</th>
102 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
103 |         </tr>
104 |         <tr>
105 |             <th>Result Code</th>
106 |             <td><?= $response->messages->resultCode ?></td>
107 |         </tr>
108 |         <tr>
109 |             <th>Message Code</th>
110 |             <td><?= $response->messages->message[0]->code ?></td>
111 |         </tr>
112 |         <tr>
113 |             <th>Message</th>
114 |             <td><?= $response->messages->message[0]->text ?></td>
115 |         </tr>
116 |         <tr>
117 |             <th>First Name</th>
118 |             <td><?= $response->paymentProfile->billTo->firstName ?></td>
119 |         </tr>
120 |         <tr>
121 |             <th>Last Name</th>
122 |             <td><?= $response->paymentProfile->billTo->lastName ?></td>
123 |         </tr>
124 |         <tr>
125 |             <th>Address</th>
126 |             <td><?= $response->paymentProfile->billTo->address ?></td>
127 |         </tr>
128 |         <tr>
129 |             <th>City</th>
130 |             <td><?= $response->paymentProfile->billTo->city ?></td>
131 |         </tr>
132 |         <tr>
133 |             <th>State</th>
134 |             <td><?= $response->paymentProfile->billTo->state ?></td>
135 |         </tr>
136 |         <tr>
137 |             <th>Zip</th>
138 |             <td><?= $response->paymentProfile->billTo->zip ?></td>
139 |         </tr>
140 |         <tr>
141 |             <th>Phone Number</th>
142 |             <td><?= $response->paymentProfile->billTo->phoneNumber ?></td>
143 |         </tr>
144 |         <tr>
145 |             <th>Customer Payment ProfileId</th>
146 |             <td><?= $response->paymentProfile->customerPaymentProfileId ?></td>
147 |         </tr>
148 |         <tr>
149 |             <th>Card Number</th>
150 |             <td><?= $response->paymentProfile->payment->creditCard->cardNumber ?></td>
151 |         </tr>
152 |         <tr>
153 |             <th>Expiration Date</th>
154 |             <td><?= $response->paymentProfile->payment->creditCard->expirationDate ?></td>
155 |         </tr>
156 |     </table>
157 |     <h2>
158 |         Raw Input/Output
159 |     </h2>
160 | <?= $request, $response ?>
161 | </body>
162 | </html>
163 | 


--------------------------------------------------------------------------------
/examples/cim/getCustomerProfileIdsRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to retrieve a list of profile IDs
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "getCustomerProfileIdsRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       }
 14 |    }
 15 | }
 16 | 
 17 | SAMPLE RESPONSE
 18 | --------------------------------------------------------------------------------------------------
 19 | {
 20 |    "ids":[
 21 |       "20320494",
 22 |       "20320495",
 23 |       "20320496",
 24 |       "20320497",
 25 |       "20320499",
 26 |       "20382791",
 27 |       "20522161",
 28 |       "20522247",
 29 |       "20522344",
 30 |       "20522529",
 31 |       "20529466",
 32 |       "20532466",
 33 |       "20533743",
 34 |       "20533892",
 35 |       "20631798",
 36 |       "21176851",
 37 |       "21267776",
 38 |       "21267786",
 39 |       "21268552",
 40 |       "21268866",
 41 |       "21323330",
 42 |       "21387453",
 43 |       "21452273",
 44 |       "21503525",
 45 |       "21507048",
 46 |       "21520223",
 47 |       "21533869",
 48 |       "21630064",
 49 |       "21631076",
 50 |       "21644324",
 51 |       "21755205",
 52 |       "21783775",
 53 |       "22820980",
 54 |       "22853636",
 55 |       "22912790",
 56 |       "22913090",
 57 |       "23896146",
 58 |       "23942782",
 59 |       "24353242",
 60 |       "24415694",
 61 |       "24431080",
 62 |       "24873651",
 63 |       "24874921",
 64 |       "24875645",
 65 |       "25139838",
 66 |       "25286149",
 67 |       "25287624",
 68 |       "25697926",
 69 |       "25933750",
 70 |       "26564070",
 71 |       "26564773",
 72 |       "26583007",
 73 |       "26585538",
 74 |       "26585555",
 75 |       "26585578",
 76 |       "26586275",
 77 |       "26648484",
 78 |       "26648913",
 79 |       "27389717",
 80 |       "27667711",
 81 |       "27713150",
 82 |       "27984649",
 83 |       "27984720",
 84 |       "27984879",
 85 |       "28012856",
 86 |       "28023333",
 87 |       "28023355",
 88 |       "28023366",
 89 |       "28023374",
 90 |       "28421203",
 91 |       "28421294",
 92 |       "28440218",
 93 |       "28440239",
 94 |       "28440287",
 95 |       "28440368",
 96 |       "28473202",
 97 |       "28473492",
 98 |       "28474805",
 99 |       "28596453",
100 |       "28705962",
101 |       "28722134",
102 |       "28774792",
103 |       "28907593",
104 |       "30582495",
105 |       "30582501",
106 |       "31390172"
107 |    ],
108 |    "messages":{
109 |       "resultCode":"Ok",
110 |       "message":[
111 |          {
112 |             "code":"I00001",
113 |             "text":"Successful."
114 |          }
115 |       ]
116 |    }
117 | }
118 | 
119 | *************************************************************************************************/
120 | 
121 | namespace Authnetjson;
122 | 
123 | use Exception;
124 | use Symfony\Component\Config\Definition\Builder\EnumNodeDefinition;
125 | 
126 | require '../../config.inc.php';
127 | 
128 | try {
129 |     $request = AuthnetApiFactory::getJsonApiHandler(
130 |         AUTHNET_LOGIN,
131 |         AUTHNET_TRANSKEY,
132 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
133 |     );
134 |     $response = $request->getCustomerProfileIdsRequest();
135 | } catch (Exception $e) {
136 |     echo $e;
137 |     exit;
138 | }
139 | ?>
140 | 
141 | <!DOCTYPE html>
142 | <html lang="en">
143 | <head>
144 |     <title>CIM :: Get Customer Profile IDs</title>
145 |     <style>
146 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
147 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
148 |         pre { white-space: pre-wrap; }
149 |         table th { background: #e5e5e5; color: #666666; }
150 |         h1, h2 { text-align: center; }
151 |     </style>
152 | </head>
153 | <body>
154 |     <h1>
155 |         CIM :: Get Customer Profile IDs
156 |     </h1>
157 |     <h2>
158 |         Results
159 |     </h2>
160 |     <table>
161 |         <tr>
162 |             <th>Successful?</th>
163 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
164 |         </tr>
165 |         <tr>
166 |             <th>Error?</th>
167 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
168 |         </tr>
169 |         <tr>
170 |             <th>Result Code</th>
171 |             <td><?= $response->messages->resultCode ?></td>
172 |         </tr>
173 |         <tr>
174 |             <th>Message Code</th>
175 |             <td><?= $response->messages->message[0]->code ?></td>
176 |         </tr>
177 |         <tr>
178 |             <th>Message</th>
179 |             <td><?= $response->messages->message[0]->text ?></td>
180 |         </tr>
181 |         <tr>
182 |             <th>Profile IDs</th>
183 |             <td>
184 |                 <?= implode(', ', $response->ids) ?>
185 |             </td>
186 |         </tr>
187 |     </table>
188 |     <h2>
189 |         Raw Input/Output
190 |     </h2>
191 |     <?= $request, $response ?>
192 | </body>
193 | </html>
194 | 


--------------------------------------------------------------------------------
/examples/cim/getCustomerShippingAddressRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to retrieve a shipping address
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "getCustomerShippingAddressRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "customerProfileId":"31390172",
 15 |       "customerAddressId":"29366174"
 16 |    }
 17 | }
 18 | 
 19 | SAMPLE RESPONSE
 20 | --------------------------------------------------------------------------------------------------
 21 | {
 22 |    "address":{
 23 |       "customerAddressId":"29366174",
 24 |       "phoneNumber":"800-555-1234",
 25 |       "firstName":"John",
 26 |       "lastName":"Smith",
 27 |       "address":"123 Main Street",
 28 |       "city":"Townsville",
 29 |       "state":"NJ",
 30 |       "zip":"12345"
 31 |    },
 32 |    "messages":{
 33 |       "resultCode":"Ok",
 34 |       "message":[
 35 |          {
 36 |             "code":"I00001",
 37 |             "text":"Successful."
 38 |          }
 39 |       ]
 40 |    }
 41 | }
 42 | 
 43 | *************************************************************************************************/
 44 | 
 45 | namespace Authnetjson;
 46 | 
 47 | use Exception;
 48 | 
 49 | require '../../config.inc.php';
 50 | 
 51 | try {
 52 |     $request = AuthnetApiFactory::getJsonApiHandler(
 53 |         AUTHNET_LOGIN,
 54 |         AUTHNET_TRANSKEY,
 55 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 56 |     );
 57 |     $response = $request->getCustomerShippingAddressRequest([
 58 |         'customerProfileId' => '31390172',
 59 |         'customerAddressId' => '29366174'
 60 |     ]);
 61 | } catch (Exception $e) {
 62 |     echo $e;
 63 |     exit;
 64 | }
 65 | ?>
 66 | 
 67 | <!DOCTYPE html>
 68 | <html lang="en">
 69 | <head>
 70 |     <title>CIM :: Get Shipping Address</title>
 71 |     <style>
 72 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 73 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 74 |         pre { white-space: pre-wrap; }
 75 |         table th { background: #e5e5e5; color: #666666; }
 76 |         h1, h2 { text-align: center; }
 77 |     </style>
 78 | </head>
 79 | <body>
 80 |     <h1>
 81 |         CIM :: Get Shipping Address
 82 |     </h1>
 83 |     <h2>
 84 |         Results
 85 |     </h2>
 86 |     <table>
 87 |         <tr>
 88 |             <th>Successful?</th>
 89 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 90 |         </tr>
 91 |         <tr>
 92 |             <th>Error?</th>
 93 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
 94 |         </tr>
 95 |         <tr>
 96 |             <th>Result Code</th>
 97 |             <td><?= $response->messages->resultCode ?></td>
 98 |         </tr>
 99 |         <tr>
100 |             <th>Message Code</th>
101 |             <td><?= $response->messages->message[0]->code ?></td>
102 |         </tr>
103 |         <tr>
104 |             <th>Message</th>
105 |             <td><?= $response->messages->message[0]->text ?></td>
106 |         </tr>
107 |         <tr>
108 |             <th>First Name</th>
109 |             <td><?= $response->address->firstName ?></td>
110 |         </tr>
111 |         <tr>
112 |             <th>Last Name</th>
113 |             <td><?= $response->address->lastName ?></td>
114 |         </tr>
115 |         <tr>
116 |             <th>Address</th>
117 |             <td><?= $response->address->address ?></td>
118 |         </tr>
119 |         <tr>
120 |             <th>City</th>
121 |             <td><?= $response->address->city ?></td>
122 |         </tr>
123 |         <tr>
124 |             <th>State</th>
125 |             <td><?= $response->address->state ?></td>
126 |         </tr>
127 |         <tr>
128 |             <th>Zip</th>
129 |             <td><?= $response->address->zip ?></td>
130 |         </tr>
131 |         <tr>
132 |             <th>Phone Number</th>
133 |             <td><?= $response->address->phoneNumber ?></td>
134 |         </tr>
135 |         <tr>
136 |             <th>Customer Address Id</th>
137 |             <td><?= $response->address->customerAddressId ?></td>
138 |         </tr>
139 |     </table>
140 |     <h2>
141 |         Raw Input/Output
142 |     </h2>
143 | <?= $request, $response ?>
144 | </body>
145 | </html>
146 | 


--------------------------------------------------------------------------------
/examples/cim/getHostedProfilePageRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to retrieve a hosted payment page token
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "getHostedProfilePageRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "customerProfileId":"31390172",
 15 |       "hostedProfileSettings":{
 16 |          "setting":{
 17 |             "settingName":"hostedProfilePageBorderVisible",
 18 |             "settingValue":"true"
 19 |          }
 20 |       }
 21 |    }
 22 | }
 23 | 
 24 | SAMPLE RESPONSE
 25 | --------------------------------------------------------------------------------------------------
 26 | {
 27 |    "token":"Mvwo9mTx2vS332eCFY3rFzh/x1x64henm7rppLYQxd2cOzNpw+bfp1ZTVKvu98XSIvL9VIEB65mCFtzchN/pFKBdBA0daBukS27pWYxZuo6QpBUpz2p6zLENX8qH9wCcAw6EJr0MZkNttPW6b+Iw9eKfcBtJayq6kdNm9m1ywANHsg9xME4qUccBXnY2cCf3kLaaLNJhhiNxJmcboKNlDn5HtIQ/wcRnxB4YbqddTN8=",
 28 |    "messages":{
 29 |       "resultCode":"Ok",
 30 |       "message":[
 31 |          {
 32 |             "code":"I00001",
 33 |             "text":"Successful."
 34 |          }
 35 |       ]
 36 |    }
 37 | }
 38 | 
 39 | *************************************************************************************************/
 40 | 
 41 | namespace Authnetjson;
 42 | 
 43 | use Exception;
 44 | 
 45 | require '../../config.inc.php';
 46 | 
 47 | try {
 48 |     $request = AuthnetApiFactory::getJsonApiHandler(
 49 |         AUTHNET_LOGIN,
 50 |         AUTHNET_TRANSKEY,
 51 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 52 |     );
 53 |     $response = $request->getHostedProfilePageRequest([
 54 |         'customerProfileId' => '31390172',
 55 |         'hostedProfileSettings' => [
 56 |             [
 57 |                 'settingName' => 'hostedProfileReturnUrl',
 58 |                 'settingValue' => 'https://blah.com/blah/',
 59 |             ],
 60 |             [
 61 |                 'settingName' => 'hostedProfileReturnUrlText',
 62 |                 'settingValue' => 'Continue to blah.',
 63 |             ],
 64 |             [
 65 |                 'settingName' => 'hostedProfilePageBorderVisible',
 66 |                 'settingValue' => 'true',
 67 |             ]
 68 |         ]
 69 |     ]);
 70 | } catch (Exception $e) {
 71 |     echo $e;
 72 |     exit;
 73 | }
 74 | ?>
 75 | 
 76 | <!DOCTYPE html>
 77 | <html lang="en">
 78 | <head>
 79 |     <title>CIM :: Get Hosted Profile Page</title>
 80 |     <style>
 81 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 82 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 83 |         pre { white-space: pre-wrap; }
 84 |         table th { background: #e5e5e5; color: #666666; }
 85 |         h1, h2 { text-align: center; }
 86 |     </style>
 87 | </head>
 88 | <body>
 89 |     <h1>
 90 |         CIM :: Get Hosted Profile Page
 91 |     </h1>
 92 |     <h2>
 93 |         Results
 94 |     </h2>
 95 |     <table>
 96 |         <tr>
 97 |             <th>Successful?</th>
 98 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 99 |         </tr>
100 |         <tr>
101 |             <th>Error?</th>
102 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
103 |         </tr>
104 |         <tr>
105 |             <th>Result Code</th>
106 |             <td><?= $response->messages->resultCode ?></td>
107 |         </tr>
108 |         <tr>
109 |             <th>Message Code</th>
110 |             <td><?= $response->messages->message[0]->code ?></td>
111 |         </tr>
112 |         <tr>
113 |             <th>Message</th>
114 |             <td><?= $response->messages->message[0]->text ?></td>
115 |         </tr>
116 |         <tr>
117 |             <th>Token</th>
118 |             <td><?= $response->token ?></td>
119 |         </tr>
120 |     </table>
121 |     <h2>
122 |         Raw Input/Output
123 |     </h2>
124 |     <?= $request, $response ?>
125 | </body>
126 | </html>
127 | 


--------------------------------------------------------------------------------
/examples/cim/updateCustomerPaymentProfileRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to update a customer profile
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "updateCustomerPaymentProfileRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "customerProfileId":"31390172",
 15 |       "paymentProfile":{
 16 |          "billTo":{
 17 |             "firstName":"John",
 18 |             "lastName":"Doe",
 19 |             "company":"",
 20 |             "address":"123 Main St.",
 21 |             "city":"Bellevue",
 22 |             "state":"WA",
 23 |             "zip":"98004",
 24 |             "country":"USA",
 25 |             "phoneNumber":"800-555-1234",
 26 |             "faxNumber":"800-555-1234"
 27 |          },
 28 |          "payment":{
 29 |             "creditCard":{
 30 |                "cardNumber":"4111111111111111",
 31 |                "expirationDate":"2016-08"
 32 |             }
 33 |          },
 34 |          "customerPaymentProfileId":"28393490"
 35 |       }
 36 |    }
 37 | }
 38 | 
 39 | SAMPLE RESPONSE
 40 | --------------------------------------------------------------------------------------------------
 41 | {
 42 |    "messages":{
 43 |       "resultCode":"Ok",
 44 |       "message":[
 45 |          {
 46 |             "code":"I00001",
 47 |             "text":"Successful."
 48 |          }
 49 |       ]
 50 |    }
 51 | }
 52 | 
 53 | *************************************************************************************************/
 54 | 
 55 | namespace Authnetjson;
 56 | 
 57 | use Exception;
 58 | 
 59 | require '../../config.inc.php';
 60 | 
 61 | try {
 62 |     $request = AuthnetApiFactory::getJsonApiHandler(
 63 |         AUTHNET_LOGIN,
 64 |         AUTHNET_TRANSKEY,
 65 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 66 |     );
 67 |     $response = $request->updateCustomerPaymentProfileRequest([
 68 |         'customerProfileId' => '31390172',
 69 |         'paymentProfile' => [
 70 |             'billTo' => [
 71 |                 'firstName' => 'John',
 72 |                 'lastName' => 'Doe',
 73 |                 'company' => '',
 74 |                 'address' => '123 Main St.',
 75 |                 'city' => 'Bellevue',
 76 |                 'state' => 'WA',
 77 |                 'zip' => '98004',
 78 |                 'country' => 'USA',
 79 |                 'phoneNumber' => '800-555-1234',
 80 |                 'faxNumber' => '800-555-1234'
 81 |             ],
 82 |             'payment' => [
 83 |                 'creditCard' => [
 84 |                     'cardNumber' => '4111111111111111',
 85 |                     'expirationDate' => '2016-08'
 86 |                 ]
 87 |             ],
 88 |             'customerPaymentProfileId' => '28393490'
 89 |         ]
 90 |     ]);
 91 | } catch (Exception $e) {
 92 |     echo $e;
 93 |     exit;
 94 | }
 95 | ?>
 96 | 
 97 | <!DOCTYPE html>
 98 | <html lang="en">
 99 | <head>
100 |     <title>CIM :: Update Customer Profile</title>
101 |     <style>
102 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
103 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
104 |         pre { white-space: pre-wrap; }
105 |         table th { background: #e5e5e5; color: #666666; }
106 |         h1, h2 { text-align: center; }
107 |     </style>
108 | </head>
109 | <body>
110 |     <h1>
111 |         CIM :: Update Customer Profile
112 |     </h1>
113 |     <h2>
114 |         Results
115 |     </h2>
116 |     <table>
117 |         <tr>
118 |             <th>Successful?</th>
119 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
120 |         </tr>
121 |         <tr>
122 |             <th>Error?</th>
123 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
124 |         </tr>
125 |         <tr>
126 |             <th>Result Code</th>
127 |             <td><?= $response->messages->resultCode ?></td>
128 |         </tr>
129 |         <tr>
130 |             <th>Message Code</th>
131 |             <td><?= $response->messages->message[0]->code ?></td>
132 |         </tr>
133 |         <tr>
134 |             <th>Message</th>
135 |             <td><?= $response->messages->message[0]->text ?></td>
136 |         </tr>
137 |     </table>
138 |     <h2>
139 |         Raw Input/Output
140 |     </h2>
141 |     <?= $request, $response ?>
142 | </body>
143 | </html>
144 | 


--------------------------------------------------------------------------------
/examples/cim/updateCustomerProfileRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to update a customer profile
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "updateCustomerProfileRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "profile":{
 15 |          "merchantCustomerId":"12345",
 16 |          "description":"some description",
 17 |          "email":"newaddress@example.com",
 18 |          "customerProfileId":"31390172"
 19 |       }
 20 |    }
 21 | }
 22 | 
 23 | SAMPLE RESPONSE
 24 | --------------------------------------------------------------------------------------------------
 25 | {
 26 |    "messages":{
 27 |       "resultCode":"Ok",
 28 |       "message":[
 29 |          {
 30 |             "code":"I00001",
 31 |             "text":"Successful."
 32 |          }
 33 |       ]
 34 |    }
 35 | }
 36 | 
 37 | *************************************************************************************************/
 38 | 
 39 | namespace Authnetjson;
 40 | 
 41 | use Exception;
 42 | 
 43 | require '../../config.inc.php';
 44 | 
 45 | try {
 46 |     $request = AuthnetApiFactory::getJsonApiHandler(
 47 |         AUTHNET_LOGIN,
 48 |         AUTHNET_TRANSKEY,
 49 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 50 |     );
 51 |     $response = $request->updateCustomerProfileRequest([
 52 |         'profile' => [
 53 |             'merchantCustomerId' => '12345',
 54 |             'description' => 'some description',
 55 |             'email' => 'newaddress@example.com',
 56 |             'customerProfileId' => '31390172'
 57 |         ]
 58 |     ]);
 59 | } catch (Exception $e) {
 60 |     echo $e;
 61 |     exit;
 62 | }
 63 | ?>
 64 | 
 65 | <!DOCTYPE html>
 66 | <html lang="en">
 67 | <head>
 68 |     <title>CIM :: Update Customer Profile</title>
 69 |     <style>
 70 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 71 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 72 |         pre { white-space: pre-wrap; }
 73 |         table th { background: #e5e5e5; color: #666666; }
 74 |         h1, h2 { text-align: center; }
 75 |     </style>
 76 | </head>
 77 | <body>
 78 |     <h1>
 79 |         CIM :: Update Customer Profile
 80 |     </h1>
 81 |     <h2>
 82 |         Results
 83 |     </h2>
 84 |     <table>
 85 |         <tr>
 86 |             <th>Successful?</th>
 87 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 88 |         </tr>
 89 |         <tr>
 90 |             <th>Error?</th>
 91 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
 92 |         </tr>
 93 |         <tr>
 94 |             <th>Result Code</th>
 95 |             <td><?= $response->messages->resultCode ?></td>
 96 |         </tr>
 97 |         <tr>
 98 |             <th>Message Code</th>
 99 |             <td><?= $response->messages->message[0]->code ?></td>
100 |         </tr>
101 |         <tr>
102 |             <th>Message</th>
103 |             <td><?= $response->messages->message[0]->text ?></td>
104 |         </tr>
105 |     </table>
106 |     <h2>
107 |         Raw Input/Output
108 |     </h2>
109 |     <?= $request, $response ?>
110 | </body>
111 | </html>
112 | 


--------------------------------------------------------------------------------
/examples/cim/updateCustomerShippingAddressRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to update a shipping address
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "updateCustomerShippingAddressRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "customerProfileId":"31390172",
 15 |       "address":{
 16 |          "firstName":"John",
 17 |          "lastName":"Doe",
 18 |          "company":"",
 19 |          "address":"123 Main St.",
 20 |          "city":"Bellevue",
 21 |          "state":"WA",
 22 |          "zip":"98004",
 23 |          "country":"USA",
 24 |          "phoneNumber":"800-555-1234",
 25 |          "faxNumber":"800-555-1234",
 26 |          "customerAddressId":"29366174"
 27 |       }
 28 |    }
 29 | }
 30 | 
 31 | SAMPLE RESPONSE
 32 | --------------------------------------------------------------------------------------------------
 33 | {
 34 |    "messages":{
 35 |       "resultCode":"Ok",
 36 |       "message":[
 37 |          {
 38 |             "code":"I00001",
 39 |             "text":"Successful."
 40 |          }
 41 |       ]
 42 |    }
 43 | }
 44 | 
 45 | *************************************************************************************************/
 46 | 
 47 | namespace Authnetjson;
 48 | 
 49 | use Exception;
 50 | 
 51 | require '../../config.inc.php';
 52 | 
 53 | try {
 54 |     $request = AuthnetApiFactory::getJsonApiHandler(
 55 |         AUTHNET_LOGIN,
 56 |         AUTHNET_TRANSKEY,
 57 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 58 |     );
 59 |     $response = $request->updateCustomerShippingAddressRequest([
 60 |         'customerProfileId' => '31390172',
 61 |         'address' => [
 62 |             'firstName' => 'John',
 63 |             'lastName' => 'Doe',
 64 |             'company' => '',
 65 |             'address' => '123 Main St.',
 66 |             'city' => 'Bellevue',
 67 |             'state' => 'WA',
 68 |             'zip' => '98004',
 69 |             'country' => 'USA',
 70 |             'phoneNumber' => '800-555-1234',
 71 |             'faxNumber' => '800-555-1234',
 72 |             'customerAddressId' => '29366174'
 73 |         ]
 74 |     ]);
 75 | } catch (Exception $e) {
 76 |     echo $e;
 77 |     exit;
 78 | }
 79 | ?>
 80 | 
 81 | <!DOCTYPE html>
 82 | <html lang="en">
 83 | <head>
 84 |     <title>CIM :: Update Shipping Address</title>
 85 |     <style>
 86 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 87 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 88 |         pre { white-space: pre-wrap; }
 89 |         table th { background: #e5e5e5; color: #666666; }
 90 |         h1, h2 { text-align: center; }
 91 |     </style>
 92 | </head>
 93 | <body>
 94 |     <h1>
 95 |         CIM :: Update Shipping Address
 96 |     </h1>
 97 |     <h2>
 98 |         Results
 99 |     </h2>
100 |     <table>
101 |         <tr>
102 |             <th>Successful?</th>
103 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
104 |         </tr>
105 |         <tr>
106 |             <th>Error?</th>
107 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
108 |         </tr>
109 |         <tr>
110 |             <th>Result Code</th>
111 |             <td><?= $response->messages->resultCode ?></td>
112 |         </tr>
113 |         <tr>
114 |             <th>Message Code</th>
115 |             <td><?= $response->messages->message[0]->code ?></td>
116 |         </tr>
117 |         <tr>
118 |             <th>Message</th>
119 |             <td><?= $response->messages->message[0]->text ?></td>
120 |         </tr>
121 |     </table>
122 |     <h2>
123 |         Raw Input/Output
124 |     </h2>
125 |     <?= $request, $response ?>
126 | </body>
127 | </html>
128 | 


--------------------------------------------------------------------------------
/examples/cim/updateSplitTenderGroupRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to update a split tender transaction
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "updateSplitTenderGroupRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "splitTenderId":"123456",
 15 |       "splitTenderStatus":"voided"
 16 |    }
 17 | }
 18 | 
 19 | SAMPLE RESPONSE
 20 | --------------------------------------------------------------------------------------------------
 21 | {
 22 |    "messages":{
 23 |       "resultCode":"Ok",
 24 |       "message":[
 25 |          {
 26 |             "code":"I00001",
 27 |             "text":"Successful."
 28 |          }
 29 |       ]
 30 |    }
 31 | }
 32 | 
 33 | *************************************************************************************************/
 34 | 
 35 | namespace Authnetjson;
 36 | 
 37 | use Exception;
 38 | 
 39 | require '../../config.inc.php';
 40 | 
 41 | try {
 42 |     $request = AuthnetApiFactory::getJsonApiHandler(
 43 |         AUTHNET_LOGIN,
 44 |         AUTHNET_TRANSKEY,
 45 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 46 |     );
 47 |     $response = $request->updateSplitTenderGroupRequest([
 48 |         'splitTenderId' => '123456',
 49 |         'splitTenderStatus' => 'voided'
 50 |     ]);
 51 | } catch (Exception $e) {
 52 |     echo $e;
 53 |     exit;
 54 | }
 55 | ?>
 56 | 
 57 | <!DOCTYPE html>
 58 | <html lang="en">
 59 | <head>
 60 |     <title>CIM :: Update Split Tender Group</title>
 61 |     <style>
 62 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 63 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 64 |         pre { white-space: pre-wrap; }
 65 |         table th { background: #e5e5e5; color: #666666; }
 66 |         h1, h2 { text-align: center; }
 67 |     </style>
 68 | </head>
 69 | <body>
 70 |     <h1>
 71 |         CIM :: Update Split Tender Group
 72 |     </h1>
 73 |     <h2>
 74 |         Results
 75 |     </h2>
 76 |     <table>
 77 |         <tr>
 78 |             <th>Successful?</th>
 79 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 80 |         </tr>
 81 |         <tr>
 82 |             <th>Error?</th>
 83 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
 84 |         </tr>
 85 |         <tr>
 86 |             <th>Result Code</th>
 87 |             <td><?= $response->messages->resultCode ?></td>
 88 |         </tr>
 89 |         <tr>
 90 |             <th>Message Code</th>
 91 |             <td><?= $response->messages->message[0]->code ?></td>
 92 |         </tr>
 93 |         <tr>
 94 |             <th>Message</th>
 95 |             <td><?= $response->messages->message[0]->text ?></td>
 96 |         </tr>
 97 |     </table>
 98 |     <h2>
 99 |         Raw Input/Output
100 |     </h2>
101 |     <?= $request, $response ?>
102 | </body>
103 | </html>
104 | 


--------------------------------------------------------------------------------
/examples/cim/validateCustomerPaymentProfileRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*************************************************************************************************
  3 | 
  4 | Use the CIM JSON API to validate a payment profile
  5 | 
  6 | SAMPLE REQUEST
  7 | --------------------------------------------------------------------------------------------------
  8 | {
  9 |    "validateCustomerPaymentProfileRequest":{
 10 |       "merchantAuthentication":{
 11 |          "name":"",
 12 |          "transactionKey":""
 13 |       },
 14 |       "customerProfileId":"31390172",
 15 |       "customerPaymentProfileId":"28393490",
 16 |       "customerShippingAddressId":"29366174",
 17 |       "validationMode":"liveMode"
 18 |    }
 19 | }
 20 | 
 21 | SAMPLE RESPONSE
 22 | --------------------------------------------------------------------------------------------------
 23 | {
 24 |    "directResponse":"1,1,1,This transaction has been approved.,5Q8DGW,Y,2230582939,none,Test transaction for ValidateCustomerPaymentProfile.,0.00,CC,auth_only,12345,John,Smith,,123 Main Street,Townsville,NJ,12345,,800-555-1234,,user@example.com,John,Smith,,123 Main Street,Townsville,NJ,12345,,0.00,0.00,0.00,FALSE,none,6160655F3F4DF72144DCE15C0AEE15B1,,2,,,,,,,,,,,XXXX1111,Visa,,,,,,,,,,,,,,,,,29366174",
 25 |    "messages":{
 26 |       "resultCode":"Ok",
 27 |       "message":[
 28 |          {
 29 |             "code":"I00001",
 30 |             "text":"Successful."
 31 |          }
 32 |       ]
 33 |    }
 34 | }
 35 | 
 36 | *************************************************************************************************/
 37 | 
 38 | namespace Authnetjson;
 39 | 
 40 | use Exception;
 41 | 
 42 | require '../../config.inc.php';
 43 | 
 44 | try {
 45 |     $request = AuthnetApiFactory::getJsonApiHandler(
 46 |         AUTHNET_LOGIN,
 47 |         AUTHNET_TRANSKEY,
 48 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 49 |     );
 50 |     $response = $request->validateCustomerPaymentProfileRequest([
 51 |         'customerProfileId' => '31390172',
 52 |         'customerPaymentProfileId' => '28393490',
 53 |         'customerShippingAddressId' => '29366174',
 54 |         'validationMode' => 'liveMode'
 55 |     ]);
 56 | } catch (Exception $e) {
 57 |     echo $e;
 58 |     exit;
 59 | }
 60 | ?>
 61 | 
 62 | <!DOCTYPE html>
 63 | <html lang="en">
 64 | <head>
 65 |     <title>CIM :: Validate Payment Profile</title>
 66 |     <style>
 67 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 68 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 69 |         pre { white-space: pre-wrap; }
 70 |         table th { background: #e5e5e5; color: #666666; }
 71 |         h1, h2 { text-align: center; }
 72 |     </style>
 73 | </head>
 74 | <body>
 75 |     <h1>
 76 |         CIM :: Validate Payment Profile
 77 |     </h1>
 78 |     <h2>
 79 |         Results
 80 |     </h2>
 81 |     <table>
 82 |         <tr>
 83 |             <th>Successful?</th>
 84 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
 85 |         </tr>
 86 |         <tr>
 87 |             <th>Error?</th>
 88 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
 89 |         </tr>
 90 |         <tr>
 91 |             <th>Result Code</th>
 92 |             <td><?= $response->messages->resultCode ?></td>
 93 |         </tr>
 94 |         <tr>
 95 |             <th>Message Code</th>
 96 |             <td><?= $response->messages->message[0]->code ?></td>
 97 |         </tr>
 98 |         <tr>
 99 |             <th>Message</th>
100 |             <td><?= $response->messages->message[0]->text ?></td>
101 |         </tr>
102 |         <tr>
103 |             <th>Transaction Approved?</th>
104 |             <td><?php echo ($response->isApproved()) ? 'yes' : 'no' ?></td>
105 |         </tr>
106 |         <tr>
107 |             <th>Authorization Code</th>
108 |             <td><?= $response->getTransactionResponseField('AuthorizationCode') ?></td>
109 |         </tr>
110 |         <tr>
111 |             <th>AVS Response</th>
112 |             <td><?= $response->getTransactionResponseField('AVSResponse') ?></td>
113 |         </tr>
114 |         <tr>
115 |             <th>Transaction ID</th>
116 |             <td><?= $response->getTransactionResponseField('TransactionID') ?></td>
117 |         </tr>
118 |     </table>
119 |     <h2>
120 |         Raw Input/Output
121 |     </h2>
122 |     <?= $request, $response ?>
123 | </body>
124 | </html>
125 | 


--------------------------------------------------------------------------------
/examples/reporting/getAUJobSummaryRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Call this function and supply your authentication information to receive merchant details in the response.
 15 | The information that is returned is helpful for OAuth and Accept integrations. Generate a PublicClientKey only
 16 | if one is not generated or is not active. Only the most recently generated active key is returned.
 17 | 
 18 | SAMPLE REQUEST
 19 | --------------------------------------------------------------------------------------------------
 20 | {
 21 |   "getAUJobSummaryRequest": {
 22 |     "merchantAuthentication": {
 23 |       "name": "",
 24 |       "transactionKey": ""
 25 |     },
 26 |     "refId": "123456",
 27 |     "month": "2020-04"
 28 |   }
 29 | }
 30 | 
 31 | SAMPLE RESPONSE
 32 | --------------------------------------------------------------------------------------------------
 33 | {
 34 |   "auSummary":
 35 |   {
 36 |     "auResponse":
 37 |     [
 38 |       {
 39 |         "auReasonCode": "ACL",
 40 |         "profileCount": 11,
 41 |         "reasonDescription": "AccountClosed"
 42 |       },
 43 |       {
 44 |         "auReasonCode": "NAN",
 45 |         "profileCount": 17,
 46 |         "reasonDescription": "NewAccountNumber"
 47 |       },
 48 |       {
 49 |         "auReasonCode": "NED",
 50 |         "profileCount": 23,
 51 |         "reasonDescription": "NewExpirationDate"
 52 |       }
 53 |     ]
 54 |   },
 55 |   "refId": 123456,
 56 |   "messages":
 57 |   {
 58 |     "resultCode": "Ok",
 59 |     "message":
 60 |     {
 61 |       "code": "I00001",
 62 |       "text": "Successful."
 63 |     }
 64 |   }
 65 | }
 66 | 
 67 | *************************************************************************************************/
 68 | 
 69 | namespace Authnetjson;
 70 | 
 71 | use Exception;
 72 | 
 73 | require '../../config.inc.php';
 74 | 
 75 | try {
 76 |     $request = AuthnetApiFactory::getJsonApiHandler(
 77 |         AUTHNET_LOGIN,
 78 |         AUTHNET_TRANSKEY,
 79 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 80 |     );
 81 |     $response = $request->getAUJobSummaryRequest([
 82 |         'refId' => "123456",
 83 |         'month' => "2020-05"
 84 |     ]);
 85 | } catch (Exception $e) {
 86 |     echo $e;
 87 |     exit;
 88 | }
 89 | ?>
 90 | 
 91 | <!DOCTYPE html>
 92 | <html lang="en">
 93 | <head>
 94 |     <title>Transaction Detail :: Get Account Updater Job Summary</title>
 95 |     <style>
 96 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 97 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 98 |         pre { white-space: pre-wrap; }
 99 |         table th { background: #e5e5e5; color: #666666; }
100 |         h1, h2 { text-align: center; }
101 |     </style>
102 | </head>
103 | <body>
104 |     <h1>
105 |         Transaction Detail :: Get Account Updater Job Summary
106 |     </h1>
107 |     <h2>
108 |         Results
109 |     </h2>
110 |     <table>
111 |         <tr>
112 |             <th>Response</th>
113 |             <td><?= $response->messages->resultCode ?></td>
114 |         </tr>
115 |         <tr>
116 |             <th>Successful?</th>
117 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
118 |         </tr>
119 |         <tr>
120 |             <th>Error?</th>
121 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
122 |         </tr>
123 |         <tr>
124 |             <th>Code</th>
125 |             <td><?= $response->messages->message[0]->code ?></td>
126 |         </tr>
127 |         <tr>
128 |             <th>Message</th>
129 |             <td><?= $response->messages->message[0]->text ?></td>
130 |         </tr>
131 |         <tr>
132 |             <th>Reference ID</th>
133 |             <td><?= $response->refId ?></td>
134 |         </tr>
135 |         <?php if (count($response->auSummary)) : ?>
136 |             <?php foreach ($response->auSummary->auResponse as $aujob) : ?>
137 |             <tr>
138 |                 <th>Response</th>
139 |                 <td>
140 |                     AU Reason Code: <?= $aujob->auReasonCode ?><br>
141 |                     Profile Count: <?= $aujob->profileCount ?><br>
142 |                     Reason Description: <?= $aujob->reasonDescription ?>
143 |                 </td>
144 |             </tr>
145 |             <?php endforeach; ?>
146 |         <?php endif; ?>
147 |     </table>
148 |     <h2>
149 |         Raw Input/Output
150 |     </h2>
151 | <?= $request, $response ?>
152 | </body>
153 | </html>
154 | 


--------------------------------------------------------------------------------
/examples/reporting/getMerchantDetailsRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Call this function and supply your authentication information to receive merchant details in the response.
 15 | The information that is returned is helpful for OAuth and Accept integrations. Generate a PublicClientKey only
 16 | if one is not generated or is not active. Only the most recently generated active key is returned.
 17 | 
 18 | SAMPLE REQUEST
 19 | --------------------------------------------------------------------------------------------------
 20 | {
 21 |     "getMerchantDetailsRequest": {
 22 |         "merchantAuthentication": {
 23 |             "name": "",
 24 |             "transactionKey": ""
 25 |         }
 26 |     }
 27 | }
 28 | 
 29 | SAMPLE RESPONSE
 30 | --------------------------------------------------------------------------------------------------
 31 | {
 32 |     "isTestMode": false,
 33 |     "processors": [
 34 |         {
 35 |             "name": "First Data Nashville"
 36 |         }
 37 |     ],
 38 |     "merchantName": "fwHGwSdCaR",
 39 |     "gatewayId": "565697",
 40 |     "marketTypes": [
 41 |         "eCommerce"
 42 |     ],
 43 |     "productCodes": [
 44 |         "CNP"
 45 |     ],
 46 |     "paymentMethods": [
 47 |         "AmericanExpress",
 48 |         "DinersClub",
 49 |         "Discover",
 50 |         "EnRoute",
 51 |         "JCB",
 52 |         "Mastercard",
 53 |         "Visa"
 54 |     ],
 55 |     "currencies": [
 56 |         "USD"
 57 |     ],
 58 |     "publicClientKey": "9aptdYwtHt2F22XLRgr4B9AM4Pkt5eb6b6MC9d2Nn3m3YEptx3RFFuXmpYWDLHev",
 59 |     "messages": {
 60 |         "resultCode": "Ok",
 61 |         "message": [
 62 |             {
 63 |                 "code": "I00001",
 64 |                 "text": "Successful."
 65 |             }
 66 |         ]
 67 |     }
 68 | }
 69 | 
 70 | *************************************************************************************************/
 71 | 
 72 | namespace Authnetjson;
 73 | 
 74 | use Exception;
 75 | 
 76 | require '../../config.inc.php';
 77 | 
 78 | try {
 79 |     $request = AuthnetApiFactory::getJsonApiHandler(
 80 |         AUTHNET_LOGIN,
 81 |         AUTHNET_TRANSKEY,
 82 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 83 |     );
 84 |     $response = $request->getMerchantDetailsRequest();
 85 | } catch (Exception $e) {
 86 |     echo $e;
 87 |     exit;
 88 | }
 89 | ?>
 90 | 
 91 | <!DOCTYPE html>
 92 | <html lang="en">
 93 | <head>
 94 |     <title>Transaction Detail :: Get Merchant Details</title>
 95 |     <style>
 96 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 97 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 98 |         pre { white-space: pre-wrap; }
 99 |         table th { background: #e5e5e5; color: #666666; }
100 |         h1, h2 { text-align: center; }
101 |     </style>
102 | </head>
103 | <body>
104 |     <h1>
105 |         Transaction Detail :: Get Merchant Details
106 |     </h1>
107 |     <h2>
108 |         Results
109 |     </h2>
110 |     <table>
111 |         <tr>
112 |             <th>Response</th>
113 |             <td><?= $response->messages->resultCode ?></td>
114 |         </tr>
115 |         <tr>
116 |             <th>Successful?</th>
117 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
118 |         </tr>
119 |         <tr>
120 |             <th>Error?</th>
121 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
122 |         </tr>
123 |         <tr>
124 |             <th>Code</th>
125 |             <td><?= $response->messages->message[0]->code ?></td>
126 |         </tr>
127 |         <tr>
128 |             <th>Message</th>
129 |             <td><?= $response->messages->message[0]->text ?></td>
130 |         </tr>
131 |         <tr>
132 |             <th>Merchant Name</th>
133 |             <td><?= $response->merchantName ?></td>
134 |         </tr>
135 |         <tr>
136 |             <th>Gateway Id</th>
137 |             <td><?= $response->gatewayId ?></td>
138 |         </tr>
139 |         <tr>
140 |             <th>Processors</th>
141 |             <td>
142 |                 <?php foreach ($response->processors as $processor) : ?>
143 |                     <?php printf('%s<br>', $processor->name) ?>
144 |                 <?php endforeach; ?>
145 |             </td>
146 |         </tr>
147 |         <tr>
148 |             <th>Market Types</th>
149 |             <td><?= implode(', ', $response->marketTypes) ?></td>
150 |         </tr>
151 |         <tr>
152 |             <th>Product Codes</th>
153 |             <td><?= implode(', ', $response->productCodes) ?></td>
154 |         </tr>
155 |         <tr>
156 |             <th>Payment Methods</th>
157 |             <td><?= implode(', ', $response->paymentMethods) ?></td>
158 |         </tr>
159 |         <tr>
160 |             <th>Currencies</th>
161 |             <td><?= implode(', ', $response->currencies) ?></td>
162 |         </tr>
163 |         <tr>
164 |             <th>Public Client Key</th>
165 |             <td><?= $response->publicClientKey ?></td>
166 |         </tr>
167 |     </table>
168 |     <h2>
169 |         Raw Input/Output
170 |     </h2>
171 | <?= $request, $response ?>
172 | </body>
173 | </html>
174 | 


--------------------------------------------------------------------------------
/examples/reporting/getTransactionDetailsRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Use the Transaction Details API to get the details of a transaction
 15 | 
 16 | SAMPLE REQUEST
 17 | --------------------------------------------------------------------------------------------------
 18 | {
 19 |    "getTransactionDetailsRequest":{
 20 |       "merchantAuthentication":{
 21 |          "name":"",
 22 |          "transactionKey":""
 23 |       },
 24 |       "transId":"2162566217"
 25 |    }
 26 | }
 27 | 
 28 | SAMPLE RESPONSE
 29 | --------------------------------------------------------------------------------------------------
 30 | {
 31 |    "transaction":{
 32 |       "transId":"2162566217",
 33 |       "submitTimeUTC":"2011-09-01T16:30:49.39Z",
 34 |       "submitTimeLocal":"2011-09-01T10:30:49.39",
 35 |       "transactionType":"authCaptureTransaction",
 36 |       "transactionStatus":"settledSuccessfully",
 37 |       "responseCode":1,
 38 |       "responseReasonCode":1,
 39 |       "responseReasonDescription":"Approval",
 40 |       "authCode":"JPG9DJ",
 41 |       "AVSResponse":"Y",
 42 |       "batch":{
 43 |          "batchId":"1221577",
 44 |          "settlementTimeUTC":"2011-09-01T16:38:54.52Z",
 45 |          "settlementTimeUTCSpecified":true,
 46 |          "settlementTimeLocal":"2011-09-01T10:38:54.52",
 47 |          "settlementTimeLocalSpecified":true,
 48 |          "settlementState":"settledSuccessfully"
 49 |       },
 50 |       "order":{
 51 |          "invoiceNumber":"60",
 52 |          "description":"Auto-charge for Invoice #60"
 53 |       },
 54 |       "requestedAmountSpecified":false,
 55 |       "authAmount":1018.88,
 56 |       "settleAmount":1018.88,
 57 |       "prepaidBalanceRemainingSpecified":false,
 58 |       "taxExempt":false,
 59 |       "taxExemptSpecified":true,
 60 |       "payment":{
 61 |          "creditCard":{
 62 |             "cardNumber":"XXXX4444",
 63 |             "expirationDate":"XXXX",
 64 |             "cardType":"MasterCard"
 65 |          }
 66 |       },
 67 |       "customer":{
 68 |          "typeSpecified":false,
 69 |          "id":"4"
 70 |       },
 71 |       "billTo":{
 72 |          "phoneNumber":"(619) 274-0494",
 73 |          "firstName":"Matteo",
 74 |          "lastName":"Bignotti",
 75 |          "address":"625 Broadway\nSuite 1025",
 76 |          "city":"San Diego",
 77 |          "state":"CA",
 78 |          "zip":"92101",
 79 |          "country":"United States"
 80 |       },
 81 |       "recurringBilling":false,
 82 |       "recurringBillingSpecified":true,
 83 |       "product":"Card Not Present",
 84 |       "marketType":"eCommerce"
 85 |    },
 86 |    "messages":{
 87 |       "resultCode":"Ok",
 88 |       "message":[
 89 |          {
 90 |             "code":"I00001",
 91 |             "text":"Successful."
 92 |          }
 93 |       ]
 94 |    }
 95 | }
 96 | 
 97 | *************************************************************************************************/
 98 | 
 99 | namespace Authnetjson;
100 | 
101 | use Exception;
102 | 
103 | require '../../config.inc.php';
104 | 
105 | try {
106 |     $request = AuthnetApiFactory::getJsonApiHandler(
107 |         AUTHNET_LOGIN,
108 |         AUTHNET_TRANSKEY,
109 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
110 |     );
111 |     $response = $request->getTransactionDetailsRequest([
112 |         'transId' => '40067511400'
113 |     ]);
114 | } catch (Exception $e) {
115 |     echo $e;
116 |     exit;
117 | }
118 | ?>
119 | 
120 | <!DOCTYPE html>
121 | <html lang="en">
122 | <head>
123 |     <title>Transaction Detail :: Transaction Details</title>
124 |     <style>
125 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
126 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
127 |         pre { white-space: pre-wrap; }
128 |         table th { background: #e5e5e5; color: #666666; }
129 |         h1, h2 { text-align: center; }
130 |     </style>
131 | </head>
132 | <body>
133 |     <h1>
134 |         Transaction Detail :: Transaction Details
135 |     </h1>
136 |     <h2>
137 |         Results
138 |     </h2>
139 |     <table>
140 |         <tr>
141 |             <th>Response</th>
142 |             <td><?= $response->messages->resultCode ?></td>
143 |         </tr>
144 |         <tr>
145 |             <th>Successful?</th>
146 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
147 |         </tr>
148 |         <tr>
149 |             <th>Error?</th>
150 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
151 |         </tr>
152 |         <tr>
153 |             <th>Code</th>
154 |             <td><?= $response->messages->message[0]->code ?></td>
155 |         </tr>
156 |         <tr>
157 |             <th>Message</th>
158 |             <td><?= $response->messages->message[0]->text ?></td>
159 |         </tr>
160 |         <tr>
161 |             <th>Transaction</th>
162 |             <td>
163 |                 <b>ID</b>: <?php echo $response->transaction->transId; ?><br>
164 |                 <b>Type</b>: <?php echo $response->transaction->transactionType; ?><br>
165 |                 <b>Status</b>: <?php echo $response->transaction->transactionStatus; ?><br>
166 |                 <b>Authorization Code</b>: <?php echo $response->transaction->authCode; ?><br>
167 |                 <b>AVS Response</b>: <?php echo $response->transaction->AVSResponse; ?><br>
168 |             </td>
169 |         </tr>
170 |     </table>
171 |     <h2>
172 |         Raw Input/Output
173 |     </h2>
174 | <?= $request, $response ?>
175 | </body>
176 | </html>
177 | 


--------------------------------------------------------------------------------
/examples/reporting/getTransactionListRequest.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | /*
  4 |  * This file is part of the AuthnetJSON package.
  5 |  *
  6 |  * (c) John Conde <stymiee@gmail.com>
  7 |  *
  8 |  * For the full copyright and license information, please view the LICENSE
  9 |  * file that was distributed with this source code.
 10 |  */
 11 | 
 12 | /*************************************************************************************************
 13 | 
 14 | Use the Transaction Details API to get a list of transaction in a batch
 15 | 
 16 | SAMPLE REQUEST
 17 | --------------------------------------------------------------------------------------------------
 18 | {
 19 |    "getTransactionListRequest":{
 20 |       "merchantAuthentication":{
 21 |          "name":"",
 22 |          "transactionKey":""
 23 |       },
 24 |       "batchId":"1221577"
 25 |    }
 26 | }
 27 | 
 28 | SAMPLE RESPONSE
 29 | --------------------------------------------------------------------------------------------------
 30 | {
 31 |    "transactions":[
 32 |       {
 33 |          "transId":"2162566217",
 34 |          "submitTimeUTC":"2011-09-01T16:30:49Z",
 35 |          "submitTimeLocal":"2011-09-01T10:30:49",
 36 |          "transactionStatus":"settledSuccessfully",
 37 |          "invoiceNumber":"60",
 38 |          "firstName":"Matteo",
 39 |          "lastName":"Bignotti",
 40 |          "accountType":"MasterCard",
 41 |          "accountNumber":"XXXX4444",
 42 |          "settleAmount":1018.88,
 43 |          "marketType":"eCommerce",
 44 |          "product":"Card Not Present",
 45 |          "hasReturnedItemsSpecified":false
 46 |       }
 47 |    ],
 48 |    "messages":{
 49 |       "resultCode":"Ok",
 50 |       "message":[
 51 |          {
 52 |             "code":"I00001",
 53 |             "text":"Successful."
 54 |          }
 55 |       ]
 56 |    }
 57 | }
 58 | 
 59 | *************************************************************************************************/
 60 | 
 61 | namespace Authnetjson;
 62 | 
 63 | use Exception;
 64 | 
 65 | require '../../config.inc.php';
 66 | 
 67 | try {
 68 |     $request = AuthnetApiFactory::getJsonApiHandler(
 69 |         AUTHNET_LOGIN,
 70 |         AUTHNET_TRANSKEY,
 71 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 72 |     );
 73 |     $response = $request->getTransactionListRequest([
 74 |         'batchId' => '7864228'
 75 |     ]);
 76 | } catch (Exception $e) {
 77 |     echo $e;
 78 |     exit;
 79 | }
 80 | ?>
 81 | 
 82 | <!DOCTYPE html>
 83 | <html lang="en">
 84 | <head>
 85 |     <title>Transaction Detail :: Get Transactions List</title>
 86 |     <style>
 87 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 88 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 89 |         pre { white-space: pre-wrap; }
 90 |         table th { background: #e5e5e5; color: #666666; }
 91 |         h1, h2 { text-align: center; }
 92 |     </style>
 93 | </head>
 94 | <body>
 95 |     <h1>
 96 |         Transaction Detail :: Get Transactions List
 97 |     </h1>
 98 |     <h2>
 99 |         Results
100 |     </h2>
101 |     <table>
102 |         <tr>
103 |             <th>Response</th>
104 |             <td><?= $response->messages->resultCode ?></td>
105 |         </tr>
106 |         <tr>
107 |             <th>Successful?</th>
108 |             <td><?= $response->isSuccessful() ? 'yes' : 'no' ?></td>
109 |         </tr>
110 |         <tr>
111 |             <th>Error?</th>
112 |             <td><?= $response->isError() ? 'yes' : 'no' ?></td>
113 |         </tr>
114 |         <tr>
115 |             <th>Code</th>
116 |             <td><?= $response->messages->message[0]->code ?></td>
117 |         </tr>
118 |         <tr>
119 |             <th>Message</th>
120 |             <td><?= $response->messages->message[0]->text ?></td>
121 |         </tr>
122 |         <?php foreach ($response->transactions as $transaction) : ?>
123 |         <tr>
124 |             <th>Transaction</th>
125 |             <td>
126 |                 transId: <?php echo $transaction->transId; ?><br>
127 |                 submitTimeUTC: <?php echo $transaction->submitTimeUTC; ?><br>
128 |                 submitTimeLocal: <?php echo $transaction->submitTimeLocal; ?><br>
129 |                 transactionStatus: <?php echo $transaction->transactionStatus; ?><br>
130 |                 invoiceNumber: <?php echo $transaction->invoiceNumber; ?><br>
131 |                 firstName: <?php echo $transaction->firstName; ?><br>
132 |                 accountType: <?php echo $transaction->accountType; ?><br>
133 |                 accountNumber: <?php echo $transaction->accountNumber; ?><br>
134 |                 settleAmount: <?php echo $transaction->settleAmount; ?><br>
135 |             </td>
136 |         </tr>
137 |         <?php endforeach; ?>
138 |     </table>
139 |     <h2>
140 |         Raw Input/Output
141 |     </h2>
142 | <?= $request, $response ?>
143 | </body>
144 | </html>
145 | 


--------------------------------------------------------------------------------
/examples/sim/sim.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | /*
 4 |  * This file is part of the AuthnetJSON package.
 5 |  *
 6 |  * (c) John Conde <stymiee@gmail.com>
 7 |  *
 8 |  * For the full copyright and license information, please view the LICENSE
 9 |  * file that was distributed with this source code.
10 |  */
11 | 
12 | /*************************************************************************************************
13 | 
14 | Use the SIM tools to create a SIM transaction form
15 | 
16 | *************************************************************************************************/
17 | 
18 | namespace Authnetjson;
19 | 
20 | use Exception;
21 | 
22 | require '../../config.inc.php';
23 | 
24 | try {
25 |     $sim = AuthnetApiFactory::getSimHandler(
26 |         AUTHNET_LOGIN,
27 |         AUTHNET_SIGNATURE,
28 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
29 |     );
30 |     $amount = 10.00;
31 |     $login = $sim->getLogin();
32 |     $url = $sim->getEndpoint();
33 |     $fingerprint = $sim->getFingerprint($amount);
34 |     $sequence = $sim->getSequence();
35 |     $timestamp = $sim->getTimestamp();
36 | } catch (Exception $e) {
37 |     echo $e;
38 |     exit;
39 | }
40 | ?>
41 | 
42 | <!DOCTYPE html>
43 | <html lang="en">
44 | <head>
45 |     <title>SIM (Deprecated)</title>
46 | </head>
47 | <body>
48 |     <h1>
49 |         SIM (Deprecated)
50 |     </h1>
51 |     <pre>
52 |         Login: <?= $login ?><br>
53 |         Endpoint: <?= $url ?><br>
54 |         Hash: <?= $fingerprint ?><br>
55 |         Sequence: <?= $sequence ?><br>
56 |         Timestamp: <?= $timestamp ?>
57 |     </pre>
58 |     <form method="post" action="<?= $url ?>">
59 |         <input type='hidden' name='x_login' value='<?= $login ?>' />
60 |         <input type='hidden' name='x_amount' value='<?= $amount ?>' />
61 |         <input type='hidden' name='x_description' value='<?= 'Test Transaction' ?>' />
62 |         <input type='hidden' name='x_invoice_num' value='<?= '123456789' ?>' />
63 |         <input type='hidden' name='x_fp_sequence' value='<?= $sequence ?>' />
64 |         <input type='hidden' name='x_fp_timestamp' value='<?= $timestamp ?>' />
65 |         <input type='hidden' name='x_fp_hash' value='<?= $fingerprint ?>' />
66 |         <input type='hidden' name='x_show_form' value='PAYMENT_FORM' />
67 |         <input type='submit' value='Submit' />
68 |     </form>
69 | </body>
70 | </html>
71 | 


--------------------------------------------------------------------------------
/examples/webhooks/createWebhook.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the AuthnetJSON package.
  4 |  *
  5 |  * (c) John Conde <stymiee@gmail.com>
  6 |  *
  7 |  * For the full copyright and license information, please view the LICENSE
  8 |  * file that was distributed with this source code.
  9 |  */
 10 | 
 11 | /*************************************************************************************************
 12 | 
 13 | Use the Webhooks API to create a webhook
 14 | 
 15 | SAMPLE REQUEST
 16 | --------------------------------------------------------------------------------------------------
 17 | 
 18 | POST https://apitest.authorize.net/rest/v1/webhooks
 19 | 
 20 | {
 21 |     "url": "http://localhost:55950/api/webhooks",
 22 |     "eventTypes": [
 23 |         "net.authorize.payment.authcapture.created",
 24 |         "net.authorize.customer.created",
 25 |         "net.authorize.customer.paymentProfile.created",
 26 |         "net.authorize.customer.subscription.expiring"
 27 |     ],
 28 |     "status": "active"
 29 | }
 30 | 
 31 | 
 32 | SAMPLE RESPONSE
 33 | --------------------------------------------------------------------------------------------------
 34 | 
 35 | {
 36 |     "_links": {
 37 |         "self": {
 38 |             "href": "/rest/v1/webhooks/72a55c78-66e6-4b1e-a4d6-3f925c00561f"
 39 |         }
 40 |     },
 41 |     "webhookId": "72a55c78-66e6-4b1e-a4d6-3f925c00561f",
 42 |     "eventTypes": [
 43 |         "net.authorize.payment.authcapture.created",
 44 |         "net.authorize.customer.created",
 45 |         "net.authorize.customer.paymentProfile.created",
 46 |         "net.authorize.customer.subscription.expiring"
 47 |     ],
 48 |     "status": "active",
 49 |     "url": "http://localhost:55950/api/webhooks"
 50 | }
 51 | 
 52 | *************************************************************************************************/
 53 | 
 54 | namespace Authnetjson;
 55 | 
 56 | use Exception;
 57 | 
 58 | require '../../config.inc.php';
 59 | 
 60 | try {
 61 |     $request = AuthnetApiFactory::getWebhooksHandler(
 62 |         AUTHNET_LOGIN,
 63 |         AUTHNET_TRANSKEY,
 64 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 65 |     );
 66 |     $response = $request->createWebhooks([
 67 |         'net.authorize.customer.created',
 68 |         'net.authorize.customer.deleted',
 69 |         'net.authorize.customer.updated',
 70 |         'net.authorize.customer.paymentProfile.created',
 71 |         'net.authorize.customer.paymentProfile.deleted',
 72 |         'net.authorize.customer.paymentProfile.updated',
 73 |         'net.authorize.customer.subscription.cancelled',
 74 |         'net.authorize.customer.subscription.created',
 75 |         'net.authorize.customer.subscription.expiring',
 76 |         'net.authorize.customer.subscription.suspended',
 77 |         'net.authorize.customer.subscription.terminated',
 78 |         'net.authorize.customer.subscription.updated',
 79 |         'net.authorize.payment.authcapture.created',
 80 |         'net.authorize.payment.authorization.created',
 81 |         'net.authorize.payment.capture.created',
 82 |         'net.authorize.payment.fraud.approved',
 83 |         'net.authorize.payment.fraud.declined',
 84 |         'net.authorize.payment.fraud.held',
 85 |         'net.authorize.payment.priorAuthCapture.created',
 86 |         'net.authorize.payment.refund.created',
 87 |         'net.authorize.payment.void.created'
 88 |     ], 'http://requestb.in/', 'active');
 89 |     $successful = true;
 90 |     $error      = false;
 91 | } catch (Exception $e) {
 92 |     echo $e;
 93 |     exit;
 94 | }
 95 | 
 96 | ?>
 97 | <!DOCTYPE html>
 98 | <html lang="en">
 99 |     <head>
100 |         <title>Webhooks :: Create Webhooks</title>
101 |         <style>
102 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
103 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
104 |         pre { white-space: pre-wrap; }
105 |         table th { background: #e5e5e5; color: #666666; }
106 |         h1, h2 { text-align: center; }
107 |     </style>
108 | </head>
109 | <body>
110 |     <h1>
111 |         Webhooks :: Create Webhooks
112 |     </h1>
113 |     <h2>
114 |         Results
115 |     </h2>
116 |     <table>
117 |         <tr>
118 |             <th>Successful</th>
119 |             <td><?= ($successful) ? 'Yes' : 'No';?></td>
120 |         </tr>
121 | <?php if ($successful) : ?>
122 |             <tr>
123 |                 <th>Event Types</th>
124 |                 <td>
125 |                     <?php
126 |                     foreach ($response->getEventTypes() as $eventType) {
127 |                         echo $eventType, "<br>\n";
128 |                     }
129 |                     ?>
130 |                 </td>
131 |             </tr>
132 |             <tr>
133 |                 <th>Webhook ID</th>
134 |                 <td><?= $response->getWebhooksId() ?></td>
135 |             </tr>
136 |             <tr>
137 |                 <th>Status</th>
138 |                 <td><?= $response->getStatus() ?></td>
139 |             </tr>
140 |             <tr>
141 |                 <th>URL</th>
142 |                 <td><?= $response->getUrl() ?></td>
143 |             </tr>
144 | <?php elseif ($error) : ?>
145 |             <tr>
146 |                 <th>Error message</th>
147 |                 <td><?= $response->errorMessage ?></td>
148 |             </tr>
149 | <?php endif; ?>
150 |     </table>
151 |     <h2>
152 |         Raw Input/Output
153 |     </h2>
154 | <?= $request, $response ?>
155 | </body>
156 | </html>
157 | 


--------------------------------------------------------------------------------
/examples/webhooks/deleteWebhook.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the AuthnetJSON package.
 4 |  *
 5 |  * (c) John Conde <stymiee@gmail.com>
 6 |  *
 7 |  * For the full copyright and license information, please view the LICENSE
 8 |  * file that was distributed with this source code.
 9 |  */
10 | 
11 | /*************************************************************************************************
12 | 
13 | Use the Webhooks API to
14 | 
15 | SAMPLE REQUEST
16 | --------------------------------------------------------------------------------------------------
17 | 
18 | DELETE https://apitest.authorize.net/rest/v1/webhooks/<webhookId>
19 | 
20 | 
21 | SAMPLE RESPONSE
22 | --------------------------------------------------------------------------------------------------
23 | 
24 | HTTP response code 200 will be returned for a successful deletion
25 | 
26 | 
27 |  *************************************************************************************************/
28 | 
29 | namespace Authnetjson;
30 | 
31 | use Exception;
32 | 
33 | require '../../config.inc.php';
34 | 
35 | try {
36 |     $request = AuthnetApiFactory::getWebhooksHandler(
37 |         AUTHNET_LOGIN,
38 |         AUTHNET_TRANSKEY,
39 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
40 |     );
41 |     $request->deleteWebhook('0550f061-59a1-4f13-a9da-3e8bfc50e80b');
42 |     $successful = true;
43 |     $error      = false;
44 | } catch (Exception $e) {
45 |     echo $e;
46 |     exit;
47 | }
48 | 
49 | ?>
50 | <!DOCTYPE html>
51 | <html lang="en">
52 | <head>
53 |     <title>Webhooks :: Delete Webhooks</title>
54 |     <style>
55 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
56 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
57 |         pre { white-space: pre-wrap; }
58 |         table th { background: #e5e5e5; color: #666666; }
59 |         h1, h2 { text-align: center; }
60 |     </style>
61 | </head>
62 | <body>
63 | <h1>
64 |     Webhooks :: Delete Webhooks
65 | </h1>
66 | <h2>
67 |     Results
68 | </h2>
69 | <table>
70 |     <tr>
71 |         <th>Successful</th>
72 |         <td><?= ($successful) ? 'Yes' : 'No';?></td>
73 |     </tr>
74 |     <?php
75 |     if ($error) {
76 |         ?>
77 |         <tr>
78 |             <th>Error message</th>
79 |             <td><?= $response->errorMessage ?></td>
80 |         </tr>
81 |         <?php
82 |     }
83 |     ?>
84 | </table>
85 | <h2>
86 |     Raw Input/Output
87 | </h2>
88 | <?php
89 | echo $request;
90 | ?>
91 | </body>
92 | </html>
93 | 


--------------------------------------------------------------------------------
/examples/webhooks/getEventTypes.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the AuthnetJSON package.
  4 |  *
  5 |  * (c) John Conde <stymiee@gmail.com>
  6 |  *
  7 |  * For the full copyright and license information, please view the LICENSE
  8 |  * file that was distributed with this source code.
  9 |  */
 10 | 
 11 | /*************************************************************************************************
 12 | 
 13 | Use the Webhooks API to retreive a list of all available webhooks
 14 | 
 15 | SAMPLE REQUEST
 16 | --------------------------------------------------------------------------------------------------
 17 | 
 18 | GET https://apitest.authorize.net/rest/v1/eventtypes
 19 | 
 20 | 
 21 | SAMPLE RESPONSE
 22 | --------------------------------------------------------------------------------------------------
 23 | 
 24 | [
 25 |     {
 26 |         "name": "net.authorize.customer.created"
 27 |     },
 28 |     {
 29 |         "name": "net.authorize.customer.deleted"
 30 |     },
 31 |     {
 32 |         "name": "net.authorize.customer.updated"
 33 |     },
 34 |     {
 35 |         "name": "net.authorize.customer.paymentProfile.created"
 36 |     },
 37 |     {
 38 |         "name": "net.authorize.customer.paymentProfile.deleted"
 39 |     },
 40 |     {
 41 |         "name": "net.authorize.customer.paymentProfile.updated"
 42 |     },
 43 |     {
 44 |         "name": "net.authorize.customer.subscription.cancelled"
 45 |     },
 46 |     {
 47 |         "name": "net.authorize.customer.subscription.created"
 48 |     },
 49 |     {
 50 |         "name": "net.authorize.customer.subscription.expiring"
 51 |     },
 52 |     {
 53 |         "name": "net.authorize.customer.subscription.suspended"
 54 |     },
 55 |     {
 56 |         "name": "net.authorize.customer.subscription.terminated"
 57 |     },
 58 |     {
 59 |         "name": "net.authorize.customer.subscription.updated"
 60 |     },
 61 |     {
 62 |         "name": "net.authorize.payment.authcapture.created"
 63 |     },
 64 |     {
 65 |         "name": "net.authorize.payment.authorization.created"
 66 |     },
 67 |     {
 68 |         "name": "net.authorize.payment.capture.created"
 69 |     },
 70 |     {
 71 |         "name": "net.authorize.payment.fraud.approved"
 72 |     },
 73 |     {
 74 |         "name": "net.authorize.payment.fraud.declined"
 75 |     },
 76 |     {
 77 |         "name": "net.authorize.payment.fraud.held"
 78 |     },
 79 |     {
 80 |         "name": "net.authorize.payment.priorAuthCapture.created"
 81 |     },
 82 |     {
 83 |         "name": "net.authorize.payment.refund.created"
 84 |     },
 85 |     {
 86 |         "name": "net.authorize.payment.void.created"
 87 |     }
 88 | ]
 89 | 
 90 |  *************************************************************************************************/
 91 | 
 92 | namespace Authnetjson;
 93 | 
 94 | use Exception;
 95 | 
 96 | require '../../config.inc.php';
 97 | 
 98 | try {
 99 |     $request = AuthnetApiFactory::getWebhooksHandler(
100 |         AUTHNET_LOGIN,
101 |         AUTHNET_TRANSKEY,
102 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
103 |     );
104 |     $response   = $request->getEventTypes();
105 |     $successful = true;
106 |     $error      = false;
107 | } catch (Exception $e) {
108 |     echo $e;
109 |     exit;
110 | }
111 | 
112 | ?>
113 | <!DOCTYPE html>
114 | <html lang="en">
115 | <head>
116 |     <title>Webhooks :: Get Event Types</title>
117 |     <style>
118 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
119 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
120 |         pre { white-space: pre-wrap; }
121 |         table th { background: #e5e5e5; color: #666666; }
122 |         h1, h2 { text-align: center; }
123 |     </style>
124 | </head>
125 | <body>
126 | <h1>
127 |     Webhooks :: Get Event Types
128 | </h1>
129 | <h2>
130 |     Results
131 | </h2>
132 | <table>
133 |     <tr>
134 |         <th>Successful</th>
135 |         <td><?= ($successful) ? 'Yes' : 'No';?></td>
136 |     </tr>
137 |     <?php
138 |     if ($successful) {
139 |         ?>
140 |         <tr>
141 |             <th>Event Types</th>
142 |             <td>
143 |                 <?php
144 |                 foreach ($response->getEventTypes() as $eventType) {
145 |                     echo $eventType, "<br>\n";
146 |                 }
147 |                 ?>
148 |             </td>
149 |         </tr>
150 |         <?php
151 |     }
152 |     elseif ($error) {
153 |         ?>
154 |         <tr>
155 |             <th>Error message</th>
156 |             <td><?= $response->errorMessage ?></td>
157 |         </tr>
158 |         <?php
159 |     }
160 |     ?>
161 | </table>
162 | <h2>
163 |     Raw Input/Output
164 | </h2>
165 | <?= $request, $response ?>
166 | </body>
167 | </html>
168 | 


--------------------------------------------------------------------------------
/examples/webhooks/getWebhook.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the AuthnetJSON package.
  4 |  *
  5 |  * (c) John Conde <stymiee@gmail.com>
  6 |  *
  7 |  * For the full copyright and license information, please view the LICENSE
  8 |  * file that was distributed with this source code.
  9 |  */
 10 | 
 11 | /*************************************************************************************************
 12 | 
 13 | Use the Webhooks API to retrieve a webhook
 14 | 
 15 | SAMPLE REQUEST
 16 | --------------------------------------------------------------------------------------------------
 17 | 
 18 | GET https://apitest.authorize.net/rest/v1/webhooks/72a55c78-66e6-4b1e-a4d6-3f925c00561f
 19 | 
 20 | 
 21 | SAMPLE RESPONSE
 22 | --------------------------------------------------------------------------------------------------
 23 | 
 24 | {
 25 |     "_links": {
 26 |         "self": {
 27 |             "href": "/rest/v1/webhooks/72a55c78-66e6-4b1e-a4d6-3f925c00561f"
 28 |         }
 29 |     },
 30 |     "webhookId": "72a55c78-66e6-4b1e-a4d6-3f925c00561f",
 31 |     "eventTypes": [
 32 |         "net.authorize.payment.authcapture.created",
 33 |         "net.authorize.customer.created",
 34 |         "net.authorize.customer.paymentProfile.created",
 35 |         "net.authorize.customer.subscription.expiring"
 36 |     ],
 37 |     "status": "active",
 38 |     "url": "http://localhost:55950/api/webhooks"
 39 | }
 40 | 
 41 | 
 42 |  *************************************************************************************************/
 43 | 
 44 | namespace Authnetjson;
 45 | 
 46 | use Exception;
 47 | 
 48 | require '../../config.inc.php';
 49 | 
 50 | try {
 51 |     $request = AuthnetApiFactory::getWebhooksHandler(
 52 |         AUTHNET_LOGIN,
 53 |         AUTHNET_TRANSKEY,
 54 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 55 |     );
 56 |     $response   = $request->getWebhook('cd2c262f-2723-4848-ae92-5d317902441c');
 57 |     $successful = true;
 58 |     $error      = false;
 59 | } catch (Exception $e) {
 60 |     echo $e;
 61 |     exit;
 62 | }
 63 | 
 64 | ?>
 65 | <!DOCTYPE html>
 66 | <html lang="en">
 67 | <head>
 68 |     <title>Webhooks :: Get A Webhook</title>
 69 |     <style>
 70 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 71 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 72 |         pre { white-space: pre-wrap; }
 73 |         table th { background: #e5e5e5; color: #666666; }
 74 |         h1, h2 { text-align: center; }
 75 |     </style>
 76 | </head>
 77 | <body>
 78 | <h1>
 79 |     Webhooks :: Get A Webhook
 80 | </h1>
 81 | <h2>
 82 |     Results
 83 | </h2>
 84 | <table>
 85 |     <tr>
 86 |         <th>Successful</th>
 87 |         <td><?= ($successful) ? 'Yes' : 'No';?></td>
 88 |     </tr>
 89 |     <?php
 90 |     if ($successful) {
 91 |         ?>
 92 |         <tr>
 93 |             <th>Event Types</th>
 94 |             <td>
 95 |                 <?php
 96 |                 foreach ($response->getEventTypes() as $eventType) {
 97 |                     echo $eventType, "<br>\n";
 98 |                 }
 99 |                 ?>
100 |             </td>
101 |         </tr>
102 |         <tr>
103 |             <th>Webhook ID</th>
104 |             <td><?= $response->getWebhooksId() ?></td>
105 |         </tr>
106 |         <tr>
107 |             <th>Status</th>
108 |             <td><?= $response->getStatus() ?></td>
109 |         </tr>
110 |         <tr>
111 |             <th>URL</th>
112 |             <td><?= $response->getUrl() ?></td>
113 |         </tr>
114 |         <?php
115 |     }
116 |     elseif ($error) {
117 |         ?>
118 |         <tr>
119 |             <th>Error message</th>
120 |             <td><?= $response->errorMessage ?></td>
121 |         </tr>
122 |         <?php
123 |     }
124 |     ?>
125 | </table>
126 | <h2>
127 |     Raw Input/Output
128 | </h2>
129 | <?= $request, $response ?>
130 | </body>
131 | </html>
132 | 


--------------------------------------------------------------------------------
/examples/webhooks/listWebhooks.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the AuthnetJSON package.
  4 |  *
  5 |  * (c) John Conde <stymiee@gmail.com>
  6 |  *
  7 |  * For the full copyright and license information, please view the LICENSE
  8 |  * file that was distributed with this source code.
  9 |  */
 10 | 
 11 | /*************************************************************************************************
 12 | 
 13 | Use the Webhooks API to list all of my webhooks
 14 | 
 15 | SAMPLE REQUEST
 16 | --------------------------------------------------------------------------------------------------
 17 | 
 18 | GET https://apitest.authorize.net/rest/v1/webhooks
 19 | 
 20 | 
 21 | SAMPLE RESPONSE
 22 | --------------------------------------------------------------------------------------------------
 23 | 
 24 | [{
 25 |         "_links": {
 26 |             "self": {
 27 |                 "href": "/rest/v1/webhooks/72a55c78-66e6-4b1e-a4d6-3f925c00561f"
 28 |             }
 29 |         },
 30 |         "webhookId": "72a55c78-66e6-4b1e-a4d6-3f925c00561f",
 31 |         "eventTypes": [
 32 |             "net.authorize.payment.authcapture.created",
 33 |             "net.authorize.customer.created",
 34 |             "net.authorize.customer.paymentProfile.created",
 35 |             "net.authorize.customer.subscription.expiring"
 36 |         ],
 37 |         "status": "active",
 38 |         "url": "http://localhost:55950/api/webhooks"
 39 |     }, {
 40 |         "_links": {
 41 |             "self": {
 42 |                 "href": "/rest/v1/webhooks/7be120d3-2247-4706-b9b1-98931fdfdcce"
 43 |             }
 44 |         },
 45 |         "webhookId": "7be120d3-2247-4706-b9b1-98931fdfdcce",
 46 |         "eventTypes": [
 47 |             "net.authorize.customer.subscription.expiring",
 48 |             "net.authorize.customer.paymentProfile.created",
 49 |             "net.authorize.payment.authcapture.created",
 50 |             "net.authorize.customer.created"
 51 |         ],
 52 |         "status": "inactive",
 53 |         "url": "http://localhost:55950/api/webhooks"
 54 |     }, {
 55 |         "_links": {
 56 |             "self": {
 57 |                 "href": "/rest/v1/webhooks/62c68677-0d71-43a7-977a-f4dea3827fac"
 58 |             }
 59 |         },
 60 |         "webhookId": "62c68677-0d71-43a7-977a-f4dea3827fac",
 61 |         "eventTypes": [
 62 |             "net.authorize.customer.subscription.expiring",
 63 |             "net.authorize.customer.created",
 64 |             "net.authorize.customer.paymentProfile.created",
 65 |             "net.authorize.payment.authcapture.created"
 66 |         ],
 67 |         "status": "active",
 68 |         "url": "http://localhost:55950/api/webhooks"
 69 | }]
 70 | 
 71 | 
 72 |  *************************************************************************************************/
 73 | 
 74 | namespace Authnetjson;
 75 | 
 76 | use Exception;
 77 | 
 78 | require '../../config.inc.php';
 79 | 
 80 | try {
 81 |     $request = AuthnetApiFactory::getWebhooksHandler(
 82 |         AUTHNET_LOGIN,
 83 |         AUTHNET_TRANSKEY,
 84 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 85 |     );
 86 |     $response   = $request->getWebhooks();
 87 |     $successful = true;
 88 |     $error      = false;
 89 | } catch (Exception $e) {
 90 |     echo $e;
 91 |     exit;
 92 | }
 93 | 
 94 | ?>
 95 | <!DOCTYPE html>
 96 | <html lang="en">
 97 | <head>
 98 |     <title>Webhooks :: List Webhooks</title>
 99 |     <style>
100 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
101 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
102 |         pre { white-space: pre-wrap; }
103 |         table th { background: #e5e5e5; color: #666666; }
104 |         h1, h2 { text-align: center; }
105 |     </style>
106 | </head>
107 | <body>
108 | <h1>
109 |     Webhooks :: List Webhooks
110 | </h1>
111 | <h2>
112 |     Results
113 | </h2>
114 | <table>
115 |     <tr>
116 |         <th>Successful</th>
117 |         <td><?= ($successful) ? 'Yes' : 'No' ?></td>
118 |     </tr>
119 |     <?php
120 |     if ($successful) {
121 |         foreach ($response->getWebhooks() as $webhook) {
122 |             ?>
123 |             <tr>
124 |                 <td colspan="2">
125 |                     <hr>
126 |                 </td>
127 |             </tr>
128 |             <tr>
129 |                 <th>Event Types</th>
130 |                 <td>
131 |                     <?php
132 |                     foreach ($webhook->getEventTypes() as $eventType) {
133 |                         echo $eventType, "<br>\n";
134 |                     }
135 |                     ?>
136 |                 </td>
137 |             </tr>
138 |             <tr>
139 |                 <th>Webhook ID</th>
140 |                 <td><?= $webhook->getWebhooksId() ?></td>
141 |             </tr>
142 |             <tr>
143 |                 <th>Status</th>
144 |                 <td><?= $webhook->getStatus() ?></td>
145 |             </tr>
146 |             <tr>
147 |                 <th>URL</th>
148 |                 <td><?= $webhook->getUrl() ?></td>
149 |             </tr>
150 |             <?php
151 |         }
152 |     } elseif ($error) {
153 |         ?>
154 |         <tr>
155 |             <th>Error message</th>
156 |             <td><?= $response->errorMessage ?></td>
157 |         </tr>
158 |         <?php
159 |     }
160 |     ?>
161 | </table>
162 | <h2>
163 |     Raw Input/Output
164 | </h2>
165 | <?= $request, $response ?>
166 | </body>
167 | </html>
168 | 


--------------------------------------------------------------------------------
/examples/webhooks/notificationHistory.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the AuthnetJSON package.
  4 |  *
  5 |  * (c) John Conde <stymiee@gmail.com>
  6 |  *
  7 |  * For the full copyright and license information, please view the LICENSE
  8 |  * file that was distributed with this source code.
  9 |  */
 10 | 
 11 | /*************************************************************************************************
 12 | 
 13 | Use the Webhooks API to
 14 | 
 15 | SAMPLE REQUEST
 16 | --------------------------------------------------------------------------------------------------
 17 | 
 18 | GET https://apitest.authorize.net/rest/v1/notifications?offset=0&limit=1000
 19 | 
 20 | 
 21 | SAMPLE RESPONSE
 22 | --------------------------------------------------------------------------------------------------
 23 | 
 24 | {
 25 |     "_links": {
 26 |         "self": {
 27 |             "href": "/rest/v1/notifications?offset=0&limit=100"
 28 |         }
 29 |     },
 30 |     "notifications": [
 31 |     {
 32 |         "_links": {
 33 |             "self": {
 34 |                 "href": "/rest/v1/notifications/e35d5ede-27c5-46cc-aabb-131f10154ed3"
 35 |             }
 36 |         },
 37 |         "notificationId": "e35d5ede-27c5-46cc-aabb-131f10154ed3",
 38 |         "deliveryStatus": "Delivered",
 39 |         "eventType": "net.authorize.payment.authcapture.created",
 40 |         "eventDate": "2017-02-09T19:18:42.167"
 41 |         }
 42 |     ]
 43 | }
 44 | 
 45 | 
 46 |  *************************************************************************************************/
 47 | 
 48 | namespace Authnetjson;
 49 | 
 50 | use Exception;
 51 | 
 52 | require '../../config.inc.php';
 53 | 
 54 | try {
 55 |     $request = AuthnetApiFactory::getWebhooksHandler(
 56 |         AUTHNET_LOGIN,
 57 |         AUTHNET_TRANSKEY,
 58 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 59 |     );
 60 |     $response   = $request->getNotificationHistory();
 61 |     $successful = true;
 62 |     $error      = false;
 63 | } catch (Exception $e) {
 64 |     echo $e;
 65 |     exit;
 66 | }
 67 | 
 68 | ?>
 69 | <!DOCTYPE html>
 70 | <html lang="en">
 71 | <head>
 72 |     <title>Webhooks :: Notification History</title>
 73 |     <style>
 74 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 75 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 76 |         pre { white-space: pre-wrap; }
 77 |         table th { background: #e5e5e5; color: #666666; }
 78 |         h1, h2 { text-align: center; }
 79 |     </style>
 80 | </head>
 81 | <body>
 82 | <h1>
 83 |     Webhooks :: Notification History
 84 | </h1>
 85 | <h2>
 86 |     Results
 87 | </h2>
 88 | <table>
 89 |     <tr>
 90 |         <th>Successful</th>
 91 |         <td><?= ($successful) ? 'Yes' : 'No';?></td>
 92 |     </tr>
 93 |     <?php
 94 |     if ($successful) {
 95 |         foreach($response->getNotificationHistory() as $notification) {
 96 |             ?>
 97 |             <tr>
 98 |                 <td colspan="2">
 99 |                     <hr>
100 |                 </td>
101 |             </tr>
102 |             <tr>
103 |                 <th>Notification ID</th>
104 |                 <td><?= $notification->getNotificationId() ?></td>
105 |             </tr>
106 |             <tr>
107 |                 <th>Delivery Status</th>
108 |                 <td><?= $notification->getDeliveryStatus() ?></td>
109 |             </tr>
110 |             <tr>
111 |                 <th>Event Type</th>
112 |                 <td><?= $notification->getEventType() ?></td>
113 |             </tr>
114 |             <tr>
115 |                 <th>Event Date</th>
116 |                 <td><?= $notification->getEventDate() ?></td>
117 |             </tr>
118 |             <?php
119 |         }
120 |     }
121 |     elseif ($error) {
122 |         ?>
123 |         <tr>
124 |             <th>Error message</th>
125 |             <td><?= $response->errorMessage ?></td>
126 |         </tr>
127 |         <?php
128 |     }
129 |     ?>
130 | </table>
131 | <h2>
132 |     Raw Input/Output
133 | </h2>
134 | <?= $request, $response ?>
135 | </body>
136 | </html>
137 | 


--------------------------------------------------------------------------------
/examples/webhooks/ping.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * This file is part of the AuthnetJSON package.
 4 |  *
 5 |  * (c) John Conde <stymiee@gmail.com>
 6 |  *
 7 |  * For the full copyright and license information, please view the LICENSE
 8 |  * file that was distributed with this source code.
 9 |  */
10 | 
11 | /*************************************************************************************************
12 | 
13 | Use the Webhooks API to send a test webhook.
14 | 
15 | When a webhook is inactive, you can send a test event to the Webhooks endpoint using this method:
16 | 
17 | POST https://apitest.authorize.net/rest/v1/webhooks/72a55c78-66e6-4b1e-a4d6-3f925c00561f/pings
18 | 
19 | The POST request message body should be empty. Construct the request URL containing the webhook ID that you want to
20 | test. Then, make an HTTP POST request to that URL. Authorize.Net receives the request and sends a notification to
21 | the registered URL for that webhook, emulating the event for that webhook.
22 | 
23 | Note: This request works only on webhooks that are inactive. To test an active webhook, you must first set the webhook
24 | status to inactive.
25 | 
26 | SAMPLE REQUEST
27 | --------------------------------------------------------------------------------------------------
28 | 
29 | POST https://apitest.authorize.net/rest/v1/webhooks/ba4c73f3-0808-48bf-ae2f-f49064770e60/pings
30 | 
31 | 
32 | SAMPLE RESPONSE
33 | --------------------------------------------------------------------------------------------------
34 | 
35 | HTTP 200 response for success
36 | HTTP 500 response for connection error
37 | 
38 | *************************************************************************************************/
39 | 
40 | namespace Authnetjson;
41 | 
42 | use Exception;
43 | 
44 | require '../../config.inc.php';
45 | 
46 | try {
47 |     $request = AuthnetApiFactory::getWebhooksHandler(
48 |         AUTHNET_LOGIN,
49 |         AUTHNET_TRANSKEY,
50 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
51 |     );
52 |     $request->testWebhook('ba4c73f3-0808-48bf-ae2f-f49064770e60');
53 | } catch (Exception $e) {
54 |     echo $e;
55 |     exit;
56 | }
57 | ?>
58 | <!DOCTYPE html>
59 | <html lang="en">
60 | <head>
61 |     <title>Webhooks :: Create Webhooks</title>
62 |     <style>
63 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
64 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
65 |         pre { white-space: pre-wrap; }
66 |         table th { background: #e5e5e5; color: #666666; }
67 |         h1, h2 { text-align: center; }
68 |     </style>
69 | </head>
70 | <body>
71 | <h1>
72 |     Webhooks :: Ping
73 | </h1>
74 | <h2>
75 |     Raw Input/Output
76 | </h2>
77 | <?= $request ?>
78 | </body>
79 | </html>
80 | 


--------------------------------------------------------------------------------
/examples/webhooks/updateWebhook.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /*
  3 |  * This file is part of the AuthnetJSON package.
  4 |  *
  5 |  * (c) John Conde <stymiee@gmail.com>
  6 |  *
  7 |  * For the full copyright and license information, please view the LICENSE
  8 |  * file that was distributed with this source code.
  9 |  */
 10 | 
 11 | /*************************************************************************************************
 12 | 
 13 | Use the Webhooks API to update a webhook
 14 | 
 15 | SAMPLE REQUEST
 16 | --------------------------------------------------------------------------------------------------
 17 | 
 18 | PUT https://apitest.authorize.net/rest/v1/webhooks/72a55c78-66e6-4b1e-a4d6-3f925c00561f
 19 | 
 20 | {
 21 |     "url": "http://requestb.in/19okx6x1",
 22 |     "eventTypes": [
 23 |         "net.authorize.payment.authorization.created"
 24 |     ],
 25 |     "status": "active"
 26 | }
 27 | 
 28 | 
 29 | SAMPLE RESPONSE
 30 | --------------------------------------------------------------------------------------------------
 31 | 
 32 | {
 33 |     "_links": {
 34 |         "self": {
 35 |             "href": "/rest/v1/webhooks/72a55c78-66e6-4b1e-a4d6-3f925c00561f"
 36 |         }
 37 |     },
 38 |     "webhookId": "72a55c78-66e6-4b1e-a4d6-3f925c00561f",
 39 |     "eventTypes": [
 40 |         "net.authorize.payment.authcapture.created"
 41 |     ],
 42 |     "status": "active",
 43 |     "url": "http://requestb.in/19okx6x1"
 44 | }
 45 | 
 46 | 
 47 |  *************************************************************************************************/
 48 | 
 49 | namespace Authnetjson;
 50 | 
 51 | use Exception;
 52 | 
 53 | require '../../config.inc.php';
 54 | 
 55 | try {
 56 |     $request = AuthnetApiFactory::getWebhooksHandler(
 57 |         AUTHNET_LOGIN,
 58 |         AUTHNET_TRANSKEY,
 59 |         AuthnetApiFactory::USE_DEVELOPMENT_SERVER
 60 |     );
 61 |     $response = $request->updateWebhook('ba4c73f3-0808-48bf-ae2f-f49064770e60', 'http://requestb.in/', [
 62 |         'net.authorize.customer.created',
 63 |         'net.authorize.customer.deleted',
 64 |         'net.authorize.customer.updated',
 65 |         'net.authorize.customer.paymentProfile.created',
 66 |         'net.authorize.customer.paymentProfile.deleted',
 67 |         'net.authorize.customer.paymentProfile.updated',
 68 |         'net.authorize.customer.subscription.cancelled',
 69 |         'net.authorize.customer.subscription.created',
 70 |         'net.authorize.customer.subscription.expiring',
 71 |         'net.authorize.customer.subscription.suspended',
 72 |         'net.authorize.customer.subscription.terminated',
 73 |         'net.authorize.customer.subscription.updated',
 74 |         'net.authorize.payment.authcapture.created',
 75 |         'net.authorize.payment.authorization.created',
 76 |         'net.authorize.payment.capture.created',
 77 |         'net.authorize.payment.fraud.approved',
 78 |         'net.authorize.payment.fraud.declined',
 79 |         'net.authorize.payment.fraud.held',
 80 |         'net.authorize.payment.priorAuthCapture.created',
 81 |         'net.authorize.payment.refund.created',
 82 |         'net.authorize.payment.void.created'
 83 |     ], 'active');
 84 |     $successful = true;
 85 |     $error      = false;
 86 | } catch (Exception $e) {
 87 |     echo $e;
 88 |     exit;
 89 | }
 90 | 
 91 | ?>
 92 | <!DOCTYPE html>
 93 | <html lang="en">
 94 | <head>
 95 |     <title>Webhooks :: Update Webhooks</title>
 96 |     <style>
 97 |         table { border: 1px solid #cccccc; margin: auto; border-collapse: collapse; max-width: 90%; }
 98 |         table td { padding: 3px 5px; vertical-align: top; border-top: 1px solid #cccccc; }
 99 |         pre { white-space: pre-wrap; }
100 |         table th { background: #e5e5e5; color: #666666; }
101 |         h1, h2 { text-align: center; }
102 |     </style>
103 | </head>
104 | <body>
105 | <h1>
106 |     Webhooks :: Update Webhooks
107 | </h1>
108 | <h2>
109 |     Results
110 | </h2>
111 | <table>
112 |     <tr>
113 |         <th>Successful</th>
114 |         <td><?= ($successful) ? 'Yes' : 'No';?></td>
115 |     </tr>
116 |     <?php
117 |     if ($successful) {
118 |         ?>
119 |         <tr>
120 |             <th>Event Types</th>
121 |             <td>
122 |                 <?php
123 |                 foreach ($response->getEventTypes() as $eventType) {
124 |                     echo $eventType, "<br>\n";
125 |                 }
126 |                 ?>
127 |             </td>
128 |         </tr>
129 |         <tr>
130 |             <th>Webhook ID</th>
131 |             <td><?= $response->getWebhooksId() ?></td>
132 |         </tr>
133 |         <tr>
134 |             <th>Status</th>
135 |             <td><?= $response->getStatus() ?></td>
136 |         </tr>
137 |         <tr>
138 |             <th>URL</th>
139 |             <td><?= $response->getUrl() ?></td>
140 |         </tr>
141 |         <?php
142 |     }
143 |     elseif ($error) {
144 |         ?>
145 |         <tr>
146 |             <th>Error message</th>
147 |             <td><?= $errorMessage ?></td>
148 |         </tr>
149 |         <?php
150 |     }
151 |     ?>
152 | </table>
153 | <h2>
154 |     Raw Input/Output
155 | </h2>
156 | <?= $request, $response ?>
157 | </body>
158 | </html>
159 | 


--------------------------------------------------------------------------------
/phpdoc.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8" ?>
 2 | <phpdoc>
 3 |     <parser>
 4 |         <target>build/docs</target>
 5 |     </parser>
 6 |     <transformer>
 7 |         <target>build/docs</target>
 8 |     </transformer>
 9 |     <files>
10 |         <directory>src</directory>
11 |         <ignore>tests/*</ignore>
12 |     </files>
13 | </phpdoc>


--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <phpunit
 3 |     backupGlobals="false"
 4 |     backupStaticAttributes="false"
 5 |     colors="true"
 6 |     convertErrorsToExceptions="true"
 7 |     convertNoticesToExceptions="true"
 8 |     convertWarningsToExceptions="true"
 9 |     processIsolation="false"
10 |     stopOnFailure="false"
11 | >
12 |     <logging>
13 |         <log type="coverage-html" target="./build/coverage/" lowUpperBound="35" highLowerBound="70"/>
14 |     </logging>
15 |     <testsuites>
16 |         <testsuite name="AuthnetJSON">
17 |             <directory>./tests/</directory>
18 |         </testsuite>
19 |     </testsuites>
20 |     <filter>
21 |         <whitelist>
22 |             <directory suffix=".php">./src</directory>
23 |             <exclude>
24 |                 <directory>vendor</directory>
25 |             </exclude>
26 |         </whitelist>
27 |     </filter>
28 | </phpunit>


--------------------------------------------------------------------------------
/src/Authnetjson/AuthnetAcceptJs.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of the AuthnetJSON package.
 7 |  *
 8 |  * (c) John Conde <stymiee@gmail.com>
 9 |  *
10 |  * For the full copyright and license information, please view the LICENSE
11 |  * file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Authnetjson;
15 | 
16 | /**
17 |  * Contains constant values.
18 |  *
19 |  * @package   AuthnetJSON
20 |  * @author    John Conde <stymiee@gmail.com>
21 |  * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
22 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
23 |  * @link      https://github.com/stymiee/authnetjson
24 |  * @see       https://developer.authorize.net/api/reference/
25 |  */
26 | class AuthnetAcceptJs
27 | {
28 |     /**
29 |      * @var string URL for Accept hosted form in the production environment
30 |      */
31 |     public const PRODUCTION_HOSTED_PAYMENT_URL = 'https://accept.authorize.net/payment/payment';
32 | 
33 |     /**
34 |      * @var string URL for Accept hosted form in the sandbox environment
35 |      */
36 |     public const SANDBOX_HOSTED_PAYMENT_URL = 'https://test.authorize.net/payment/payment';
37 | 
38 |     /**
39 |      * @var string URL for Accept hosted form in the production environment
40 |      */
41 |     public const PRODUCTION_HOSTED_CIM_URL = 'https://accept.authorize.net/profile/manage';
42 | 
43 |     /**
44 |      * @var string URL for Accept hosted form in the sandbox environment
45 |      */
46 |     public const SANDBOX_HOSTED_CIM_URL = 'https://test.authorize.net/profile/manage';
47 | }
48 | 


--------------------------------------------------------------------------------
/src/Authnetjson/AuthnetJson.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of the AuthnetJSON package.
 7 |  *
 8 |  * (c) John Conde <stymiee@gmail.com>
 9 |  *
10 |  * For the full copyright and license information, please view the LICENSE
11 |  * file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Authnetjson;
15 | 
16 | /**
17 |  * Contains constant values.
18 |  *
19 |  * @package   AuthnetJSON
20 |  * @author    John Conde <stymiee@gmail.com>
21 |  * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
22 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
23 |  * @link      https://github.com/stymiee/authnetjson
24 |  * @see       https://developer.authorize.net/api/reference/
25 |  */
26 | class AuthnetJson
27 | {
28 |     /**
29 |      * @var int Subscription of endless length.
30 |      */
31 |     public const BOUNDLESS_OCCURRENCES = 9999;
32 | }
33 | 


--------------------------------------------------------------------------------
/src/Authnetjson/AuthnetSim.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | /**
  6 |  * This file is part of the AuthnetJSON package.
  7 |  *
  8 |  * (c) John Conde <stymiee@gmail.com>
  9 |  *
 10 |  * For the full copyright and license information, please view the LICENSE
 11 |  * file that was distributed with this source code.
 12 |  */
 13 | 
 14 | namespace Authnetjson;
 15 | 
 16 | use Authnetjson\Exception\AuthnetInvalidAmountException;
 17 | use Exception;
 18 | 
 19 | /**
 20 |  * Wrapper to simplify the creation of SIM data
 21 |  *
 22 |  * @author    John Conde <stymiee@gmail.com>
 23 |  * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
 24 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
 25 |  * @link      https://github.com/stymiee/authnetjson
 26 |  */
 27 | class AuthnetSim
 28 | {
 29 |     /**
 30 |      * @var string  Authorize.Net API login ID
 31 |      */
 32 |     private $login;
 33 | 
 34 |     /**
 35 |      * @var string  Authorize.Net API signature key
 36 |      */
 37 |     private $signature;
 38 | 
 39 |     /**
 40 |      * @var string  URL endpoint for processing a transaction
 41 |      */
 42 |     private $url;
 43 | 
 44 |     /**
 45 |      * @var int  Randomly generated number
 46 |      */
 47 |     private $sequence;
 48 | 
 49 |     /**
 50 |      * @var int  Unix timestamp the request was made
 51 |      */
 52 |     private $timestamp;
 53 | 
 54 |     /**
 55 |      * Creates a SIM wrapper by setting the Authorize.Net credentials and URL of the endpoint to be used
 56 |      * for the API call
 57 |      *
 58 |      * @param string $login Authorize.Net API login ID
 59 |      * @param string $signature Authorize.Net API Transaction Key
 60 |      * @param string $api_url URL endpoint for processing a transaction
 61 |      * @throws Exception
 62 |      */
 63 |     public function __construct(string $login, string $signature, string $api_url)
 64 |     {
 65 |         $this->login = $login;
 66 |         $this->signature = $signature;
 67 |         $this->url = $api_url;
 68 |         $this->resetParameters();
 69 |     }
 70 | 
 71 |     /**
 72 |      * Returns the hash for the SIM transaction
 73 |      *
 74 |      * @param float $amount The amount of the transaction
 75 |      * @return string           Hash of five different unique transaction parameters
 76 |      * @throws AuthnetInvalidAmountException
 77 |      */
 78 |     public function getFingerprint(float $amount): string
 79 |     {
 80 |         if (!filter_var($amount, FILTER_VALIDATE_FLOAT, FILTER_FLAG_ALLOW_THOUSAND)) {
 81 |             throw new AuthnetInvalidAmountException('You must enter a valid amount greater than zero.');
 82 |         }
 83 | 
 84 |         return strtoupper(
 85 |             hash_hmac(
 86 |                 'sha512',
 87 |                 sprintf(
 88 |                     '%s^%s^%s^%s^',
 89 |                     $this->login,
 90 |                     $this->sequence,
 91 |                     $this->timestamp,
 92 |                     $amount
 93 |                 ),
 94 |                 hex2bin($this->signature)
 95 |             )
 96 |         );
 97 |     }
 98 | 
 99 |     /**
100 |      * Returns the sequence generated for a transaction
101 |      *
102 |      * @return int Current sequence
103 |      */
104 |     public function getSequence(): int
105 |     {
106 |         return $this->sequence;
107 |     }
108 | 
109 |     /**
110 |      * Returns the timestamp for a transaction
111 |      *
112 |      * @return int Current timestamp
113 |      */
114 |     public function getTimestamp(): int
115 |     {
116 |         return $this->timestamp;
117 |     }
118 | 
119 |     /**
120 |      * Returns the account login ID
121 |      *
122 |      * @return string           API login ID
123 |      */
124 |     public function getLogin(): string
125 |     {
126 |         return $this->login;
127 |     }
128 | 
129 |     /**
130 |      * Returns the url endpoint for the transaction
131 |      *
132 |      * @return string           url endpoint
133 |      */
134 |     public function getEndpoint(): string
135 |     {
136 |         return $this->url;
137 |     }
138 | 
139 |     /**
140 |      * Resets the sequence and timestamp
141 |      *
142 |      * @throws Exception
143 |      */
144 |     public function resetParameters(): void
145 |     {
146 |         $this->sequence = random_int(1, 1000);
147 |         $this->timestamp = time();
148 |     }
149 | }
150 | 


--------------------------------------------------------------------------------
/src/Authnetjson/AuthnetWebhook.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | /**
  6 |  * This file is part of the AuthnetJSON package.
  7 |  *
  8 |  * (c) John Conde <stymiee@gmail.com>
  9 |  *
 10 |  * For the full copyright and license information, please view the LICENSE
 11 |  * file that was distributed with this source code.
 12 |  */
 13 | 
 14 | namespace Authnetjson;
 15 | 
 16 | use Authnetjson\Exception\AuthnetInvalidCredentialsException;
 17 | use Authnetjson\Exception\AuthnetInvalidJsonException;
 18 | 
 19 | /**
 20 |  * Handles a Webhook notification from the Authorize.Net Webhooks API
 21 |  *
 22 |  * @package   AuthnetJSON
 23 |  * @author    John Conde <stymiee@gmail.com>
 24 |  * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
 25 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
 26 |  * @link      https://github.com/stymiee/authnetjson
 27 |  * @see       https://developer.authorize.net/api/reference/
 28 |  */
 29 | class AuthnetWebhook
 30 | {
 31 |     /**
 32 |      * @var object  SimpleXML object representing the Webhook notification
 33 |      */
 34 |     private $webhook;
 35 | 
 36 |     /**
 37 |      * @var string  JSON string that is the Webhook notification sent by Authorize.Net
 38 |      */
 39 |     private $webhookJson;
 40 | 
 41 |     /**
 42 |      * @var array  HTTP headers sent with the notification
 43 |      */
 44 |     private $headers;
 45 | 
 46 |     /**
 47 |      * @var string  Authorize.Net Signature Key
 48 |      */
 49 |     private $signature;
 50 | 
 51 |     /**
 52 |      * Creates the response object with the response json returned from the API call
 53 |      *
 54 |      * @param string $signature Authorize.Net Signature Key
 55 |      * @param string $payload Webhook Notification sent by Authorize.Net
 56 |      * @param array $headers HTTP headers sent with Webhook. Optional if PHP is run as an Apache module
 57 |      * @throws AuthnetInvalidCredentialsException
 58 |      * @throws AuthnetInvalidJsonException
 59 |      */
 60 |     public function __construct(string $signature, string $payload, array $headers = [])
 61 |     {
 62 |         $this->signature = $signature;
 63 |         $this->webhookJson = $payload;
 64 |         $this->headers = $headers;
 65 |         if (empty($this->headers)) {
 66 |             $this->headers = $this->getAllHeaders();
 67 |         }
 68 |         if (empty($this->signature)) {
 69 |             throw new AuthnetInvalidCredentialsException('You have not configured your signature properly.');
 70 |         }
 71 |         if (($this->webhook = json_decode($this->webhookJson, false)) === null) {
 72 |             throw new AuthnetInvalidJsonException('Invalid JSON sent in the Webhook notification');
 73 |         }
 74 |         $this->headers = array_change_key_case($this->headers, CASE_UPPER);
 75 |     }
 76 | 
 77 |     /**
 78 |      * Outputs the response JSON in a human-readable format
 79 |      *
 80 |      * @return string  HTML table containing debugging information
 81 |      */
 82 |     public function __toString()
 83 |     {
 84 |         $output = '<table id="authnet-webhook">' . "\n";
 85 |         $output .= '<caption>Authorize.Net Webhook</caption>' . "\n";
 86 |         $output .= '<tr><th colspan="2"><b>Response HTTP Headers</b></th></tr>' . "\n";
 87 |         $output .= '<tr><td colspan="2"><pre>' . "\n";
 88 |         $output .= var_export($this->headers, true) . "\n";
 89 |         $output .= '</pre></td></tr>' . "\n";
 90 |         $output .= '<tr><th colspan="2"><b>Response JSON</b></th></tr>' . "\n";
 91 |         $output .= '<tr><td colspan="2"><pre>' . "\n";
 92 |         $output .= $this->webhookJson . "\n";
 93 |         $output .= '</pre></td></tr>' . "\n";
 94 |         $output .= '</table>';
 95 | 
 96 |         return $output;
 97 |     }
 98 | 
 99 |     /**
100 |      * Gets a response variable from the Webhook notification
101 |      *
102 |      * @param string $var
103 |      * @return string          requested variable from the API call response
104 |      */
105 |     public function __get(string $var)
106 |     {
107 |         return $this->webhook->{$var};
108 |     }
109 | 
110 |     /**
111 |      * Validates a webhook signature to determine if the webhook is valid
112 |      *
113 |      * @return bool
114 |      */
115 |     public function isValid(): bool
116 |     {
117 |         $hashedBody = strtoupper(hash_hmac('sha512', $this->webhookJson, $this->signature));
118 |         return (isset($this->headers['X-ANET-SIGNATURE']) &&
119 |             strtoupper(explode('=', $this->headers['X-ANET-SIGNATURE'])[1]) === $hashedBody);
120 |     }
121 | 
122 |     /**
123 |      * Validates a webhook signature to determine if the webhook is valid
124 |      *
125 |      * @return string|null
126 |      */
127 |     public function getRequestId(): ?string
128 |     {
129 |         return $this->headers['X-REQUEST-ID'] ?? null;
130 |     }
131 | 
132 |     /**
133 |      * Retrieves all HTTP headers of a given request
134 |      *
135 |      * @return array
136 |      */
137 |     protected function getAllHeaders(): array
138 |     {
139 |         if (function_exists('apache_request_headers')) {
140 |             $headers = apache_request_headers();
141 |         } else {
142 |             $headers = [];
143 |             foreach ($_SERVER as $key => $value) {
144 |                 if (strpos($key, 'HTTP_') === 0) {
145 |                     $headers[str_replace('_', '-', substr($key, 5))] = $value;
146 |                 }
147 |             }
148 |         }
149 |         return $headers ?: [];
150 |     }
151 | }
152 | 


--------------------------------------------------------------------------------
/src/Authnetjson/Exception/AuthnetCannotSetParamsException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of the AuthnetJSON package.
 7 |  *
 8 |  * (c) John Conde <stymiee@gmail.com>
 9 |  *
10 |  * For the full copyright and license information, please view the LICENSE
11 |  * file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Authnetjson\Exception;
15 | 
16 | /**
17 |  * Exception that is throw when client code attempts to set a parameter directly (i.e. using __set())
18 |  *
19 |  * echo $response->isError()    AuthnetJSON
20 |  *
21 |  * @author    John Conde <stymiee@gmail.com>
22 |  * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
23 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
24 |  * @link      https://github.com/stymiee/authnetjson
25 |  */
26 | class AuthnetCannotSetParamsException extends AuthnetException
27 | {
28 | 
29 | }
30 | 


--------------------------------------------------------------------------------
/src/Authnetjson/Exception/AuthnetCurlException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of the AuthnetJSON package.
 7 |  *
 8 |  * (c) John Conde <stymiee@gmail.com>
 9 |  *
10 |  * For the full copyright and license information, please view the LICENSE
11 |  * file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Authnetjson\Exception;
15 | 
16 | /**
17 |  * Exception that is throw when cURL experiences an unexpected error
18 |  *
19 |  * @author    John Conde <authnet@johnconde.net>
20 |  * @copyright John Conde <authnet@johnconde.net>
21 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
22 |  * @link      https://github.com/stymiee/authnetjson
23 |  */
24 | class AuthnetCurlException extends AuthnetException
25 | {
26 | 
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Authnetjson/Exception/AuthnetException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of the AuthnetJSON package.
 7 |  *
 8 |  * (c) John Conde <stymiee@gmail.com>
 9 |  *
10 |  * For the full copyright and license information, please view the LICENSE
11 |  * file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Authnetjson\Exception;
15 | 
16 | use Exception;
17 | use Throwable;
18 | 
19 | /**
20 |  * Generic Exception that may be thrown whenever an unexpect error occurs using the AuthnetJson class
21 |  *
22 |  * @author    John Conde <stymiee@gmail.com>
23 |  * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
24 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
25 |  * @link      https://github.com/stymiee/authnetjson
26 |  */
27 | class AuthnetException extends Exception
28 | {
29 |     public function __construct(string $message = '', int $code = 0, Throwable $previous = null)
30 |     {
31 |         parent::__construct($message, $code, $previous);
32 |     }
33 | }
34 | 


--------------------------------------------------------------------------------
/src/Authnetjson/Exception/AuthnetInvalidAmountException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of the AuthnetJSON package.
 7 |  *
 8 |  * (c) John Conde <stymiee@gmail.com>
 9 |  *
10 |  * For the full copyright and license information, please view the LICENSE
11 |  * file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Authnetjson\Exception;
15 | 
16 | /**
17 |  * Exception that is thrown when invalid amount to pay is provided for a SIM transaction
18 |  *
19 |  * @author    John Conde <stymiee@gmail.com>
20 |  * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
21 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
22 |  * @link      https://github.com/stymiee/authnetjson
23 |  */
24 | class AuthnetInvalidAmountException extends AuthnetException
25 | {
26 | 
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Authnetjson/Exception/AuthnetInvalidCredentialsException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of the AuthnetJSON package.
 7 |  *
 8 |  * (c) John Conde <stymiee@gmail.com>
 9 |  *
10 |  * For the full copyright and license information, please view the LICENSE
11 |  * file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Authnetjson\Exception;
15 | 
16 | /**
17 |  * Exception that is throw when invalid Authorize.Net API credentials are provided
18 |  *
19 |  * @author    John Conde <stymiee@gmail.com>
20 |  * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
21 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
22 |  * @link      https://github.com/stymiee/authnetjson
23 |  */
24 | class AuthnetInvalidCredentialsException extends AuthnetException
25 | {
26 | 
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Authnetjson/Exception/AuthnetInvalidJsonException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of the AuthnetJSON package.
 7 |  *
 8 |  * (c) John Conde <stymiee@gmail.com>
 9 |  *
10 |  * For the full copyright and license information, please view the LICENSE
11 |  * file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Authnetjson\Exception;
15 | 
16 | /**
17 |  * Exception that is throw when invalid JSON is returned by the API
18 |  *
19 |  * @author    John Conde <authnet@johnconde.net>
20 |  * @copyright John Conde <authnet@johnconde.net>
21 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
22 |  * @link      https://github.com/stymiee/authnetjson
23 |  */
24 | class AuthnetInvalidJsonException extends AuthnetException
25 | {
26 | 
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Authnetjson/Exception/AuthnetInvalidServerException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of the AuthnetJSON package.
 7 |  *
 8 |  * (c) John Conde <stymiee@gmail.com>
 9 |  *
10 |  * For the full copyright and license information, please view the LICENSE
11 |  * file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Authnetjson\Exception;
15 | 
16 | /**
17 |  * Exception that is throw when an invalid value is given for the $server parameter when
18 |  * initiating an instance of the AuthnetJson class
19 |  *
20 |  * @author    John Conde <stymiee@gmail.com>
21 |  * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
22 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
23 |  * @link      https://github.com/stymiee/authnetjson
24 |  */
25 | class AuthnetInvalidServerException extends AuthnetException
26 | {
27 | 
28 | }
29 | 


--------------------------------------------------------------------------------
/src/Authnetjson/Exception/AuthnetTransactionResponseCallException.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | declare(strict_types=1);
 4 | 
 5 | /**
 6 |  * This file is part of the AuthnetJSON package.
 7 |  *
 8 |  * (c) John Conde <stymiee@gmail.com>
 9 |  *
10 |  * For the full copyright and license information, please view the LICENSE
11 |  * file that was distributed with this source code.
12 |  */
13 | 
14 | namespace Authnetjson\Exception;
15 | 
16 | /**
17 |  * Exception that is throw when transaction response data is requested on an API call that does not return any
18 |  *
19 |  * @author    John Conde <stymiee@gmail.com>
20 |  * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
21 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
22 |  * @link      https://github.com/stymiee/authnetjson
23 |  */
24 | class AuthnetTransactionResponseCallException extends AuthnetException
25 | {
26 | 
27 | }
28 | 


--------------------------------------------------------------------------------
/src/Authnetjson/TransactionResponse.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | 
  3 | declare(strict_types=1);
  4 | 
  5 | /**
  6 |  * This file is part of the AuthnetJSON package.
  7 |  *
  8 |  * (c) John Conde <stymiee@gmail.com>
  9 |  *
 10 |  * For the full copyright and license information, please view the LICENSE
 11 |  * file that was distributed with this source code.
 12 |  */
 13 | 
 14 | namespace Authnetjson;
 15 | 
 16 | /**
 17 |  * Adapter for the Authorize.Net JSON API
 18 |  *
 19 |  * @package   AuthnetJSON
 20 |  * @author    John Conde <stymiee@gmail.com>
 21 |  * @copyright 2015 - 2023 John Conde <stymiee@gmail.com>
 22 |  * @license   http://www.apache.org/licenses/LICENSE-2.0.html Apache License, Version 2.0
 23 |  * @link      https://github.com/stymiee/authnetjson
 24 |  * @see       https://developer.authorize.net/api/reference/
 25 |  */
 26 | class TransactionResponse
 27 | {
 28 |     /**
 29 |      * @var array Transaction response fields to map to values parsed from a transaction response string
 30 |      */
 31 |     private static $fieldMap = [
 32 |         1  => 'ResponseCode',
 33 |         2  => 'ResponseSubcode',
 34 |         3  => 'ResponseReasonCode',
 35 |         4  => 'ResponseReasonText',
 36 |         5  => 'AuthorizationCode',
 37 |         6  => 'AVSResponse',
 38 |         7  => 'TransactionID',
 39 |         8  => 'InvoiceNumber',
 40 |         9  => 'Description',
 41 |         10 => 'Amount',
 42 |         11 => 'Method',
 43 |         12 => 'TransactionType',
 44 |         13 => 'CustomerID',
 45 |         14 => 'FirstName',
 46 |         15 => 'LastName',
 47 |         16 => 'Company',
 48 |         17 => 'Address',
 49 |         18 => 'City',
 50 |         19 => 'State',
 51 |         20 => 'ZipCode',
 52 |         21 => 'Country',
 53 |         22 => 'Phone',
 54 |         23 => 'Fax',
 55 |         24 => 'EmailAddress',
 56 |         25 => 'ShipToFirstName',
 57 |         26 => 'ShipToLastName',
 58 |         27 => 'ShipToCompany',
 59 |         28 => 'ShipToAddress',
 60 |         29 => 'ShipToCity',
 61 |         30 => 'ShipToState',
 62 |         31 => 'ShipToZip',
 63 |         32 => 'ShipToCountry',
 64 |         33 => 'Tax',
 65 |         34 => 'Duty',
 66 |         35 => 'Freight',
 67 |         36 => 'TaxExempt',
 68 |         37 => 'PurchaseOrderNumber',
 69 |         38 => 'MD5Hash',
 70 |         39 => 'CardCodeResponse',
 71 |         40 => 'CardholderAuthenticationVerificationResponse',
 72 |         51 => 'AccountNumber',
 73 |         52 => 'CardType',
 74 |         53 => 'SplitTenderID',
 75 |         54 => 'AmountRequested',
 76 |         55 => 'BalanceOnCard'
 77 |     ];
 78 | 
 79 |     /**
 80 |      * @var array Transaction response fields to map to values parsed from a transaction response string
 81 |      */
 82 |     private $responseArray;
 83 | 
 84 |     /**
 85 |      * Creates out TransactionResponse object and assigns the response variables to an array
 86 |      *
 87 |      * @param string $response Comma delimited transaction response string
 88 |      */
 89 |     public function __construct(string $response)
 90 |     {
 91 |         $this->responseArray = array_merge([null], explode(',', $response));
 92 |     }
 93 | 
 94 |     /**
 95 |      * Gets the requested value out of the response array using the provided key. The location of that value
 96 |      * can be accessed via its numerical location in the array (starting at zero) or using the key for that field
 97 |      * as defined by Authorize.Net and mapped in self::$fieldMap.
 98 |      *
 99 |      * @param mixed $field Name or key of the transaction field to be retrieved
100 |      * @return string Transaction field to be retrieved
101 |      */
102 |     public function getTransactionResponseField($field): ?string
103 |     {
104 |         $value = null;
105 |         if (is_int($field)) {
106 |             $value = $this->responseArray[$field] ?? $value;
107 |         } elseif ($key = array_search($field, self::$fieldMap, true)) {
108 |             $value = $this->responseArray[$key];
109 |         }
110 |         return $value;
111 |     }
112 | }
113 | 


--------------------------------------------------------------------------------