Skip to content

About

AndDone-SecureAPI-ClientLibrary-PHP

Resources

Readme
MIT license

Code of conduct

Code of conduct

Contributing

Contributing
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository
BranchesTags

Repository files navigation

OpenAPIClient-php

Secure API

Installation & Usage

Requirements

PHP 8.2.35, 8.3.36, 8.4.27, or 8.5.12. Please patch your interpreter to one of these versions for security purposes.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/OpenAPIClient-php/vendor/autoload.php');

Getting Started

  1. Find and note your company AndDone Developer settings
    1. Login to (UAT) https://portal.uat.anddone.com/ (Production) https://portal.anddone.com/
    2. In the left menu, click "Developer" then "API Keys"
    3. Your xApiKey will be the API Key
    4. Your xAppKey will be the App Key
  2. Find your Origin by opening a browser and browse to: https://www.whatsmyip.org/ Your origin will be your IP Address
  3. Create a settings file to contain AndDone specific settings
    1. Rename config.example.json to config.json
    2. Input your API key, App key, and origin into the appropriate key values of config.json

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');

$filePath = './config.json';
$jsonString = file_get_contents($filePath);
$jsonData = json_decode($jsonString, true);
$apiKey = $jsonData['xApiKey'];
$appKey = $jsonData['xAppKey'];
$version = $jsonData['xVersion'];
$origin = $jsonData['origin'];

$json = '{
  "category": "FIRE",
  "newPolicyNumber": "1256",
  "premium": 9000,
  "quoteKey": 22857791
}';

$httpBody = json_decode($json, true);

$requestBody = new pFPolicyUpdateRequestDTO ($httpBody);

