PHPackages                             promisepay/promisepay-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. promisepay/promisepay-php

ActiveLibrary[API Development](/categories/api)

promisepay/promisepay-php
=========================

PHP SDK for the PromisePay API

2.4.5(8y ago)8330.0k—4.8%18[3 issues](https://github.com/PromisePay/promisepay-php/issues)PHPPHP >=5.3.3

Since Jul 30Pushed 7y ago26 watchersCompare

[ Source](https://github.com/PromisePay/promisepay-php)[ Packagist](https://packagist.org/packages/promisepay/promisepay-php)[ Docs](https://promisepay.com/)[ RSS](/packages/promisepay-promisepay-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (6)Dependencies (5)Versions (23)Used By (0)

PHP SDK - PromisePay API
========================

[](#php-sdk---promisepay-api)

[![Build Status](https://camo.githubusercontent.com/23b023b76b57c50918b0444629253cd4904b6c2d0e082f7be42fe7c734853d15/68747470733a2f2f7472617669732d63692e6f72672f50726f6d6973655061792f70726f6d6973657061792d7068702e737667)](https://travis-ci.org/NinoSkopac/promisepay-php) [![Latest Stable Version](https://camo.githubusercontent.com/6a9ada7353f627c971199d51ef93b60cc11c58e5fcde3164f004c47d27512916/68747470733a2f2f706f7365722e707567782e6f72672f70726f6d6973657061792f70726f6d6973657061792d7068702f762f737461626c65)](https://packagist.org/packages/promisepay/promisepay-php)[![Total Downloads](https://camo.githubusercontent.com/a9b6b72418c73d8bd7bd0084476e6419520f3041654150ca71946024044938d6/68747470733a2f2f706f7365722e707567782e6f72672f70726f6d6973657061792f70726f6d6973657061792d7068702f646f776e6c6f616473)](https://packagist.org/packages/promisepay/promisepay-php)[![Code Climate](https://camo.githubusercontent.com/e76e678dd94287d2ea1fa8cdec64bb67b9fe1f8d0b196dfdd39ae5c980cc1ff4/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f50726f6d6973655061792f70726f6d6973657061792d7068702f6261646765732f6770612e737667)](https://codeclimate.com/github/PromisePay/promisepay-php)

Note: The api only responds to the models which are included with the php package.

- [Installation](#installation)
    - [Composer](#composer)
    - [Manual Installation](#manual-installation)
    - [Prerequisites](#prerequisites)
- [Configuration](#configuration)
- [Examples](#examples)
    - [Tokens](#tokens)
        - [Request session token](#request-session-token)
    - [Items](#items)
        - [Create an item](#create-an-item)
        - [Get an item](#get-an-item)
        - [Get a list of items](#get-a-list-of-items)
        - [Update an item](#update-an-item)
        - [Delete an item](#delete-an-item)
        - [Get an item status](#get-an-item-status)
        - [Get an item's buyer](#get-an-items-buyer)
        - [Get an item's seller](#get-an-items-seller)
        - [Get an item's fees](#get-an-items-fees)
        - [Get an item's transactions](#get-an-items-transactions)
        - [Get an item's wire details](#get-an-items-wire-details)
        - [Get an item's BPAY details](#get-an-items-bpay-details)
    - [Item Actions](#item-actions)
        - [Make payment](#make-payment)
        - [Request payment](#request-payment)
        - [Release payment](#release-payment)
        - [Request release](#request-release)
        - [Cancel](#cancel)
        - [Acknowledge wire](#acknowledge-wire)
        - [Acknowledge PayPal](#acknowledge-paypal)
        - [Revert wire](#revert-wire)
        - [Request refund](#request-refund)
        - [Refund](#refund)
        - [Decline refund](#decline-refund)
        - [Raise Dispute](#raise-dispute)
        - [Request Dispute Resolution](#request-dispute-resolution)
        - [Resolve Dispute](#resolve-dispute)
        - [Escalate Dispute](#escalate-dispute)
        - [Request Tax Invoice](#request-tax-invoice)
        - [List Item Batch Transactions](#list-item-batch-transactions)
        - [Send Tax Invoice](#send-tax-invoice)
    - [Users](#users)
        - [Create a user](#create-a-user)
        - [Get a user](#get-a-user)
        - [Get a list of users](#get-a-list-of-users)
        - [Update a user](#update-a-user)
        - [Get a user's card accounts](#get-a-users-card-accounts)
        - [Get a user's PayPal accounts](#get-a-users-paypal-accounts)
        - [Get a user's bank accounts](#get-a-users-bank-accounts)
        - [Get a user's items](#get-a-users-items)
        - [Show User Wallet Account](#show-user-wallet-account)
        - [Set a user's disbursement account](#set-a-users-disbursement-account)
    - [Wallet Accounts](#wallet-accounts)
        - [Show Wallet Account](#show-wallet-account)
        - [Withdraw Funds](#withdraw-funds)
        - [Deposit Funds](#deposit-funds)
        - [Show Wallet Account User](#show-wallet-account-user)
    - [Card Accounts](#card-accounts)
        - [Create a card account](#create-a-card-account)
        - [Get a card account](#get-a-card-account)
        - [Delete a card account](#delete-a-card-account)
        - [Get a card account's users](#get-a-card-accounts-users)
    - [Bank Accounts](#bank-accounts)
        - [Create a bank account](#create-a-bank-account)
        - [Get a bank account](#get-a-bank-account)
        - [Delete a bank account](#delete-a-bank-account)
        - [Get a bank account's users](#get-a-bank-accounts-users)
        - [Validate Routing Number](#validate-routing-number)
    - [PayPal Accounts](#paypal-accounts)
        - [Create a PayPal account](#create-a-paypal-account)
        - [Get a PayPal account](#get-a-paypal-account)
        - [Delete a PayPal account](#delete-a-paypal-account)
        - [Get a PayPal account's users](#get-a-paypal-accounts-users)
    - [Batch Transactions](#batch-transactions)
        - [List Batch Transactions](#list-batch-transactions)
        - [Show Batch Transaction](#show-batch-transaction)
    - [Charges](#charges)
        - [Create Charge](#create-charge)
        - [List Charges](#list-charges)
        - [Show Charge](#show-charge)
        - [Show Charge Buyer](#show-charge-buyer)
        - [Show Charge Status](#show-charge-status)
    - [Marketplaces](#marketplaces)
        - [Show Marketplace](#show-marketplace)
    - [Token Auth](#token-auth)
        - [Generate Card Token](#generate-card-token)
    - [Direct Debit Authority](#direct-debit-authority)
        - [Create Direct Debit Authority](#create-direct-debit-authority)
        - [List Direct Debit Authority](#list-direct-debit-authority)
        - [Show Direct Debit Authority](#show-direct-debit-authority)
        - [Delete Direct Debit Authority](#delete-direct-debit-authority)
    - [Companies](#companies)
        - [Create a company](#create-a-company)
        - [Get a company](#get-a-company)
        - [Get a list of companies](#get-a-list-of-companies)
        - [Update a company](#update-a-company)
    - [Fees](#fees)
        - [Get a list of fees](#get-a-list-of-fees)
        - [Get a fee](#get-a-fee)
        - [Create a fee](#create-a-fee)
    - [Transactions](#transactions)
        - [Get a list of transactions](#get-a-list-of-transactions)
        - [Get a transaction](#get-a-transaction)
        - [Get a transaction's user](#get-a-transactions-user)
        - [Get a transaction's fee](#get-a-transactions-fee)
        - [Show Transaction Wallet Account](#show-transaction-wallet-account)
        - [Show Transaction Card Account](#show-transaction-card-account)
    - [Addresses](#addresses)
        - [Show Address](#show-address)
    - [Tools](#tools)
        - [Health check](#health-check)
    - [Configurations](#configurations)
        - [Create Configuration](#create-configuration)
        - [Show Configuration](#show-configuration)
        - [List Configurations](#list-configurations)
        - [Update Configuration](#update-configuration)
        - [Delete Configuration](#delete-configuration)
    - [Payment Restrictions](#payment-restrictions)
        - [List Payment Restrictions](#list-payment-restrictions)
        - [Show Payment Restriction](#show-payment-restriction)
    - [Callbacks](#callbacks)
        - [Create Callback](#create-callback)
        - [List Callbacks](#list-callbacks)
        - [Show Callback](#show-callback)
        - [Update Callback](#update-callback)
        - [Delete Callback](#delete-callback)
        - [List Callback Responses](#list-callback-responses)
        - [Show Callback Response](#show-callback-response)
- [Async and Wrappers](#async-and-wrappers)
    - [Async](#async)
    - [Wrappers](#wrappers)
- [Contributing](#contributing)

Installation
============

[](#installation)

### Composer

[](#composer)

You can include this package via Composer.

```
{
  "require": {
    "promisepay/promisepay-php": "2.*"
  }
}
```

Install the package.

```
composer install

```

Require the package in the controller where you'll be using it.

```
use PromisePay\PromisePay;
```

### Manual Installation

[](#manual-installation)

Download the latest release from GitHub, then require the package in the relevant controller.

```
use PromisePay\PromisePay;
```

### Prerequisites

[](#prerequisites)

- PHP 5.3 or above
- [curl](http://php.net/manual/en/book.curl.php) and [json](http://php.net/manual/en/book.json.php) extensions must be enabled

Configuration
=============

[](#configuration)

Before interacting with PromisePay API, you'll need to [create a prelive account](https://management.prelive.promisepay.com/#/sign-up/prelive) and get an API token.

Afterwards, you need to declare environment, login (your email address) and password (API token), thus:

```
PromisePay::Configuration()->environment('prelive'); // Use 'production' for the production environment.
PromisePay::Configuration()->login('your_email_address');
PromisePay::Configuration()->password('your_token');
```

Examples
========

[](#examples)

Tokens
------

[](#tokens)

### Request session token

[](#request-session-token)

The below example shows the request for a marketplace configured to have the Item and User IDs generated automatically for them.

```
$token = PromisePay::Token()->requestSessionToken(array(
	'current_user'           => 'seller',
	'item_name'              => 'Test Item',
	'amount'                 => '2500',
	'seller_lastname'        => 'Seller',
	'seller_firstname'       => 'Sally',
	'buyer_lastname'         => 'Buyer',
	'buyer_firstname'        => 'Bobby',
	'buyer_country'          => 'AUS',
	'seller_country'         => 'USA',
	'seller_email'           => 'sally.seller@promisepay.com',
	'buyer_email'            => 'bobby.buyer@promisepay.com',
	'fee_ids'                => '',
	'payment_type_id'        => '2'
));
```

Items
-----

[](#items)

### Create an item

[](#create-an-item)

```
$item = PromisePay::Item()->create(array(
    "id"              => 'ITEM_ID',
    "name"            => 'Test Item #1',
    "amount"          => 1000,
    "payment_type_id" => 1,
    "buyer_id"        => 'BUYER_ID',
    "seller_id"       => 'SELLER_ID',
    "description"     => 'Description'
));
```

### Get an item

[](#get-an-item)

```
$item = PromisePay::Item()->get('ITEM_ID');
```

### Get a list of items

[](#get-a-list-of-items)

```
$items = PromisePay::Item()->getList(array(
	'limit' => 20,
	'offset' => 0
));
```

### Update an item

[](#update-an-item)

```
$item = PromisePay::Item()->update('ITEM_ID', array(
    "id"              => 'ITEM_ID',
    "name"            => 'Test Item #1',
    "amount"          => 1000,
    "payment_type_id" => 1,
    "buyer_id"        => 'BUYER_ID',
    "seller_id"       => 'SELLER_ID',
    "description"     => 'Description'
));
```

### Delete an item

[](#delete-an-item)

```
$item = PromisePay::Item()->delete('ITEM_ID');
```

### Get an item status

[](#get-an-item-status)

```
$item = PromisePay::Item()->getStatus('ITEM_ID');
```

### Get an item's buyer

[](#get-an-items-buyer)

```
$user = PromisePay::Item()->getBuyer('ITEM_ID');
```

### Get an item's seller

[](#get-an-items-seller)

```
$user = PromisePay::Item()->getSeller('ITEM_ID');
```

### Get an item's fees

[](#get-an-items-fees)

```
$fees = PromisePay::Item()->getListOfFees('ITEM_ID');
```

### Get an item's transactions

[](#get-an-items-transactions)

```
$transactions = PromisePay::Item()->getListOfTransactions('ITEM_ID');
```

### Get an item's wire details

[](#get-an-items-wire-details)

```
$wireDetails = PromisePay::Item()->getWireDetails('ITEM_ID');
```

### Get an item's BPAY details

[](#get-an-items-bpay-details)

```
$bPayDetails = PromisePay::Item()->getBPayDetails('ITEM_ID');
```

Item Actions
------------

[](#item-actions)

### Make payment

[](#make-payment)

```
$item = PromisePay::Item()->makePayment('ITEM_ID', array(
	'account_id' => 'BUYER_ACCOUNT_ID'
));
```

### Request payment

[](#request-payment)

```
$item = PromisePay::Item()->requestPayment('ITEM_ID');
```

### Release payment

[](#release-payment)

```
$item = PromisePay::Item()->releasePayment('ITEM_ID');
```

### Request release

[](#request-release)

```
$item = PromisePay::Item()->requestRelease('ITEM_ID');
```

### Cancel

[](#cancel)

```
$item = PromisePay::Item()->cancelItem('ITEM_ID');
```

### Acknowledge wire

[](#acknowledge-wire)

```
$item = PromisePay::Item()->acknowledgeWire('ITEM_ID');
```

### Acknowledge PayPal

[](#acknowledge-paypal)

```
$item = PromisePay::Item()->acknowledgePayPal('ITEM_ID');
```

### Revert wire

[](#revert-wire)

```
$item = PromisePay::Item()->revertWire('ITEM_ID');
```

### Request refund

[](#request-refund)

```
$item = PromisePay::Item()->requestRefund('ITEM_ID', array(
	'refund_amount' => 1000,
	'refund_message' => 'Frame already constructed.'
));
```

### Refund

[](#refund)

```
$item = PromisePay::Item()->refund('ITEM_ID', array(
	'refund_amount' => 1000,
	'refund_message' => 'Stable deck refund.'
));
```

### Decline refund

[](#decline-refund)

```
$declineRefund = PromisePay::Item()->declineRefund(
    'ITEM_ID'
);
```

### Raise Dispute

[](#raise-dispute)

```
$raiseDispute = PromisePay::Item()->raiseDispute(
    'ITEM_ID',
    'BUYER_ID'
);
```

### Request Dispute Resolution

[](#request-dispute-resolution)

```
$requestDisputeResolution = PromisePay::Item()->requestDisputeResolution(
    'ITEM_ID'
);
```

### Resolve Dispute

[](#resolve-dispute)

```
$resolveDispute = PromisePay::Item()->resolveDispute(
    'ITEM_ID'
);
```

### Escalate Dispute

[](#escalate-dispute)

```
$resolveDispute = PromisePay::Item()->escalateDispute(
    'ITEM_ID'
);
```

### Request Tax Invoice

[](#request-tax-invoice)

```
$requestTaxInvoice = PromisePay::Item()->requestTaxInvoice(
    'ITEM_ID'
);
```

### List Item Batch Transactions

[](#list-item-batch-transactions)

```
$batchTransactions = PromisePay::Item()->listBatchTransactions('ITEM_ID');
```

### Send Tax Invoice

[](#send-tax-invoice)

```
$sendTaxInvoice = PromisePay::Item()->sendTaxInvoice(
    'ITEM_ID'
);
```

Users
-----

[](#users)

### Create a user

[](#create-a-user)

```
$user = PromisePay::User()->create(array(
    'id'            => 'USER_ID',
    'first_name'    => 'UserCreateTest',
    'last_name'     => 'UserLastname',
    'email'         => 'email@google.com',
    'mobile'        => '5455400012',
    'address_line1' => 'a_line1',
    'address_line2' => 'a_line2',
    'state'         => 'state',
    'city'          => 'city',
    'zip'           => '90210',
    'country'       => 'AUS'
));
```

### Get a user

[](#get-a-user)

```
$user = PromisePay::User()->get('USER_ID');
```

### Get a list of users

[](#get-a-list-of-users)

```
$users = PromisePay::User()->getList(array(
	'limit' => 20,
	'offset' => 0
));
```

### Update a user

[](#update-a-user)

```
$user = PromisePay::User()->update('USER_ID', array(
    'id'            => 'USER_ID',
    'first_name'    => 'UserCreateTest',
    'last_name'     => 'UserLastname',
    'email'         => 'email@google.com',
    'mobile'        => '5455400012',
    'address_line1' => 'a_line1',
    'address_line2' => 'a_line2',
    'state'         => 'state',
    'city'          => 'city',
    'zip'           => '90210',
    'country'       => 'AUS'
));
```

### Get a user's card accounts

[](#get-a-users-card-accounts)

```
$accounts = PromisePay::User()->getListOfCardAccounts('USER_ID');
```

### Get a user's PayPal accounts

[](#get-a-users-paypal-accounts)

```
$accounts = PromisePay::User()->getListOfPayPalAccounts('USER_ID');
```

### Get a user's bank accounts

[](#get-a-users-bank-accounts)

```
$accounts = PromisePay::User()->getListOfBankAccounts('USER_ID');
```

### Get a user's items

[](#get-a-users-items)

```
$items = PromisePay::User()->getListOfItems('USER_ID');
```

### Show User Wallet Account

[](#show-user-wallet-account)

```
$accounts = PromisePay::User()->getListOfWalletAccounts('USER_ID');
```

### Set a user's disbursement account

[](#set-a-users-disbursement-account)

```
$account = PromisePay::User()->setDisbursementAccount('USER_ID', array(
    'account_id' => 'ACCOUNT_ID'
));
```

Wallet Accounts
---------------

[](#wallet-accounts)

### Show Wallet Account

[](#show-wallet-account)

```
$wallet = PromisePay::WalletAccounts()->show('WALLET_ID');
```

### Withdraw Funds

[](#withdraw-funds)

```
// Withdraw to PayPal

// Authorize bank account to be used as a funding source
$authority = PromisePay::DirectDebitAuthority()->create(
    array(
        'account_id' => 'SOURCE_BANK_ID',
        'amount'     => 100
    )
);

$withdrawal = PromisePay::WalletAccounts()->withdraw(
    'SOURCE_BANK_ID',
    array(
        'account_id' => 'PAYPAY_ACCOUNT_ID',
        'amount'     => 100
    )
);

// Withdraw to Bank Account

// Authorize bank account to be used as a funding source
$authority = PromisePay::DirectDebitAuthority()->create(
    array(
        'account_id' => 'SOURCE_BANK_ID',
        'amount'     => 100
    )
);

$withdrawal = PromisePay::WalletAccounts()->withdraw(
    'SOURCE_BANK_ID',
    array(
        'account_id' => 'TARGET_BANK_ID',
        'amount'     => 100
    )
);
```

### Deposit Funds

[](#deposit-funds)

```
// Authorize bank account to be used as a funding source
$authority = PromisePay::DirectDebitAuthority()->create(
    array(
        'account_id' => 'SOURCE_BANK_ID',
        'amount'     => 100
    )
);

$deposit = PromisePay::WalletAccounts()->deposit(
    'TARGET_WALLET_ID',
    array(
        'account_id' => 'SOURCE_BANK_ID',
        'amount'     => 100
    )
);
```

### Show Wallet Account User

[](#show-wallet-account-user)

```
$walletUser = PromisePay::WalletAccounts()->getUser('WALLET_ID');
```

Card Accounts
-------------

[](#card-accounts)

### Create a card account

[](#create-a-card-account)

```
$account = PromisePay::CardAccount()->create(array(
   'user_id'      => 'USER_ID',
   'full_name'    => 'Bobby Buyer',
   'number'       => '4111111111111111',
   "expiry_month" => '06',
   "expiry_year"  => '2020',
   "cvv"          => '123'
));
```

### Get a card account

[](#get-a-card-account)

```
$account = PromisePay::CardAccount()->get('CARD_ACCOUNT_ID');
```

### Delete a card account

[](#delete-a-card-account)

```
$account = PromisePay::CardAccount()->delete('CARD_ACCOUNT_ID');
```

### Get a card account's users

[](#get-a-card-accounts-users)

```
$user = PromisePay::CardAccount()->getUser('CARD_ACCOUNT_ID');
```

Bank Accounts
-------------

[](#bank-accounts)

### Create a bank account

[](#create-a-bank-account)

```
$account = PromisePay::BankAccount()->create(array(
    "user_id"        => 'USER_ID',
    "active"         => 'true',
    "bank_name"      => 'bank for test',
    "account_name"   => 'test acc',
    "routing_number" => '12344455512',
    "account_number" => '123334242134',
    "account_type"   => 'savings',
    "holder_type"    => 'personal',
    "country"        => 'USA',
));
```

### Get a bank account

[](#get-a-bank-account)

```
$account = PromisePay::BankAccount()->get('BANK_ACCOUNT_ID');
```

### Delete a bank account

[](#delete-a-bank-account)

```
$account = PromisePay::BankAccount()->delete('BANK_ACCOUNT_ID');
```

### Get a bank account's users

[](#get-a-bank-accounts-users)

```
$user = PromisePay::BankAccount()->getUser('BANK_ACCOUNT_ID');
```

### Validate Routing Number

[](#validate-routing-number)

```
$validateRoutingNumber = PromisePay::BankAccount()->validateRoutingNumber(
    'ROUTING_NUMBER'
);
```

PayPal Accounts
---------------

[](#paypal-accounts)

### Create a PayPal account

[](#create-a-paypal-account)

```
$account = PromisePay::PayPalAccount()->create(array(
    'user_id'      => 'USER_ID',
    'paypal_email' => 'test@paypalname.com'
));
```

### Get a PayPal account

[](#get-a-paypal-account)

```
$account = PromisePay::PayPalAccount()->get('PAYPAL_ACCOUNT_ID');
```

### Delete a PayPal account

[](#delete-a-paypal-account)

```
$account = PromisePay::PayPalAccount()->delete('PAYPAL_ACCOUNT_ID');
```

### Get a PayPal account's users

[](#get-a-paypal-accounts-users)

```
$user = PromisePay::PayPalAccount()->getUser('PAYPAL_ACCOUNT_ID');
```

Batch Transactions
------------------

[](#batch-transactions)

### List Batch Transactions

[](#list-batch-transactions)

```
$batches = PromisePay::BatchTransactions()->listTransactions();
```

### Show Batch Transaction

[](#show-batch-transaction)

```
$batch = PromisePay::BatchTransactions()->showTransaction(
    'BATCH_TRANSACTION_ID'
);
```

Charges
-------

[](#charges)

### Create Charge

[](#create-charge)

```
$createCharge = PromisePay::Charges()->create(
    array
    (
        'account_id' => 'CARD_OR_BANK_ACCOUNT_ID',
        'amount' => 100,
        'email' => 'charged.user@email.com',
        'zip' => 90210,
        'country' => 'AUS',
        'device_id' => 'DEVICE_ID',
        'ip_address' => '49.229.186.182'
    )
);
```

### List Charges

[](#list-charges)

```
$getList = PromisePay::Charges()->getList();
```

### Show Charge

[](#show-charge)

```
$charge = PromisePay::Charges()->show('CHARGE_ID');
```

### Show Charge Buyer

[](#show-charge-buyer)

```
$buyer = PromisePay::Charges()->showBuyer('CHARGE_ID');
```

### Show Charge Status

[](#show-charge-status)

```
$status = PromisePay::Charges()->showStatus('CHARGE_ID');
```

Marketplaces
------------

[](#marketplaces)

### Show Marketplace

[](#show-marketplace)

```
$marketplaces = PromisePay::Marketplaces()->show();
```

Token Auth
----------

[](#token-auth)

### Generate Card Token

[](#generate-card-token)

```
$cardToken = PromisePay::Token()->generateCardToken(
    array
    (
        'token_type' => 'card',
        'user_id' => 'USER_ID'
    )
);
```

Direct Debit Authority
----------------------

[](#direct-debit-authority)

### Create Direct Debit Authority

[](#create-direct-debit-authority)

```
$directDebitAuthority = PromisePay::DirectDebitAuthority()->create(
    array
    (
        'account_id' => 'ACCOUNT_ID',
        'amount'     => 100
    )
);
```

### List Direct Debit Authority

[](#list-direct-debit-authority)

```
$getList = PromisePay::DirectDebitAuthority()->getList(
    array
    (
        'account_id' => 'BANK_ACCOUNT_ID'
    )
);
```

### Show Direct Debit Authority

[](#show-direct-debit-authority)

```
$directDebitAuthority = PromisePay::DirectDebitAuthority()->show(
    'DIRECT_DEBIT_AUTHORITY_ID'
);
```

### Delete Direct Debit Authority

[](#delete-direct-debit-authority)

```
$deleteDirectDebitAuthority = PromisePay::DirectDebitAuthority()->delete(
    'DIRECT_DEBIT_AUTHORITY_ID'
);
```

Companies
---------

[](#companies)

### Create a company

[](#create-a-company)

```
$company = PromisePay::Company()->create(array(
    'user_id'    => 'USER_ID',
    'legal_name' => 'Test edit company',
    'name'       => 'test company name edit',
    'country'    => 'AUS'
));
```

### Get a company

[](#get-a-company)

```
$company = PromisePay::Company()->get('COMPANY_ID');
```

### Get a list of companies

[](#get-a-list-of-companies)

```
$companys = PromisePay::Company()->getList(array(
	'limit' => 20,
	'offset' => 0
));
```

### Update a company

[](#update-a-company)

```
$company = PromisePay::Company()->update('COMPANY_ID', array(
    'id' => "e466dfb4-f05c-4c7f-92a3-09a0a28c7af5",
    'user_id' => "1",
    'name' => "Acme Co",
    'legal_name' => "Acme Co Pty Ltd",
    'tax_number' => "1231231",
    'charge_tax' => true,
    'address_line1' => "123 Test St",
    'address_line2' => "",
    'city' => "Melbourne",
    'state' => "VIC",
    'zip' => "3000",
    'country' => "AUS"
));
```

Fees
----

[](#fees)

### Get a list of fees

[](#get-a-list-of-fees)

```
$fees = PromisePay::Fee()->getList(array(
	'limit' => 20,
	'offset' => 0
));
```

### Get a fee

[](#get-a-fee)

```
$fee = PromisePay::Fee()->get('FEE_ID');
```

### Create a fee

[](#create-a-fee)

```
$fee = PromisePay::Fee()->create(array(
    'amount'      => 1000,
    'name'        => 'fee test',
    'fee_type_id' => '1',
    'cap'         => '1',
    'max'         => '3',
    'min'         => '2',
    'to'          => 'buyer'
));
```

Transactions
------------

[](#transactions)

### Get a list of transactions

[](#get-a-list-of-transactions)

```
$transactions = PromisePay::Transaction()->getList(array(
	'limit' => 20,
	'offset' => 0
));
```

### Get a transaction

[](#get-a-transaction)

```
$transaction = PromisePay::Transaction()->get('TRANSACTION_ID');
```

### Get a transaction's user

[](#get-a-transactions-user)

```
$user = PromisePay::Transaction()->getUser('TRANSACTION_ID');
```

### Get a transaction's fee

[](#get-a-transactions-fee)

```
$fee = PromisePay::Transaction()->getFee('TRANSACTION_ID');
```

### Show Transaction Wallet Account

[](#show-transaction-wallet-account)

```
$walletAccount = PromisePay::Transaction()->getWalletAccount(
    'TRANSACTION_ID'
);
```

### Show Transaction Card Account

[](#show-transaction-card-account)

```
$cardAccount = PromisePay::Transaction()->getCardAccount(
    'TRANSACTION_ID'
);
```

Addresses
---------

[](#addresses)

### Show Address

[](#show-address)

```
$address = PromisePay::Address()->get('ADDRESS_ID');
```

Tools
-----

[](#tools)

### Health check

[](#health-check)

```
$healthStatus = PromisePay::Tools()->getHealth();
```

Configurations
--------------

[](#configurations)

### Create Configuration

[](#create-configuration)

```
$configuration = PromisePay::Configurations()->create(array(
    'name' => 'partial_refunds',
    'enabled' => true
));
```

### Show Configuration

[](#show-configuration)

```
$configuration = PromisePay::Configurations()->get('CONFIGURATION_ID');
```

### List Configurations

[](#list-configurations)

```
$configurations = PromisePay::Configurations()->getList();
```

### Update Configuration

[](#update-configuration)

```
$configuration = PromisePay::Configurations()->update(array(
    'id' => 'CONFIGURATION_ID',
    'max' => 12345,
    'name' => 'partial_refunds',
    'enabled' => true
));
```

### Delete Configuration

[](#delete-configuration)

```
PromisePay::Configurations()->delete('CONFIGURATION_ID');
```

Payment Restrictions
--------------------

[](#payment-restrictions)

### List Payment Restrictions

[](#list-payment-restrictions)

```
$list = PromisePay::PaymentRestrictions()->getList();
```

### Show Payment Restriction

[](#show-payment-restriction)

```
$paymentRestriction = PromisePay::PaymentRestrictions()->get('PAYMENT_RESTRICTION_ID');
```

Callbacks
---------

[](#callbacks)

#### Create Callback

[](#create-callback)

```
$callback = PromisePay::Callbacks()->create(array(
    'description' => 'Users Callback',
    'url' => 'https://domain.tld/your/post/endpoint',
    'object_type' => 'users',
    'enabled' => true
));
```

#### List Callbacks

[](#list-callbacks)

```
$getList = PromisePay::Callbacks()->getList();
```

#### Show Callback

[](#show-callback)

```
$getCallback = PromisePay::Callbacks()->get('f92d4ca1-4ee5-43f3-9e34-ca5f759c5e76');
```

#### Update Callback

[](#update-callback)

```
$update = PromisePay::Callbacks()->update('f92d4ca1-4ee5-43f3-9e34-ca5f759c5e76', array(
    'description' => 'Users Callback',
    'url' => 'https://domain.tld/your/post/endpoint',
    'object_type' => 'users',
    'enabled' => false
));
```

#### Delete Callback

[](#delete-callback)

```
$delete = PromisePay::Callbacks()->delete('f92d4ca1-4ee5-43f3-9e34-ca5f759c5e76');
```

#### List Callback Responses

[](#list-callback-responses)

```
$callbackResponsesList = PromisePay::Callbacks()->getListResponses('f92d4ca1-4ee5-43f3-9e34-ca5f759c5e76');
```

#### Show Callback Response

[](#show-callback-response)

```
$callbackResponse = PromisePay::Callbacks()->getResponse(
    'f92d4ca1-4ee5-43f3-9e34-ca5f759c5e76', // callback ID
    '4476b384-fa48-4473-98ec-8fcdda4a1e84' // response ID
);
```

Async and Wrappers
==================

[](#async-and-wrappers)

Async
-----

[](#async)

Asynchronous execution provides a significant speed improvement, as compared to synchronous execution.

```
PromisePay::AsyncClient(
    function() {
        PromisePay::Token()->generateCardToken('CARD_TOKEN_ID');
    },
    function() {
        PromisePay::Transaction()->get('TRANSACTION_ID');
    },
    function() {
        PromisePay::Transaction()->getUser('USER_ID');
    },
    function() {
        PromisePay::BatchTransactions()->listTransactions();
    }
)->done(
    $cardToken,
    $transaction,
    $transactionUser,
    $batchTransactions
);
```

Response variables are placed inside `done()` method; they can be used both as arrays and objects, but using them as objects provides finer grained control. For example, the following will return equivalent data: `$cardToken['user_id']` and `$cardToken->getJson('user_id')`.

Response variables contain the following methods/getters:

- `getJson()` -> full response JSON
- `getMeta()` -> meta array extracted from response JSON, if present
- `getLinks()` -> links array extracted from response JSON, if present
- `getDebug()` -> response headers

Wrappers
--------

[](#wrappers)

Two wrappers are available: `PromisePay::getAllResults()` and `PromisePay::getAllResultsAsync()`. They can be used to get all results from sets of result pages, instead of up to 200 per request. For example, they can be used to fetch all batch transactions at once. Note that these requests may take some time depending on amount requested. If getting all results is mandatory, no matter how big the size, use the synchronous version. For a faster version, use async version, but not all requests are guaranteed to be returned. Generally, asynchronous execution is fine for up to 20 pages, each containing up to 200 results, yielding 4000 results within a few seconds.

Synchronous execution

```
$batchedTransactionsList = PromisePay::getAllResults(function($limit, $offset) {
    PromisePay::BatchTransactions()->listTransactions(
        array(
            'limit' => $limit,
            'offset' => $offset
        )
    );
});
```

Asynchronous execution

```
$batchedTransactionsList = PromisePay::getAllResultsAsync(function($limit, $offset) {
    PromisePay::BatchTransactions()->listTransactions(
        array(
            'limit' => $limit,
            'offset' => $offset
        )
    );
});
```

Contributing
============

[](#contributing)

```
1. Fork it ( https://github.com/PromisePay/promisepay-php/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request

```

###  Health Score

41

—

FairBetter than 89% of packages

Maintenance13

Infrequent updates — may be unmaintained

Popularity45

Moderate usage in the ecosystem

Community23

Small or concentrated contributor base

Maturity68

Established project with proven stability

 Bus Factor1

Top contributor holds 79.5% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~40 days

Recently: every ~7 days

Total

20

Last Release

3184d ago

Major Versions

v1.0.8 → v2.0.02015-11-10

### Community

Maintainers

![](https://www.gravatar.com/avatar/ea6fdbc0bd9bdd4682b8e557523bc7f24a349a2c97514f1cbd7d50bdb9a1254d?d=identicon)[maccca](/maintainers/maccca)

---

Top Contributors

[![NinoSkopac](https://avatars.githubusercontent.com/u/1783732?v=4)](https://github.com/NinoSkopac "NinoSkopac (263 commits)")[![MVmironov](https://avatars.githubusercontent.com/u/12662244?v=4)](https://github.com/MVmironov "MVmironov (32 commits)")[![dannyshafer](https://avatars.githubusercontent.com/u/7267702?v=4)](https://github.com/dannyshafer "dannyshafer (16 commits)")[![gjorgic](https://avatars.githubusercontent.com/u/3842488?v=4)](https://github.com/gjorgic "gjorgic (11 commits)")[![jeandee](https://avatars.githubusercontent.com/u/20100596?v=4)](https://github.com/jeandee "jeandee (6 commits)")[![webden](https://avatars.githubusercontent.com/u/9258611?v=4)](https://github.com/webden "webden (2 commits)")[![gitter-badger](https://avatars.githubusercontent.com/u/8518239?v=4)](https://github.com/gitter-badger "gitter-badger (1 commits)")

---

Tags

platformsapipaymentsmarketplaceescrowpromisepaymarketplace payments

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/promisepay-promisepay-php/health.svg)

```
[![Health](https://phpackages.com/badges/promisepay-promisepay-php/health.svg)](https://phpackages.com/packages/promisepay-promisepay-php)
```

###  Alternatives

[balanced/balanced

Client for Balanced API

72372.9k](/packages/balanced-balanced)[transbank/transbank-sdk

Transbank SDK

62626.4k12](/packages/transbank-transbank-sdk)[maksekeskus/maksekeskus-php

Maksekeskus PHP SDK

12179.8k](/packages/maksekeskus-maksekeskus-php)[samerior/mobile-money

Mobile payments API - Kenya

252.3k](/packages/samerior-mobile-money)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)