Disputes

List Disputes for a PayIn

Changed on

List Disputes for a PayIn

get/v2.01/{ClientId}/payins/{PayInId}/disputes

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/payins/{PayInId}/disputes
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

Platform's API account identifier, associated with the API key.

PayInIdstring required

The unique identifier of the pay-in.

Query parameters

BeforeDateinteger

The date before which the object was created (based on the object's CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDateinteger

The date after which the object was created (based on the object's CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

Statusstring

Allowed values: CREATED, PENDING_CLIENT_ACTION, SUBMITTED, PENDING_BANK_ACTION, CLOSED, REOPENED_PENDING_CLIENT_ACTION

The status of the Dispute. You can filter on multiple values by separating them with a comma.

DisputeTypestring

Allowed values: CONTESTABLE, NOT_CONTESTABLE, RETRIEVAL

The type of the Dispute. You can filter on multiple values by separating them with a comma.

Response

Success

Changes

  • f44a59c76515Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security oauth2 was added to the API

  • 8e731ec4a85bRevision changes
    • info

      api operation id list_disputes_payin removed and replaced with disputes_list_disputes_payin