Refunds

List Refunds for a Payout

Changed on

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.

get/v2.01/{ClientId}/payouts/{PayoutId}/refunds

Request

  • Base URL
    https://api.sandbox.mangopay.com
  • URL
    https://api.sandbox.mangopay.com/v2.01/{ClientId}/payouts/{PayoutId}/refunds
  • Auth
    HTTP bearer

Path parameters

ClientIdstring required

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

PayoutIdstring required

The unique identifier of the payout.

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.

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_refunds_payout removed and replaced with refunds_list_refunds_payout