List Disputes for a PayIn

List Disputes for a PayIn

Authentication

AuthorizationBearer
Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

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

The unique identifier of the pay-in.

Query parameters

BeforeDateintegerOptional

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.

AfterDateintegerOptional

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.

StatusstringOptional

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.

DisputeTypestringOptional

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
Array (Disputes)list of objects
The list of disputes automatically created by Mangopay.