Skip to content

Latest commit

 

History

History
155 lines (110 loc) · 5.65 KB

DisputeApi.md

File metadata and controls

155 lines (110 loc) · 5.65 KB

Elepay\DisputeApi

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

Method HTTP request Description
listDisputes() GET /disputes List disputes
retrieveDispute() GET /disputes/{id} Retrieve dispute

listDisputes()

listDisputes($chargeId, $from, $to, $dateField, $status, $limit, $offset, $sort, $order): \Elepay\Model\DisputesResponse

List disputes

不審請求情報を一覧で取得します

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\DisputeApi(
    // 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
);
$chargeId = 'chargeId_example'; // string | Charge ID
$from = 56; // int | 開始時間（UTC）。指定した時間以降に作成されたデータを取得します。
$to = 56; // int | 終了時間（UTC）。指定した時間以前に作成されたデータを取得します
$dateField = new \Elepay\Model\DisputeDateTimeType(); // DisputeDateTimeType | 開始時間と終了時間の項目を指定します。 - resolved_time 不審請求解決時間 - create_time 不審請求発生時間
$status = new \Elepay\Model\DisputeStatusType(); // DisputeStatusType | 不審請求ステータス
$limit = 20; // int | 最大件数
$offset = 0; // int | 検索開始位置
$sort = new \Elepay\Model\DisputeDateTimeType(); // DisputeDateTimeType | ソート項目 - resolved_time 不審請求解決時間 - create_time 決済新規時間
$order = new \Elepay\Model\SortOrderType(); // SortOrderType | ソート順 - desc 降順 - asc 昇順

try {
    $result = $apiInstance->listDisputes($chargeId, $from, $to, $dateField, $status, $limit, $offset, $sort, $order);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling DisputeApi->listDisputes: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
chargeId string Charge ID [optional]
from int 開始時間（UTC）。指定した時間以降に作成されたデータを取得します。 [optional]
to int 終了時間（UTC）。指定した時間以前に作成されたデータを取得します [optional]
dateField DisputeDateTimeType 開始時間と終了時間の項目を指定します。 - resolved_time 不審請求解決時間 - create_time 不審請求発生時間 [optional]
status DisputeStatusType 不審請求ステータス [optional]
limit int 最大件数 [optional] [default to 20]
offset int 検索開始位置 [optional] [default to 0]
sort DisputeDateTimeType ソート項目 - resolved_time 不審請求解決時間 - create_time 決済新規時間 [optional]
order SortOrderType ソート順 - desc 降順 - asc 昇順 [optional]

Return type

\Elepay\Model\DisputesResponse

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]

retrieveDispute()

retrieveDispute($id): \Elepay\Model\DisputeDto

Retrieve dispute

不審請求に関する詳細情報を取得します。

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\DisputeApi(
    // 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
);
$id = 'id_example'; // string | Dispute ID

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

Parameters

Name Type Description Notes
id string Dispute ID

Return type

\Elepay\Model\DisputeDto

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]