An endpoint used to handle customer operations, like updating customer information, enabling/disabling etc.
Within Tatum API, a customer represents a client of the entity that communicates with Tatum.
Customers cannot be created via any other operation than Create Ledger Account.
Due to compliance restrictions, it is recommended to enter the country of residence of the customer and the country of the provider. The Tatum compliance engine operates based on this information.
List all customers
1 credit per API call.
List of all customers. Also inactive an disabled customers are present.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Internal server error. There was an error on the server while processing the request.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Go
- PHP
- Ruby
- 200
- 400
- 401
- 500
[- {
- "externalId": "651234",
- "id": "5e68c66581f2ee32bc354087",
- "enabled": true,
- "active": true,
- "accountingCurrency": "AED",
- "customerCountry": "US",
- "providerCountry": "US"
}
]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.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Go
- PHP
- Ruby
- 200
- 400
- 401
- 403
- 500
{- "externalId": "651234",
- "id": "5e68c66581f2ee32bc354087",
- "enabled": true,
- "active": true,
- "accountingCurrency": "AED",
- "customerCountry": "US",
- "providerCountry": "US"
}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.
Request Body schema: application/json
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
- Payload
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Go
- PHP
- Ruby
{- "externalId": "123654"
}- 200
- 400
- 401
- 403
- 500
{- "externalId": "651234",
- "id": "5e68c66581f2ee32bc354087",
- "enabled": true,
- "active": true,
- "accountingCurrency": "AED",
- "customerCountry": "US",
- "providerCountry": "US"
}Activate customer
2 credits per API call.
Activated customer is able to do any operation.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Go
- PHP
- Ruby
- 400
- 401
- 403
- 500
{- "errorCode": "validation.failed",
- "message": "Request validation failed. Please see data for additional information.",
- "statusCode": 400,
- "data": [
- {
- "target": {
- "property": 12345
}, - "value": 12345,
- "property": "property1",
- "constraints": {
- "min": "property1 must not be less than 50000"
}
}
]
}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.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Go
- PHP
- Ruby
- 400
- 401
- 403
- 500
{- "errorCode": "validation.failed",
- "message": "Request validation failed. Please see data for additional information.",
- "statusCode": 400,
- "data": [
- {
- "target": {
- "property": 12345
}, - "value": 12345,
- "property": "property1",
- "constraints": {
- "min": "property1 must not be less than 50000"
}
}
]
}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.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Go
- PHP
- Ruby
- 400
- 401
- 403
- 500
{- "errorCode": "validation.failed",
- "message": "Request validation failed. Please see data for additional information.",
- "statusCode": 400,
- "data": [
- {
- "target": {
- "property": 12345
}, - "value": 12345,
- "property": "property1",
- "constraints": {
- "min": "property1 must not be less than 50000"
}
}
]
}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.
OK
Bad Request. Validation failed for the given object in the HTTP Body or Request parameters.
Unauthorized. Not valid or inactive subscription key present in the HTTP Header.
Forbidden. The request is authenticated, but it is not possible to required perform operation due to logical error or invalid permissions.
Internal server error. There was an error on the server while processing the request.
- curl
- Node.js
- JavaScript
- Python
- C#
- Java
- Go
- PHP
- Ruby
- 400
- 401
- 403
- 500
{- "errorCode": "validation.failed",
- "message": "Request validation failed. Please see data for additional information.",
- "statusCode": 400,
- "data": [
- {
- "target": {
- "property": 12345
}, - "value": 12345,
- "property": "property1",
- "constraints": {
- "min": "property1 must not be less than 50000"
}
}
]
}