transferwise-php/sdk

PHP binding for TransferWise API v1

dev-master 2020-03-16 02:54 UTC

Requires

• php: ^7.2.5
• ext-json: *
• guzzlehttp/guzzle: ^6.2

Requires (Dev)

• friendsofphp/php-cs-fixer: ^2.17@dev
• phpunit/phpunit: 8.5.x-dev

BSD-3-Clause

• Ha Phan

README

Note: This library is under active development as we expand it to cover our (expanding!) API. Consider the public API of this package a little unstable as we work towards a v1.0.

Installation

The recommended way to install this package is via the Packagist Dependency Manager (transferwise-php/sdk).

TransferWise API version 1

The TransferWise API can be found here.

• Addresses
• Borderless Accounts
• Get Account Balance
• Get Account Statement
• Convert Currencies
• Get Available Currencies
• Get Currency Pairs
• Comparison
• Exchange Rates
• Quotes (Works in progress)
• Recipient Accounts
• Simulation
• Terms and Conditions
• Transfers
• Users (Works in progress)
• User Profiles

Note that this repository is currently under development, additional classes and endpoints being actively added.

Getting Started

<?php 
require 'vendor/autoload.php';

use TransferWise\SDK;

$apiKey = 'your-api-key-here';
$client = SDK::createClient($apiKey, SDK::API_MODE_SANDBOX);
$sdk = new SDK($client);

// Show current authenticated user
/** @var \TransferWise\Model\Token $whoami */
$whoami = $sdk->users()->me();

// List transfers
$transfers = $sdk->transfers()->list(['status' => 'funds_refunded']);

Contributions

We welcome community contribution to this repository. CONTRIBUTING.md will help you start contributing.

Licensing

Licensed under the 3-clause BSD license. See the LICENSE file for details.