v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB

Gateway Features

Fee Schedule

Pull All Fee Schedules

❗️ Never Use Real API Keys

Never use real API Keys when testing. The gateway allows Partners to create Test Merchant Accounts. Testing should always use keys from the Test Accounts and never keys from a Standard Account.

<details> <summary>Usage</summary> This request will pull all fee schedules available on your account. </details>

post/v4/fee_schedules/search

Headers

Content-Typestring required

The Content-Type representation header is used to indicate the original media type of the resource (prior to any content encoding applied for sending).

Authorizationstring required

Your v4 API key that was generated in the Partner portal.

Request body

maxResultsstring required

Required. Value must be between 1-1000.

includeCustomFeeSchedulestrue | false

Determines whether to include custom fee schedules.

parentAffiliateIdstring

The ID of the affiliate directly above the merchant.

Note: You can pass in parentAffiliateId to narrow down fee schedules to a specific affiliate's fee schedules. If parentAffiliateId is not specified, all fee schedules in the affiliate tree will be loaded.

Response

Success

objectTypestring

The type of object that was returned as a result of the request.

offsetnumber

The first N skipped results.

maxResultsnumber

The max number results.

totalResultsnumber

The total number of results.

hasMoreboolean

If are there more results for the search.