Elepay\CustomerApi

All URIs are relative to https://api.elepay.io, except if the operation defines another base path.

Method	HTTP request	Description
createCustomer()	POST /customers	Create customer
createSource()	POST /customers/{customerId}/sources	Create source
deleteCustomer()	DELETE /customers/{customerId}	Delete customer
deleteSource()	DELETE /customers/{customerId}/sources/{sourceId}	Delete source
listCustomers()	GET /customers	List customers
listSources()	GET /customers/{customerId}/sources	List sources by customer ID
retrieveCustomer()	GET /customers/{customerId}	Retrieve customer
retrieveSource()	GET /customers/{customerId}/sources/{sourceId}	Retrieve source
retrieveSourceStatus()	GET /sources/{sourceId}/status	Retrieve source's status
updateCustomer()	POST /customers/{customerId}	Update customer

`createCustomer()`

createCustomer($customerReq): \Elepay\Model\CustomerDto

Create customer

カスタマを作成します。

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Elepay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: bearerAuth
$config = Elepay\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Elepay\Api\CustomerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerReq = new \Elepay\Model\CustomerReq(); // \Elepay\Model\CustomerReq | カスタマリクエスト

try {
    $result = $apiInstance->createCustomer($customerReq);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->createCustomer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
customerReq	\Elepay\Model\CustomerReq	カスタマリクエスト

Return type

\Elepay\Model\CustomerDto

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`createSource()`

createSource($customerId, $sourceReq): \Elepay\Model\SourceDto

Create source

カスタマソースを作成します。

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Elepay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: bearerAuth
$config = Elepay\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Elepay\Api\CustomerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 'customerId_example'; // string | Customer ID
$sourceReq = new \Elepay\Model\SourceReq(); // \Elepay\Model\SourceReq | カスタマソースリクエスト

try {
    $result = $apiInstance->createSource($customerId, $sourceReq);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->createSource: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
customerId	string	Customer ID
sourceReq	\Elepay\Model\SourceReq	カスタマソースリクエスト

Return type

\Elepay\Model\SourceDto

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteCustomer()`

deleteCustomer($customerId)

Delete customer

カスタマを削除します

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Elepay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: bearerAuth
$config = Elepay\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Elepay\Api\CustomerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 'customerId_example'; // string | Customer ID

try {
    $apiInstance->deleteCustomer($customerId);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->deleteCustomer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
customerId	string	Customer ID

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`deleteSource()`

deleteSource($customerId, $sourceId)

Delete source

カスタマソースを削除します。

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Elepay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: bearerAuth
$config = Elepay\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Elepay\Api\CustomerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 'customerId_example'; // string | Customer ID
$sourceId = 'sourceId_example'; // string | Source ID

try {
    $apiInstance->deleteSource($customerId, $sourceId);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->deleteSource: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
customerId	string	Customer ID
sourceId	string	Source ID

Return type

void (empty response body)

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: Not defined

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listCustomers()`

listCustomers($keyword, $limit, $offset): \Elepay\Model\CustomerResponse

List customers

カスタマ情報を一覧で取得します。

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Elepay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: bearerAuth
$config = Elepay\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Elepay\Api\CustomerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$keyword = 'keyword_example'; // string | キーワード
$limit = 20; // int | 最大件数
$offset = 0; // int | 検索開始位置

try {
    $result = $apiInstance->listCustomers($keyword, $limit, $offset);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->listCustomers: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
keyword	string	キーワード	[optional]
limit	int	最大件数	[optional] [default to 20]
offset	int	検索開始位置	[optional] [default to 0]

Return type

\Elepay\Model\CustomerResponse

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`listSources()`

listSources($customerId, $paymentMethod): \Elepay\Model\SourceResponse

List sources by customer ID

カスタマソース情報を一覧で取得します。

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Elepay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: bearerAuth
$config = Elepay\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Elepay\Api\CustomerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 'customerId_example'; // string | Customer ID
$paymentMethod = new \Elepay\Model\PaymentMethodType(); // PaymentMethodType | 決済方法

try {
    $result = $apiInstance->listSources($customerId, $paymentMethod);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->listSources: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
customerId	string	Customer ID
paymentMethod	PaymentMethodType	決済方法	[optional]

Return type

\Elepay\Model\SourceResponse

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`retrieveCustomer()`

retrieveCustomer($customerId): \Elepay\Model\CustomerDto

Retrieve customer

カスタマ情報を取得します。

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Elepay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: bearerAuth
$config = Elepay\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Elepay\Api\CustomerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 'customerId_example'; // string | Customer ID

try {
    $result = $apiInstance->retrieveCustomer($customerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->retrieveCustomer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
customerId	string	Customer ID

Return type

\Elepay\Model\CustomerDto

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`retrieveSource()`

retrieveSource($customerId, $sourceId): \Elepay\Model\SourceDto

Retrieve source

カスタマ情報を取得します。

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Elepay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: bearerAuth
$config = Elepay\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Elepay\Api\CustomerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 'customerId_example'; // string | Customer ID
$sourceId = 'sourceId_example'; // string | Source ID

try {
    $result = $apiInstance->retrieveSource($customerId, $sourceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->retrieveSource: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
customerId	string	Customer ID
sourceId	string	Source ID

Return type

\Elepay\Model\SourceDto

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`retrieveSourceStatus()`

retrieveSourceStatus($sourceId): \Elepay\Model\SourceStatusDto

Retrieve source's status

カスタマソースのステータスに関する詳細情報を取得します。

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Elepay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: bearerAuth
$config = Elepay\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Elepay\Api\CustomerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$sourceId = 'sourceId_example'; // string | Source ID

try {
    $result = $apiInstance->retrieveSourceStatus($sourceId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->retrieveSourceStatus: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
sourceId	string	Source ID

Return type

\Elepay\Model\SourceStatusDto

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: Not defined
Accept: application/json;charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

`updateCustomer()`

updateCustomer($customerId, $customerReq): \Elepay\Model\CustomerDto

Update customer

カスタマを更新します。

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: basicAuth
$config = Elepay\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure Bearer authorization: bearerAuth
$config = Elepay\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Elepay\Api\CustomerApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$customerId = 'customerId_example'; // string | Customer ID
$customerReq = new \Elepay\Model\CustomerReq(); // \Elepay\Model\CustomerReq | カスタマリクエスト

try {
    $result = $apiInstance->updateCustomer($customerId, $customerReq);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CustomerApi->updateCustomer: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name	Type	Description	Notes
customerId	string	Customer ID
customerReq	\Elepay\Model\CustomerReq	カスタマリクエスト

Return type

\Elepay\Model\CustomerDto

Authorization

basicAuth, bearerAuth

HTTP request headers

Content-Type: application/json;charset=utf-8
Accept: application/json;charset=utf-8

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

CustomerApi.md

Latest commit

History

CustomerApi.md

File metadata and controls

Elepay\CustomerApi

createCustomer()

Example

Parameters

Return type

Authorization

HTTP request headers

createSource()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteCustomer()

Example

Parameters

Return type

Authorization

HTTP request headers

deleteSource()

Example

Parameters

Return type

Authorization

HTTP request headers

listCustomers()

Example

Parameters

Return type

Authorization

HTTP request headers

listSources()

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveCustomer()

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveSource()

Example

Parameters

Return type

Authorization

HTTP request headers

retrieveSourceStatus()

Example

Parameters

Return type

Authorization

HTTP request headers

updateCustomer()

Example

Parameters

Return type

Authorization

HTTP request headers

`createCustomer()`

`createSource()`

`deleteCustomer()`

`deleteSource()`

`listCustomers()`

`listSources()`

`retrieveCustomer()`

`retrieveSource()`

`retrieveSourceStatus()`

`updateCustomer()`