Download the PHP package payload/payload-api without Composer
On this page you can find all versions of the php package payload/payload-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download payload/payload-api
More information about payload/payload-api
Files in payload/payload-api
Package payload-api
Short Description Payload PHP Library
License MIT
Homepage http://github.com/payload-code/payload-php
Informations about the package payload-api
Payload PHP Library
A PHP library for integrating Payload.
Installation
Install using composer
Install and run manually
Dependencies
Require import.php
Get Started
Once you've installed the Payload PHP library to your environment,
we recommend
using the shorthand alias name of pl for Payload\API.
API Authentication
To authenticate with the Payload API, you'll need a live or test API key. API keys are accessible from within the Payload dashboard.
API Version
You can specify the API version to use by setting the api_version property.
Testing the PHP Library
Tests are contained within the Tests/ directory. To run a test file enter the command in terminal
Test execution options can be viewed using the command.
Creating an Object
Interfacing with the Payload API is done primarily through Payload Objects. Below is an example of
creating a customer using the Payload\Customer object.
Accessing Object Attributes
Object attributes are accessible through dot notation.
Updating an Object
Updating an object is a simple call to the update object method.
Selecting Objects
Objects can be selected using any of their attributes.
Use the pl::attr() attribute helper
interface to write powerful queries with a little extra syntax sugar.
Available Objects
The following Payload objects are available in this library:
Core Objects:
Payload\Customer(v1 only)Payload\TransactionPayload\PaymentMethodPayload\AccountPayload\ProcessingAccount(v1 only)
Billing & Invoicing:
Payload\InvoicePayload\InvoiceItemPayload\BillingSchedulePayload\BillingCharge(v1 only)Payload\BillingItemPayload\LineItem(v1 only)
Payment Processing:
Payload\PaymentLinkPayload\PaymentActivation(v1 only)Payload\PaymentAllocationPayload\Intent
Business Entities:
Payload\ProfilePayload\EntityPayload\StakeholderPayload\ProcessingAgreementPayload\ProcessingRulePayload\ProcessingSettings
Transfers & Operations:
Payload\TransferPayload\TransactionOperation
Payment Methods:
Payload\Card(v1 only)Payload\BankAccount(v1 only)Payload\CheckFrontPayload\CheckBack
Other:
Payload\WebhookPayload\AccessTokenPayload\ClientTokenPayload\OAuthToken
Documentation
To get further information on Payload's PHP library and API capabilities, visit the unabridged Payload Documentation.
All versions of payload-api with dependencies
ext-curl Version *