Platform Fees

2 endpoints. Base URL https://api.paymentsonline.io, sandbox https://api.sandbox-paymentsonline.io.

Every request needs payments-api-key and payments-account.

GET/v1/platform-fees

List all Platform Fees

Returns a list of Platform Fees. The Platform Fees are sorted with the most recently created appearing first.

Query parameters

created_at_gtestring date-timeoptional
Minimum created_at value to filter by (inclusive).
created_at_ltestring date-timeoptional
Maximum created_at value to filter by (inclusive).
charge_idstringoptional
Only return application fees for the charge specified by this charge id.
offsetnumberoptional
The (zero-based) offset of the first item in the collection to return.
limitnumberoptional
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

200PaginatedDto | object

has_morebooleanrequired
Whether or not there are more elements available after this set. If false, this set comprises the end of the list.
limitnumberoptional
The maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.
offsetnumberoptional
The (zero-based) offset of the first item in the collection to return.
totalnumberoptional
The total items count.
itemsarray of PlatformFeerequired

GET/v1/platform-fees/{id}

Get a Platform Fee

Retrieves the details of a collected Platform Fee.

Path parameters

idstringrequired

Header parameters

payments-accountstringrequired
The id of the Paydude Account (usually starting with the prefix acct_) that the request is performed on behalf of. Must be a merchant (connected) account id, not the partner account you signed up with; a partner account passes GET /v1/accounts and then fails with "not enabled for this account" on the first payment call.

Responses

200PlatformFee

amountnumberrequired
Amount earned, in minor currency units.
amount_refundednumberrequired
Amount refunded, in minor currency units. Can be less than the amount attribute if a partial refund was issued.
balance_transactionBalanceTransactionrequired
The balance transaction that describes the impact of this collected platform fee on your account balance (not including refunds). Note: Multiple balance transactions may be associated with this resource and you can fetch them all with /balance-transactions?source_id={id}.
charge_idstringrequired
Id of the charge this fee was taken from.
created_atstring date-timerequired
Time at which the object was created.
currencystring (aud | cad | dkk | eur | hkd | jpy | nzd | nok | …)required
Three-letter [ISO currency code](https://www.iso.org/iso-4217-currency-codes.html), in lowercase.
idstringrequired
Unique identifier for the object.
payee_account_idstringrequired
Id of the Paydude account that earned this fee. This is generally an account of type partner.
payer_account_idstringrequired
Id of the Paydude account this fee was taken from. This is generally an account of type merchant.
refundedbooleanrequired
Whether the fee has been fully refunded. If the fee is only partially refunded, this attribute will be false.
refundsarray of PlatformFeeRefundrequired
A list of refunds that have been applied to the fee.
subtypestring (reversal | split_pay | adjustment)required
The platform fee subtype. This is an optional attribute that can be used to further classify the type of platform fee. For example, a platform fee with type platform may have a subtype of split_pay to indicate that the fee was related to a split funding payment.
updated_atstring date-timerequired
Time at which the object was last updated.