RYryftpay
Platform Fees

Retrieves your platform fees in sorted (by epoch) order

Changed on

Retrieves a list of the application fees you've collected. They are returned in sorted (by epoch) order (default is newest first)

get/platform-fees

Request

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

Query parameters

ascendingboolean

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

limitinteger
Example:20

Control how many platform-fees are returned in the result list. The max limit we allow is 50.

startsAfterstring
Example:pf_01FCTS1XMKH9FF43CAFA4CXT3P

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 your platform fees

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": "pf_01FCTS1XMKH9FF43CAFA4CXT3P",
      "paymentSessionId": "ps_01JJPPAZTNN38EMDJ72FASHE7R",
      "amount": 40,
      "paymentAmount": 450,
      "processingFee": 7,
      "refundedAmount": 45,
      "netAmount": 33,
      "currency": "GBP",
      "fromAccountId": "ac_b83f2653-06d7-44a9-a548-5825e8186004",
      "createdTimestamp": 1470989538
    }
  ],
  "paginationToken": "pf_01FCTS1XMKH9FF43CAFA4CXT3P"
}

Changes

  • 12a00a02c275Revision changes
    • info

      added the new optional query request parameter startsAfter

    • info

      added the optional property to the response with the status