try {
    $result = new SecureEmbeddedPremiumFinanceApi()->secureEpfMerchantsQuotesPolicyPut(
      $xApiKey, $xAppKey, $xVersion, $origin, $requestBody);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SecureEmbeddedPremiumFinanceApi->secureEpfMerchantsQuotesPolicyPut: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.uat.anddone.com

Class Method HTTP request Description
SecureEmbeddedPremiumFinanceApi secureEpfMerchantsQuotesPolicyPut PUT /secure/epf/merchants/quotes/policy This API is will update the policy number
SecureEmbeddedPremiumFinanceApi secureEpfQuotesBookingPut PUT /secure/epf/quotes/booking This API will update PFA to book a quote.
SecureEmbeddedPremiumFinanceApi secureEpfQuotesCaptureesignPut PUT /secure/epf/quotes/captureesign This API will eSign the pfa with insured name.
SecureEmbeddedPremiumFinanceApi secureEpfQuotesGeneratePost POST /secure/epf/quotes/generate This API is used to Generate Quotes
SecureEmbeddedPremiumFinanceApi secureEpfQuotesIntentPost POST /secure/epf/quotes/intent This API will return quotes created againsts a payment intent.
SecureEmbeddedPremiumFinanceApi secureEpfQuotesPost POST /secure/epf/quotes This API will return quote by QuoteKey.
SecureEmbeddedPremiumFinanceApi secureEpfRetrievepfaPost POST /secure/epf/retrievepfa This API will return PFA for given quoteKey.
SecureEmbeddedPremiumFinanceEndorsementsApi secureEpfEndorsementsPost POST /secure/epf/endorsements This API will do a check of eligibility of account
SecureEmbeddedPremiumFinanceEndorsementsApi secureEpfQuoteEndorsementBookingPut PUT /secure/epf/quote/endorsement/booking This API will update PFA to book a endorsement quote.
SecureEmbeddedPremiumFinanceEndorsementsApi secureEpfQuoteEndorsementPost POST /secure/epf/quote/endorsement This API will do return a quote for an existing policy or new policy for an existing account
SecureOrumApi secureBankaccountsDetailsPost POST /secure/bankaccounts/details This API will request for verified bank account.
SecureOrumApi secureBankaccountsVerifyPost POST /secure/bankaccounts/verify This API will request for account verification.
SecureOutboundPaymentsApi vendorapiSecureOutboundPaymentsTimelinesPost POST /vendorapi/secure/outboundPayments/timelines This API gets outbound payment timelines
SecureOutboundPaymentsApi vendorapiSecureOutboundpaymentsCancelPost POST /vendorapi/secure/outboundpayments/cancel This API cancel outbound payment request
SecureOutboundPaymentsApi vendorapiSecureOutboundpaymentsDetailPost POST /vendorapi/secure/outboundpayments/detail This API fetch outbound payment by paymentId
SecureOutboundPaymentsApi vendorapiSecureOutboundpaymentsPost POST /vendorapi/secure/outboundpayments This API creates outbound payment request
SecureOutboundPaymentsApi vendorapiSecureOutboundpaymentsSearchPost POST /vendorapi/secure/outboundpayments/search This API gets all outbound payment
SecurePaymentBatchingApi secureBatchesDetailsPost POST /secure/batches/details This API is used for getting Secure Payment Batch Details
SecurePaymentBatchingApi secureBatchesExecutePost POST /secure/batches/execute This API execute on-demand batch transaction.
SecurePaymentBatchingApi secureBatchesPost POST /secure/batches This API is used for getting Secure Payment Batches
SecurePaymentBatchingApi secureBatchesTimelinesPost POST /secure/batches/timelines This API will returns batch timeline.
SecurePaymentBatchingApi secureBatchesTransactionsCancelPost POST /secure/batches/transactions/cancel This API cancels transactions from an active batch.
SecurePaymentIntentApi securePaymentintentsExpirationsPost POST /secure/paymentintents/expirations This API expires the payment Intent or link.
SecurePaymentIntentApi securePaymentintentsPost POST /secure/paymentintents This API is use to create Secure payment Intent.
SecurePaymentLinksApi securePaymentlinksDetailsPost POST /secure/paymentlinks/details This API is used for getting Payment Links by PaymentLink ID
SecurePaymentLinksApi securePaymentlinksExpirationsPost POST /secure/paymentlinks/expirations This API is used for to set expired payment link
SecurePaymentLinksApi securePaymentlinksIdPut PUT /secure/paymentlinks/{id} This API is used to update Payment Links
SecurePaymentLinksApi securePaymentlinksPost POST /secure/paymentlinks This API is used to create Payment Links
SecurePaymentsApi securePaymentsExportPost POST /secure/payments/export This API gets Secure payment by search criteria for the merchant.
SecurePaymentsApi securePaymentsPost POST /secure/payments This API posts new Secure payment request for the merchant.
SecurePaymentsApi securePaymentsSearchPost POST /secure/payments/search This API gets Secure payment by search criteria for the merchant.
SecurePaymentsApi securePaymentsdetailsPost POST /secure/paymentsdetails This API is used for getting details of Payments
SecurePremiumFinanceLiteApi secureEpfliteQuotesGeneratePost POST /secure/epflite/quotes/generate This API is used to generate the quote from the provider.
SecurePremiumFinanceLiteApi secureEpfliteQuotesLinkPost POST /secure/epflite/quotes/link This API will return quotes created againsts a payment link.
SecurePremiumFinanceLiteApi secureEpfliteQuotesPaymentlinksPost POST /secure/epflite/quotes/paymentlinks This API is used to create Payment Links
SecureRefundsApi secureRefundsEligibilityPost POST /secure/refunds/eligibility This API return refund eligibility of a transaction.
SecureRefundsApi secureRefundsPost POST /secure/refunds This API will refund a transaction which has been settled by the processor.
SecureReportsApi secureReportsDownloadsPost POST /secure/reports/downloads This API will add system report.
SecureTokenLinksApi secureTokenlinksDetailsPost POST /secure/tokenlinks/details This API is used for getting Token Links by TokenLink ID
SecureTokenLinksApi secureTokenlinksExpirationsPost POST /secure/tokenlinks/expirations This API expires the token link.
SecureTokenLinksApi secureTokenlinksListPost POST /secure/tokenlinks/list This API is used for getting all Token Links for Merchant
SecureTokenLinksApi secureTokenlinksPost POST /secure/tokenlinks This API is use to create Secure Token Links
SecureTokenLinksApi secureTokenlinksPut PUT /secure/tokenlinks This API will update the expireIn and paymentType of Token Link.
SecureTokenManagementApi secureTokensActivationsDelete DELETE /secure/tokens/activations This API is used for deactivating merchant token securely
SecureTokenManagementApi secureTokensDetailsPost POST /secure/tokens/details This API is used for getting details of Merchant Token by Token link.
SecureVendorManagementApi vendorapiSecureMerchantsVendorsDeletePost POST /vendorapi/secure/merchants/vendors/delete This API deletes vendor into system
SecureVendorManagementApi vendorapiSecureMerchantsVendorsDetailsPost POST /vendorapi/secure/merchants/vendors/details This API gets details of particular vendor
SecureVendorManagementApi vendorapiSecureMerchantsVendorsEditPost POST /vendorapi/secure/merchants/vendors/edit This API Updates the existing vendor
SecureVendorManagementApi vendorapiSecureMerchantsVendorsPost POST /vendorapi/secure/merchants/vendors This API creates vendor into system
SecureVendorManagementApi vendorapiSecureMerchantsVendorsSearchPost POST /vendorapi/secure/merchants/vendors/search This API returns list of all the Vendors of Merchant
SecureVendorManagementApi vendorapiSecureMerchantsVendorsSuspendPost POST /vendorapi/secure/merchants/vendors/suspend This API suspends vendor into system
SecureVendorManagementApi vendorapiSecureMerchantsVendorsTimelinePost POST /vendorapi/secure/merchants/vendors/timeline This API gets timeline of particular vendor
SecureVendorManagementApi vendorapiSecureMerchantsVendorsUnsuspendPost POST /vendorapi/secure/merchants/vendors/unsuspend This API unsuspends vendor into system
SecureVoidsApi secureCancellationsPost POST /secure/cancellations This API cancel a transaction.

Models

Authorization

Authentication schemes defined for the API:

x-api-key

  • Type: API key
  • API key parameter name: x-api-key
  • Location: HTTP header

x-app-key

  • Type: API key
  • API key parameter name: x-app-key
  • Location: HTTP header

x-version

  • Type: API key
  • API key parameter name: x-version
  • Location: HTTP header

origin

  • Type: API key
  • API key parameter name: origin
  • Location: HTTP header

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

About this package

This PHP package is automatically generated by the OpenAPI Generator project:

  • API version: 2.3
    • Generator version: 7.9.0
  • Build package: org.openapitools.codegen.languages.PhpClientCodegen

About

AndDone-SecureAPI-ClientLibrary-PHP

Resources

Readme
MIT license

Code of conduct

Code of conduct

Contributing

Contributing
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

Packages

Used by

Contributors

Languages