API v1FiatPe Home
FiatPeDocs
GET STARTED

Build with FiatPe APIs

Explore FiatPe API fundamentals, authentication, base URLs, request and response formats, error handling, and secure integration practices. Use the Introduction menu to open each guide on its own permanent URL.

API FUNDAMENTALS

Understand FiatPe APIs

FiatPe APIs are resource-oriented REST APIs. Requests use standard HTTP methods, parameters, headers, and JSON payloads to work with resources such as orders, payments, refunds, and customers.

Resources and endpoints

A resource is an API object. Each resource has an endpoint, and an individual object is identified using its unique ID.

/v1/orders/:id/

JSON requests and responses

Request bodies and responses use JSON. Send the documented content type and validate every response before using its data.

Content-Type: application/json
GETRetrieve a resource or a collection.
POSTCreate a new resource or start an operation.
PUTReplace an existing resource.
DELETERemove a resource when supported.
Request parameters: Path parameters identify a resource, query parameters filter or paginate results, and body parameters provide data for create or update operations.
ENVIRONMENTS

Base URLs

Use this base URL for all FiatPe API requests. Append the documented endpoint path to this URL when making an API call.

APICanonical FiatPe API base URL.
https://api.fiatpe.com/
Copy
QUICK START

Start integrating in a few steps

Follow this recommended flow to begin testing FiatPe APIs in the Test environment and prepare your integration for Live.

1

Get your API credentials

Receive your API Key and Salt Key from FiatPe for the required environment.

2

Use the Test environment

Build and validate your integration using the FiatPe API base URL with your Test credentials before moving to Live.

3

Generate the Authorization value

Combine your API Key and Salt Key as api_key:salt_key, Base64 encode the complete value, and prefix it with Basic.

4

Send your first API request

Select an API from the sidebar, enter the required headers and parameters, and test the request directly from the documentation.

5

Validate and move to Live

After successful Test integration validation, replace the Test credentials with your Live credentials to go live.