PHPackages                             zumcoin/zumservices-api-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. zumcoin/zumservices-api-php

ActiveLibrary[API Development](/categories/api)

zumcoin/zumservices-api-php
===========================

PHP wrapper for ZUM Services RESTFUL API.

00[2 PRs](https://github.com/zum-services/zumservices-api-php/pulls)PHP

Since Sep 26Pushed 3y agoCompare

[ Source](https://github.com/zum-services/zumservices-api-php)[ Packagist](https://packagist.org/packages/zumcoin/zumservices-api-php)[ RSS](/packages/zumcoin-zumservices-api-php/feed)WikiDiscussions master Synced yesterday

READMEChangelogDependenciesVersions (3)Used By (0)

[![](https://raw.githubusercontent.com/zumcoin/zum-assets/master/ZumCoin/zumcoin_logo_design/3d_green_lite_bg/ZumLogo_800x200px_lite_bg.png)](https://raw.githubusercontent.com/zumcoin/zum-assets/master/ZumCoin/zumcoin_logo_design/3d_green_lite_bg/ZumLogo_800x200px_lite_bg.png)

ZUM Service PHP API Interface
=============================

[](#zum-service-php-api-interface)

This wrapper allows you to easily interact with the [ZUM Services](https://zum.services) 1.0.1 API to quickly develop applications that interact with the [ZumCoin](https://zumcoin.org) Network.

Table of Contents
=================

[](#table-of-contents)

1. [Installation](#installation)
2. [Intialization](#intialization)
3. [Documentation](#documentation)
4. [Methods](#methods)

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

[](#installation)

```
composer require zumcoin/zumservices-api-php
```

Intialization
=============

[](#intialization)

```
use ZUMservices\ZUMservices;

$config = [
    'token' => 'eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoidGVzdCIsImFwcElkIjo0LCJ1c2VySWQiOjYsInBlcm1pc3Npb25zIjpbImFkZHJlc3M6bmV3Il0sImlhdCI6MTUzNjU4NTM2NywiZXhwIjoxNTM5MTc3MzY3LCJhdWQiOiJ0dXJ0bGV3YWxsZXQuaW8iLCJpc3MiOiJUUlRMIFNlcnZpY2VzIiwianRpIjoiMzMifQ.AEHXmvTo8RfNuZ15Y3IGPRhZPaJxFSmOZvVv2YGN9L4We7bXslIPxhMv_n_5cNW8sIgE2Fr-46OTb5H5AFgpjA',
    'timeout' => 2000
];

$ZS = new ZUMservices($config);
```

Reponse Formattng
-----------------

[](#reponse-formattng)

```
// The result field from the RPC response
$response->result();

// RPC response as JSON string
$response->toJson();

// RPC response as an array
$response->toArray();
```

Documentation
=============

[](#documentation)

API documentation is available at

Methods
-------

[](#methods)

### createAddress()

[](#createaddress)

Create a new ZUM addresses

```
$ZS->createAddress()
```

### getAddress(address)

[](#getaddressaddress)

Get address details by address

```
$ZS->getAddress("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC")
```

### deleteAddress(address)

[](#deleteaddressaddress)

Delete a selected ZUM addresses

```
$ZS->deleteAdddress("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC")
```

### getAddresses()

[](#getaddresses)

View all addresses.

```
$ZS->getAddresses()
```

### scanAddress(address, blockIndex)

[](#scanaddressaddress-blockindex)

Scan an address for transactions between a 100 block range starting from the specified blockIndex.

```
$ZS->scanAddress("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC", 899093)
```

### getAddressKeys(address)

[](#getaddresskeysaddress)

Get the public and secret spend key of an address.

```
$ZS->getAddressKeys("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC")
```

### integrateAddress(address, paymentId)

[](#integrateaddressaddress-paymentid)

Create an integrated address with an address and payment ID.

```
$ZS->integrateAddress("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC", "7d89a2d16365a1198c46db5bbe1af03d2b503a06404f39496d1d94a0a46f8804")
```

### getIntegratedAddresses(address)

[](#getintegratedaddressesaddress)

Get all integrated addresses by address.

```
$ZS->getIntegratedAddresses("Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC")
```

### getFee(amount)

[](#getfeeamount)

Calculate the ZUM Services fee for an amount specified in ZUM with two decimal points.

```
$ZS->getFee(123.45)
```

### createTransfer(sender, receiver, amount, fee, paymentId, extra)

[](#createtransfersender-receiver-amount-fee-paymentid-extra)

Send a ZUM transaction with an address with the amount specified two decimal points.

```
$ZS->createTransfer(
  "Zum1yfSrdpfiSNG5CtYmckgpGe1FiAc9gLCEZxKq29puNCX92DUkFYFfEGKugPS6EhWaJXmhAzhePGs3jXvNgK4NbWXG4yaGBHC",
  "Zum1yhbRwHsXj19c1hZgFzgxVcWDywsJcDKURDud83MqMNKoDTvKEDf6k7BoHnfCiPbj4kY2arEmQTwiVmhoELPv3UKhjYjCMcm",
  1234.56,
  1.23,
  "7d89a2d16365a1198c46db5bbe1af03d2b503a06404f39496d1d94a0a46f8804",
  "3938f915a11582f62d93f82f710df9203a029f929fd2f915f2701d947f920f99"
)
```

#### You can leave the last two fields (paymentId and extra) blank.

[](#you-can-leave-the-last-two-fields-paymentid-and-extra-blank)

### getTransfer(address)

[](#gettransferaddress)

Get a transaction details specified by transaction hash.

```
$ZS->getTransfer("EohMUzR1DELyeQM9RVVwpmn5Y1DP0lh1b1ZpLQrfXQsgtvGHnDdJSG31nX2yESYZ")
```

### getWallet()

[](#getwallet)

Get wallet container info and health check.

```
$ZS->getWallet()
```

### getStatus()

[](#getstatus)

Get the current status of the ZUM Services infrastructure.

```
$ZS->getStatus()
```

License
=======

[](#license)

```
Copyright (C) 2019 ZumCoin Development Team

Please see the included LICENSE file for more information.

```

###  Health Score

18

—

LowBetter than 8% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity0

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity39

Early-stage or recently created project

 Bus Factor1

Top contributor holds 100% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/70ccfee618231155f380e44f6244a32dc824e2670a29519974ae223a41c8ef8f?d=identicon)[CodingRonin](/maintainers/CodingRonin)

---

Top Contributors

[![zumdevs](https://avatars.githubusercontent.com/u/38582941?v=4)](https://github.com/zumdevs "zumdevs (3 commits)")

### Embed Badge

![Health badge](/badges/zumcoin-zumservices-api-php/health.svg)

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

###  Alternatives

[stripe/stripe-php

Stripe PHP Library

4.0k143.3M480](/packages/stripe-stripe-php)[twilio/sdk

A PHP wrapper for Twilio's API

1.6k92.9M272](/packages/twilio-sdk)[knplabs/github-api

GitHub API v3 client

2.2k15.8M187](/packages/knplabs-github-api)[facebook/php-business-sdk

PHP SDK for Facebook Business

90121.9M34](/packages/facebook-php-business-sdk)[meilisearch/meilisearch-php

PHP wrapper for the Meilisearch API

73813.7M114](/packages/meilisearch-meilisearch-php)[google/gax

Google API Core for PHP

263103.1M454](/packages/google-gax)

PHPackages © 2026

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