RefundsRefunds

List Refunds for a Payout

List Refunds for a Payout

This call returns the refund for a payout, which is known as a payout return or return of funds.

A payout return is only generated by Mangopay. For more information, see the payout returns guide.

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.
PayoutIdstringRequired
The unique identifier of the payout.

Query parameters

StatusstringOptional

Allowed values: CREATED, SUCCEEDED, FAILED

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

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

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.

AfterDateintegerOptional

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.

Response

Success
Array (Refunds)list of objects
The list of payout refunds created for the platform.