transferwise/wise-php

Wise PHP Library

v0.2.1 2022-06-03 10:56 UTC

Requires

• php: >=5.6.0
• guzzlehttp/guzzle: >=6.3

Requires (Dev)

• phpunit/phpunit: ^9.5

MIT

• Albert Xhani

README

This library is written to accomodate the wise API's use in php projects With Wise you can automate payments, connect your business tools, and create ways to manage your finances. You can also power your cross-border and domestic payouts. For more info have a look at https://wise.com/ and https://api-docs.wise.com/

Requirements

• PHP 5.6.0 and later.
• cURL

Install

To install the package use the composer command

composer require transferwise/wise-php

Sample Code

Initialing Client

$client = new \TransferWise\Client(
    [
         "token" => "WISE_TOKEN",
         "profile_id" => "WISE_PROFILE_ID",
         "env" => "sandbox" // optional
    ]
);

Creating a recipient account

$client->recipient_accounts->create(
    [
        "accountHolderName" => "John Snow",
        "currency" => "EUR",
        "type" => "iban",
            "details" => [
                "legalType" => "PRIVATE",
                "IBAN" => "GBFSDFS546S5DF46S5"
        ]
    ]
);

Validating Iban

$client->validators->iban($iban);

Creating Quote

$client->quotes->create(
    [
        "sourceCurrency" => "EUR",
        "targetCurrency" => "GBP",
        "sourceAmount" => "100.00",
        "targetAmount" => null
    ]
);

Creating transfer

$client->transfers->create(
    [
        "targetAccount" => "account id",
        "quoteUuid" => "generated quote id",
        "customerTransactionId" => "transaction id",
        "details" => [
            "reference" => "Company X",
            "transferPurpose"=> "verification.transfers.purpose.pay.bills",
            "sourceOfFunds"=> "verification.source.of.funds.other"
        ]
    ]
);

Resources

Recipient Account

Recipient is a person or institution who is the ultimate beneficiary of your payment.

Available Methods

$client->recipient_accounts->create();
$client->recipient_accounts->all();
$client->recipient_accounts->retrieve();
$client->recipient_accounts->delete();

Quote

The quote resource defines the basic information required for a Wise transfer - the currencies to send between, the amount to send and the profile who is sending the money.

Available Methods

$client->quotes->create();
$client->quotes->temporary();
$client->quotes->update();
$client->quotes->retrieve();

Transfer

A transfer is a payment order to recipient account based on a quote. Once created, a transfer needs to be funded within the next five working days. Otherwise, it will be automatically canceled.

Available Methods

$client->transfers->create();
$client->transfers->requirements();
$client->transfers->fund();
$client->transfers->cancel();
$client->transfers->retrieve();
$client->transfers->issues();
$client->transfers->list();

Validator

Validate different types of bank details with this resource like IBAN, Sort Code, account number etc

Available Methods

$client->validators->sortcode();
$client->validators->accountNo();
$client->validators->iban();
$client->validators->ibanandbic();
$client->validators->aba();
$client->validators->abaAccountNo();
$client->validators->ifsc();
$client->validators->banks();
$client->validators->branch();

Profile

Manage wise user profiles with this resource

Available Methods

$client->profiles->create();
$client->profiles->update();
$client->profiles->all();
$client->profiles->retrieve();
$client->profiles->directors();
$client->profiles->addDirector();
$client->profiles->addIdentificationDocument();

The documentation is a work in progress and will be updated with more details of to use each resource together with a guideline and examples