README

Embedding payments into your software platform can be one of the most powerful value drivers for your customers and your top line. Imagine your software delivering the entire order-to-cash cycle including funding right into the customer’s bank account. We provide low code integration- With just a single API, you can go live with Exact Payments. Onboard customers, automated underwriting, receive webhook notifications when your customers is live and ready to take payments. We have all the payment types your customers want and their buyers need. Credit and debit cards plus ACH payments, Apple Pay, Google Pay, Paypal, recurring payments, card-on-file and more. Dive into our API Reference and add embedded payments with Exact today!

Installation & Usage

Requirements

PHP 7.4 and later. Should also work with PHP 8.0.

Composer

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

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

Then run composer install

Manual Installation

Download the files and include autoload.php:

<?php
require_once('/path/to/Exact Payments PHP SDK/vendor/autoload.php');

Getting Started

Please follow the installation procedure and then run the following:

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




$apiInstance = new TheLogicStudio\ExactPay\Api\APIHealthCheckApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->apiHealthCheck();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling APIHealthCheckApi->apiHealthCheck: ', $e->getMessage(), PHP_EOL;
}

API Endpoints

All URIs are relative to https://api.exactpaysandbox.com

Class	Method	HTTP request	Description
APIHealthCheckApi	apiHealthCheck	GET /status	Retrieve Status
AccountManagementApi	accountRegisterApplePayDomains	POST /account/{accountId}/apple-pay	Register Domain for Apple Pay
AccountManagementApi	deregisterApplePayDomains	DELETE /account/{accountId}/apple-pay	Deregister Apple Pay Domains
AccountManagementApi	listApplePayDomains	GET /account/{accountId}/apple-pay	List Apple Pay Domains
AccountManagementApi	organizationOrganizationIdAccountAccountIdGet	GET /organization/{organizationId}/account/{accountId}	Retrieve Account by ID
AccountManagementApi	organizationOrganizationIdAccountGet	GET /organization/{organizationId}/account	List Accounts
AccountManagementApi	organizationOrganizationIdAccountSearchGet	GET /organization/{organizationId}/account/search	Query Accounts
AccountManagementApi	putUpdateAccountById	PUT /organization/{organizationId}/account/{accountId}	Update Account
AdminToolsApi	getListNotes	GET /organization/{organizationId}/onboarding/{onboardingId}/note	List Notes
AdminToolsApi	organizationOrganizationIdOnboardingOnboardingIdRecheckPut	PUT /organization/{organizationId}/onboarding/{onboardingId}/recheck	Process Workflow
AdminToolsApi	organizationOrganizationIdOnboardingOnboardingIdRetryRulePut	PUT /organization/{organizationId}/onboarding/{onboardingId}/retry-rule	Process Verification
AdminToolsApi	organizationOrganizationIdOnboardingOnboardingIdStatusPut	PUT /organization/{organizationId}/onboarding/{onboardingId}/status	Update Onboarding Status
AdminToolsApi	postCreateNotes	POST /organization/{organizationId}/onboarding/{onboardingId}/note	Add Note
AuthenticationApi	createApplicationToken	POST /application/{applicationId}/token	Create Application Token
AuthenticationApi	createUserToken	POST /token	Create User Token
AuthenticationApi	deleteApplicationToken	DELETE /application/{applicationId}/token/{tokenId}	Delete Application Token
AuthenticationApi	queryApplicationToken	GET /application/{applicationId}/token	Query Application Tokens
CustomersApi	accountDeleteCustomerCustomerIdPaymentMethodToken	DELETE /account/{accountId}/customer/{customerId}/payment-method/{paymentToken}	Delete Payment Method Associated with Customer by Token (Partner context)
CustomersApi	accountDeleteCustomerId	DELETE /account/{accountId}/customer/{customerId}	Delete Customer by ID (Partner context)
CustomersApi	accountGetCustomer	GET /account/{accountId}/customer	Query Customers (Partner context)
CustomersApi	accountGetCustomerCustomerIdPaymentMethodToken	GET /account/{accountId}/customer/{customerId}/payment-method/{paymentToken}	Get Payment Method Associated with Customer by Token (Partner context)
CustomersApi	accountGetCustomerCustomerIdPayments	GET /account/{accountId}/customer/{customerId}/payments	Get Customer Payments (Partner context)
CustomersApi	accountGetCustomerDefaultPaymentMethod	GET /account/{accountId}/customer/{customerId}/payment-method/default	Get Default Payment Method Associated to a Customer (Partner context)
CustomersApi	accountGetCustomerId	GET /account/{accountId}/customer/{customerId}	Get Customer by ID (Partner context)
CustomersApi	accountGetCustomerIdPaymentMethod	GET /account/{accountId}/customer/{customerId}/payment-method	Query Payment Methods of a Customer (Partner context)
CustomersApi	accountGetCustomerTokenPaymentMethod	GET /account/{accountId}/customer-token/{customerToken}/payment-method	Query Payment Methods for Customer by customer token (Partner context)
CustomersApi	accountPostCustomer	POST /account/{accountId}/customer	Create Customer (Partner context)
CustomersApi	accountPostCustomerIdPaymentMethod	POST /account/{accountId}/customer/{customerId}/payment-method	Attach Payment Method to a Customer (Partner context)
CustomersApi	accountPutCustomerId	PUT /account/{accountId}/customer/{customerId}	Update Customer by ID (Partner context)
CustomersApi	deleteCustomerCustomerIdPaymentMethodToken	DELETE /customer/{customerId}/payment-method/{paymentToken}	Delete Payment Method Associated with Customer by Token (Sub-merchant context)
CustomersApi	deleteCustomerId	DELETE /customer/{customerId}	Delete Customer by ID (Sub-merchant context)
CustomersApi	getCustomer	GET /customer	Query customers (Sub-merchant context)
CustomersApi	getCustomerCustomerIdPaymentMethodToken	GET /customer/{customerId}/payment-method/{paymentToken}	Get Payment Method Associated with Customer by Token (Sub-merchant context)
CustomersApi	getCustomerCustomerIdPayments	GET /customer/{customerId}/payments	Get Customer Payments (Sub-merchant context)
CustomersApi	getCustomerId	GET /customer/{customerId}	Get Customer by ID (Sub-merchant context)
CustomersApi	getCustomerIdPaymentMethod	GET /customer/{customerId}/payment-method	Query Payment Methods of a Customer (Sub-merchant context)
CustomersApi	getCustomerTokenPaymentMethod	GET /customer-token/{customerToken}/payment-method	Query Payment Methods for Customer by customer token (Sub-merchant context)
CustomersApi	postCustomer	POST /customer	Create Customer for (Sub-merchant context)
CustomersApi	postCustomerIdPaymentMethod	POST /customer/{customerId}/payment-method	Attach Payment Method to a Customer (Sub-merchant context)
CustomersApi	putCustomerId	PUT /customer/{customerId}	Update Customer by ID (Sub-merchant context)
DocumentManagementApi	createDocumentRequest	POST /organization/{organizationId}/onboarding/{onboardingId}/document-request	Request Document
DocumentManagementApi	deleteDocumentById	DELETE /organization/{organizationId}/onboarding/{onboardingId}/document/{documentId}	Delete Document
DocumentManagementApi	deleteDocumentRequestById	DELETE /organization/{organizationId}/onboarding/{onboardingId}/document-request/{documentRequestId}	Delete Document Request
DocumentManagementApi	getDocumentById	GET /organization/{organizationId}/onboarding/{onboardingId}/document/{documentId}/download	Download Document
DocumentManagementApi	getDocuments	GET /organization/{organizationId}/onboarding/{onboardingId}/document	List Uploaded Documents
DocumentManagementApi	getDownloadAllDocuments	GET /organization/{organizationId}/onboarding/{onboardingId}/document/download	Download All Documents
DocumentManagementApi	getListDocumentRequests	GET /organization/{organizationId}/onboarding/{onboardingId}/document-request	List Document Requests
DocumentManagementApi	getRetrieveDocument	GET /organization/{organizationId}/onboarding/{onboardingId}/document/{documentId}	Retrieve Document
DocumentManagementApi	getRetrieveDocumentRequest	GET /organization/{organizationId}/onboarding/{onboardingId}/document-request/{documentRequestId}	Retrieve Document Request
DocumentManagementApi	listDocumentRequestByToken	GET /document-request/{documentRequestToken}	List Document Requests by Token
DocumentManagementApi	putUpdateDocumentTypeById	PUT /organization/{organizationId}/onboarding/{onboardingId}/document/{documentId}	Update Document Type
DocumentManagementApi	updateDocumentRequest	PUT /organization/{organizationId}/onboarding/{onboardingId}/document-request/{documentRequestId}	Update Document Request
DocumentManagementApi	uploadDocument	POST /organization/{organizationId}/onboarding/{onboardingId}/document	Upload Document
DocumentManagementApi	uploadDocumentByToken	POST /document/{token}	Upload Document using Token
MerchantOnboardingApi	createOnboarding	POST /organization/{organizationId}/onboarding	Create Onboarding Application
MerchantOnboardingApi	deleteOnboardingById	DELETE /organization/{organizationId}/onboarding/{onboardingId}	Delete Onboarding
MerchantOnboardingApi	listFilterOptions	GET /organization/{organizationId}/onboarding/filters	List Filter Options
MerchantOnboardingApi	listMerchantCategoryCodes	GET /mcc	List Merchant Category Codes
MerchantOnboardingApi	listOnboardingByOrganization	GET /organization/{organizationId}/onboarding	List Onboardings by Organization
MerchantOnboardingApi	listOnboardings	GET /onboarding	List Onboardings
MerchantOnboardingApi	retrieveOnboardingById	GET /organization/{organizationId}/onboarding/{onboardingId}	Retrieve Onboarding
MerchantOnboardingApi	searchOnboardingByBusinessName	GET /onboarding/search/{businessName}	Search Onboarding by Business Name
MerchantOnboardingApi	searchOnboardingByOrganizationIdAndBusinessName	GET /organization/{organizationId}/onboarding/search/{businessName}	Search Onboarding by Organization identifier and Business Name
OrdersApi	accountAccountIdOrdersOrderIdGet	GET /account/{accountId}/orders/{orderId}	Get Order Details
OrdersApi	accountAccountIdOrdersOrderIdPut	PUT /account/{accountId}/orders/{orderId}	Update Order
OrdersApi	accountAccountIdOrdersPost	POST /account/{accountId}/orders	Create Order specifying an account
OrdersApi	ordersGet	GET /orders	List Orders
OrdersApi	ordersOrderIdAccessTokenPost	POST /orders/{orderId}/accessToken	Create New Access Token
OrdersApi	ordersOrderIdResetPut	PUT /orders/{orderId}/reset	Reset Payment Attempts
OrdersApi	ordersPost	POST /orders	Create Order
OrdersApi	postAccountAccountIdOrdersOrderIdPay	POST /account/{accountId}/orders/{orderId}/pay	Pay for Order with Token
PaymentMethodsApi	accountDeletePaymentMethod	DELETE /account/{accountId}/payment-method/{paymentToken}	Delete a Payment Method for a given Account
PaymentMethodsApi	accountGetPaymentMethod	GET /account/{accountId}/payment-method/{paymentToken}	Retrieve a Payment Method for a given Account
PaymentMethodsApi	accountPostPaymentMethod	POST /account/{accountId}/payment-method	Create Payment Method for a given Account
PaymentMethodsApi	accountPostVerifyMicrodeposits	POST /account/{accountId}/payment-method/{payment-token}/verify	Verify micro-deposits on an ACH Payment Method for a given Account
PaymentMethodsApi	deletePaymentMethod	DELETE /payment-method/{paymentToken}	Delete a Payment Method
PaymentMethodsApi	getPaymentMethod	GET /payment-method/{paymentToken}	Retrieve a Payment Method
PaymentMethodsApi	postPaymentMethod	POST /payment-method	Create Payment Method
PaymentMethodsApi	postVerifyMicrodeposits	POST /payment-method/{payment-token}/verify	Verify micro-deposits on an ACH Payment Method
PaymentsApi	accountCapturePayment	POST /account/{accountId}/payments/{paymentId}/capture	Capture an existing authorization for a given Account
PaymentsApi	accountGetPayment	GET /account/{accountId}/payments/{paymentId}	Get details of a specific Payment for a given Account
PaymentsApi	accountGetPayments	GET /account/{accountId}/payments	Get Payments for a given Account
PaymentsApi	accountPostPayment	POST /account/{accountId}/payments	Create Payment for a given Account
PaymentsApi	accountRefundPayment	POST /account/{accountId}/payments/{paymentId}/refund	Refund a specific Payment for a given Account
PaymentsApi	accountVoidPayment	POST /account/{accountId}/payments/{paymentId}/void	Void a specific Payment for a given Account
PaymentsApi	capturePayment	POST /payments/{paymentId}/capture	Capture an existing authorization
PaymentsApi	getPayment	GET /payments/{paymentId}	Get details of a specific Payment
PaymentsApi	getPayments	GET /payments	Get Payments
PaymentsApi	postPayment	POST /payments	Create Payment
PaymentsApi	refundPayment	POST /payments/{paymentId}/refund	Refund a specific payment
PaymentsApi	voidPayment	POST /payments/{paymentId}/void	Void a specific Payment
ReportingApi	deleteReport	DELETE /report/{reportId}	Delete Report
ReportingApi	getReport	GET /report/{reportId}	Download Report
ReportingApi	getReportDetails	GET /report/{reportId}/details	Get Report Details
ReportingApi	getReports	GET /report	List Reports
ReportingApi	postReport	POST /report/{domain}	Create Report
UnderwritingWorkflowApi	deleteWorkflowById	DELETE /organization/{organizationId}/onboarding-workflow/{workflowId}	Delete Workflow
UnderwritingWorkflowApi	disableWorkflowById	PUT /organization/{organizationId}/onboarding-workflow/{workflowId}/disable	Disable Workflow
UnderwritingWorkflowApi	enableWorkflowById	PUT /organization/{organizationId}/onboarding-workflow/{workflowId}/enable	Enable Workflow
UnderwritingWorkflowApi	getListWorkflows	GET /organization/{organizationId}/onboarding-workflow	List Underwriting Workflows
UnderwritingWorkflowApi	getRetrieveWorkflow	GET /organization/{organizationId}/onboarding-workflow/{workflowId}	Retrieve Workflow
UnderwritingWorkflowApi	postCreateWorkflow	POST /organization/{organizationId}/onboarding-workflow	Create Workflow
UnderwritingWorkflowApi	putUpdateWorkflow	PUT /organization/{organizationId}/onboarding-workflow/{workflowId}	Update Workflow
UnderwritingWorkflowApi	setDefaultWorkflowById	PUT /organization/{organizationId}/onboarding-workflow/{workflowId}/default	Set Default Workflow
WebhooksApi	accountDeleteWebhook	DELETE /account/{accountId}/webhook/{webhookId}	Delete Webhook
WebhooksApi	accountDisableWebhook	PUT /account/{accountId}/webhook/{webhookId}/disable	Disable Webhook
WebhooksApi	accountEnableWebhook	PUT /account/{accountId}/webhook/{webhookId}/enable	Enable Webhook
WebhooksApi	accountGetListWebhooks	GET /account/{accountId}/webhook	List Webhooks
WebhooksApi	accountGetRetrieveWebhook	GET /account/{accountId}/webhook/{webhookId}	Retrieve Webhook
WebhooksApi	accountPostCreateWebhook	POST /account/{accountId}/webhook	Create Webhook
WebhooksApi	accountUpdateWebhook	PUT /account/{accountId}/webhook/{webhookId}	Update Webhook
WebhooksApi	organizationOrganizationIdWebhookGet	GET /organization/{organizationId}/webhook	List Webhooks
WebhooksApi	organizationOrganizationIdWebhookPost	POST /organization/{organizationId}/webhook	Create Webhook
WebhooksApi	organizationOrganizationIdWebhookWebhookIdDelete	DELETE /organization/{organizationId}/webhook/{webhookId}	Delete Webhook
WebhooksApi	organizationOrganizationIdWebhookWebhookIdDisablePut	PUT /organization/{organizationId}/webhook/{webhookId}/disable	Disable Webhook
WebhooksApi	organizationOrganizationIdWebhookWebhookIdEnablePut	PUT /organization/{organizationId}/webhook/{webhookId}/enable	Enable Webhook
WebhooksApi	organizationOrganizationIdWebhookWebhookIdGet	GET /organization/{organizationId}/webhook/{webhookId}	Retrieve Webhook
WebhooksApi	organizationOrganizationIdWebhookWebhookIdPut	PUT /organization/{organizationId}/webhook/{webhookId}	Update Webhook

Models

Authorization

Authentication schemes defined for the API:

apiKey

Type: API key
API key parameter name: Authorization
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: 1.0.4
Build package: org.openapitools.codegen.languages.PhpClientCodegen

thelogicstudio / exactpay

Maintainers

Details