Skip to content

Latest commit

 

History

History
88 lines (57 loc) · 1.89 KB

Disputes.md

File metadata and controls

88 lines (57 loc) · 1.89 KB

Disputes

A list of all methods in the Disputes service. Click on the method name to view detailed information about that method.

Methods Description
list_disputes
get_dispute_handler

list_disputes

  • HTTP Method: GET
  • Endpoint: /disputes

Parameters

Name Type Required Description
$createdAtGte string Get events after this created time
$createdAtLte string Get events created before this time
$pageSize int Page size default is 10 max is 100
$pageNumber int Page number default is 0
$disputeStatus Models\DisputeStatus Filter by dispute status
$disputeStage Models\DisputeStage Filter by dispute stage

Return Type

Models\GetDisputesListResponse

Example Usage Code Snippet

<?php

use Dodopayments\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$disputeStatus = Models\DisputeStatus::DisputeOpened;
$disputeStage = Models\DisputeStage::PreDispute;

$response = $sdk->disputes->listDisputes(
  createdAtGte: "created_at_gte",
  createdAtLte: "created_at_lte",
  pageSize: 9,
  pageNumber: 8,
  disputeStatus: $disputeStatus,
  disputeStage: $disputeStage
);

print_r($response);

get_dispute_handler

  • HTTP Method: GET
  • Endpoint: /disputes/{dispute_id}

Parameters

Name Type Required Description
$disputeId string Dispute Id

Return Type

Models\DisputeResponse

Example Usage Code Snippet

<?php

use Dodopayments\Client;

$sdk = new Client(accessToken: 'YOUR_TOKEN');

$response = $sdk->disputes->getDisputeHandler(
  disputeId: "dispute_id"
);

print_r($response);