Api/CustomerApi

Customer API Reference

// Set your API Keys 👇 here
$sdk = new \Tatum\Sdk();

// MainNet API Call
$sdk->mainnet()->api()->customer();

// TestNet API Call
$sdk->testnet()->api()->customer();

Methods

Method	Description
activateCustomer()	Activate customer
deactivateCustomer()	Deactivate customer
disableCustomer()	Disable customer
enableCustomer()	Enable customer
findAllCustomers()	List all customers
getCustomerByExternalOrInternalId()	Get customer details
updateCustomer()	Update customer

`activateCustomer()`

Example

#️⃣ Execute command in terminal

✨ php -f activateCustomer.php

Request

PUT /v3/ledger/customer/{id}/activate

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->customer()->activateCustomer(
    string $id
)

Parameters

Name	Type	Description	Notes
$id	string	Customer internal ID

Return type

void (empty response body)

Description

Activate customer

2 credits per API call.

Activated customer is able to do any operation.

`deactivateCustomer()`

Example

#️⃣ Execute command in terminal

✨ php -f deactivateCustomer.php

Request

PUT /v3/ledger/customer/{id}/deactivate

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->customer()->deactivateCustomer(
    string $id
)

Parameters

Name	Type	Description	Notes
$id	string	Customer internal ID

Return type

void (empty response body)

Description

Deactivate customer

2 credits per API call.

Deactivate customer is not able to do any operation. Customer can be deactivated only when all their accounts are already deactivated.

`disableCustomer()`

Example

#️⃣ Execute command in terminal

✨ php -f disableCustomer.php

Request

PUT /v3/ledger/customer/{id}/disable

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->customer()->disableCustomer(
    string $id
)

Parameters

Name	Type	Description	Notes
$id	string	Customer internal ID

Return type

void (empty response body)

Description

Disable customer

2 credits per API call.

Disabled customer cannot perform end-user operations, such as create new accounts or send transactions. Available balance on all accounts is set to 0. Account balance will stay untouched.

`enableCustomer()`

Example

#️⃣ Execute command in terminal

✨ php -f enableCustomer.php

Request

PUT /v3/ledger/customer/{id}/enable

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->customer()->enableCustomer(
    string $id
)

Parameters

Name	Type	Description	Notes
$id	string	Customer internal ID

Return type

void (empty response body)

Description

Enable customer

2 credits per API call.

Enabled customer can perform all operations. By default all customers are enabled. All previously blocked account balances will be unblocked.

`findAllCustomers()`

Example

#️⃣ Execute command in terminal

✨ php -f findAllCustomers.php

Request

GET /v3/ledger/customer

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->customer()->findAllCustomers(
    float $page_size,
    [ float $offset ]
): \Tatum\Model\Customer[]

Parameters

Name	Type	Description	Notes
$page_size	float	Max number of items per page is 50.
$offset	float	Offset to obtain next page of the data.	[optional]

Return type

\Tatum\Model\Customer[]

Description

List all customers

1 credit per API call.

List of all customers. Also inactive an disabled customers are present.

`getCustomerByExternalOrInternalId()`

Example

#️⃣ Execute command in terminal

✨ php -f getCustomerByExternalOrInternalId.php

Request

GET /v3/ledger/customer/{id}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->customer()->getCustomerByExternalOrInternalId(
    string $id
): \Tatum\Model\Customer

Parameters

Name	Type	Description	Notes
$id	string	Customer external or internal ID

Return type

\Tatum\Model\Customer

Description

Get customer details

1 credit per API call.

Using anonymized external ID or internal customer ID you can access customer detail information. Internal ID is needed to call other customer related methods.

`updateCustomer()`

Example

#️⃣ Execute command in terminal

✨ php -f updateCustomer.php

Request

PUT /v3/ledger/customer/{id}

Type signature

(new \Tatum\Sdk())->{mainnet/testnet}()->api()->customer()->updateCustomer(
    string $id,
    \Tatum\Model\CustomerUpdate $customer_update
): \Tatum\Model\Customer

Parameters

Name	Type	Description	Notes
$id	string	Customer internal ID
$customer_update	\Tatum\Model\CustomerUpdate

Return type

\Tatum\Model\Customer

Description

Update customer

2 credits per API call.

This method is helpful in case your primary system will change ID’s or customer will change the country he/she is supposed to be in compliance with.