Sign in

v1

latestOpenAPI 3.0.02026-08-0696238481.7 KB
Platform Fees

Retrieve a platform fee by Id

This is used to fetch a platform fee by its platformFeeId

get/platform-fees/{platformFeeId}

Path parameters

platformFeeIdstring required
Example:pf_01FCTS1XMKH9FF43CAFA4CXT3P

PlatformFee to retrieve

Response

Successfully retrieved the given PlatformFee

idstring

The unique identifier for the platform fee

paymentSessionIdstring

The unique payment session that this platform fee relates to

amountinteger

The amount of the fee you collected on top of a payment for a linked account

paymentAmountinteger

The amount of the associated payment

processingFeeinteger

This field is now deprecated. Please use the /balance-transactions endpoint to see the fees paid on these transactions.

The processing fee that is taken from the original payment. This amount is then deducted from the amount you collect as your fee from the transaction.

refundedAmountinteger

The amount of the platform fee that was refunded

netAmountinteger

This field is now deprecated. Please use the /balance-transactions endpoint to see the net amount for these transactions.

The net amount you take once fees have been deducted.

currencystring

The ISO currency code

fromAccountIdstring

The account that you collected the fee from

createdTimestampinteger

The epoch timestamp (seconds) when the payment was created

Example response

{
  "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
}