Sign in

v1

latestOpenAPI 3.0.32026-07-2488203535.0 KB
Processors and Services

Get Available Services

❗️ 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 down a list of all services that you can offer to merchants. You don’t need to run this every time you board a merchant, but it is useful to occasionally make sure a service is available before trying to add it to a merchant account. </details>
post/v4/services/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

Number of max results, any integer number from 1 to 1000

Response

Success

objectType'service'

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

idstring

The service ID.

namestring

The name of the service.

typestring

The type of service.

source'internal' | 'external'

The source of the service.

canMerchantSignUpboolean

Whether your merchants can sign up to this service or not.

canBeDeletedboolean

Whether the service can be deleted or not.

supportsSplitFundingboolean

Whether the service supports split funding or not.

blockersstring[]