A PHP wrapper for ACH Banking's API

1.1.5 2023-09-18 09:13 UTC

This package is auto-updated.

Last update: 2024-05-18 10:37:50 UTC


README

Installation

You can install achbanking-php via composer or by downloading the source.

Via Composer:

achbanking-php is available on Packagist as the achbanking/sdk package:

composer require achbanking/sdk

Quickstart

Endpoint URL Details
Sandbox https://dev.achbanking.com/api/ Has IP restrictions
Production https://achbanking.com/api/

Connect

// Via constructor
<?php

$client = new \AchBanking\Sdk\Client(
    'API_TOKEN', // from the site
    'API_KEY', // from the site
    'ENDPOINT_URL'
);
// Or set credentials later
<?php

$client = new \AchBanking\Sdk\Client();
$client->useCredentials(
    'API_TOKEN',
    'API_KEY',
    'ENDPOINT_URL'
);

Make API request

<?php

$result = $client->methodName([
    'param1' => 'value1',
    'param2' => 'value2',
    'param3' => 'value3',
]);

// or
$object = new \stdClass();
$object->param1 = 'value1';
$object->param2 = 'value2';
$object->param3 = 'value3';

$result = $client->methodName($object);

Full list of available requests HERE.

Example

<?php

// get payment profile by ID
$paymentProfile = $client->getPaymentProfile([
    'payment_profile_id' => 'payment-profile-id',
]);

// modify the email address
$paymentProfile->payment_profile_email_address = 'email@example.com';

// and save it
$result = $client->savePaymentProfile($paymentProfile);