RYryftpay
Platform Fees

Retrieve platform fee refund(s)

Changed on

This is used to fetch a platform fee refunds by their platformFeeId

get/platform-fees/{platformFeeId}/refunds

Request

  • Base URL
    https://sandbox-api.ryftpay.com/v1
  • URL
    https://sandbox-api.ryftpay.com/v1/platform-fees/{platformFeeId}/refunds
  • Auth
    API key in header Authorization

Path parameters

platformFeeIdstring required
Example:pf_01FCTS1XMKH9FF43CAFA4CXT3P

PlatformFee to retrieve refunds for

Query parameters

ascendingboolean
Example:true

Control the order (newest or oldest) in which the platform fee refunds are returned. false will arrange the results with newest first whereas true shows oldest first

limitinteger
Example:20

Control how many platform fee refunds are returned in the result list. The max limit we allow is 25.

startsAfterstring
Example:fr_01FM9XMMV1MYDG6NGMHPDE065N_01FM9XNFXDYXAT0BJN5BBN794B

A token to identify the previous item to start querying after. The value of the paginationToken field from that response should be supplied here, to retrieve the next page of results.

Response

Successfully retrieved the platform fee refunds

paginationTokenstring nullable

A token to use for getting the next page of results - send the same request with this value in the 'startsAfter' query parameter. This field is null when there are no further items to return.

Example response

{
  "items": [
    {
      "id": "fr_01FM9XMMV1MYDG6NGMHPDE065N_01FM9XNFXDYXAT0BJN5BBN794B",
      "platformFeeId": "pf_01FM9XMMV1MYDG6NGMHPDE065N",
      "amount": 5,
      "currency": "GBP",
      "reason": "Requested by the customer",
      "status": "Succeeded",
      "createdTimestamp": 1470989538,
      "lastUpdatedTimestamp": 1470989538
    }
  ],
  "paginationToken": "fr_01FM9XMMV1MYDG6NGMHPDE065N_01FM9XNFXDYXAT0BJN5BBN794B"
}

Changes

  • 12a00a02c275Revision changes
    • info

      added the new optional query request parameter ascending

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter startsAfter

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status