v2

latestOpenAPI 3.1.02026-07-262279731.3 MB
Refunds

List Refunds for a PayIn

List Refunds for a PayIn

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

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

Statusstring

Allowed values: CREATED, SUCCEEDED, FAILED

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

ResultCodestring

The code indicating the result of the operation. You can filter on multiple values by separating them with a comma.

BeforeDateinteger

The date before which the transaction was created (based on the transaction'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 transaction was created (based on the transaction's CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

Headers

Authorizationstring required

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Response

Success