Build with FiatPe APIs

FiatPe APIs follow RESTful principles and return all API responses in JSON format, making integrations simple, consistent, and easy to manage. Explore the available APIs, understand request and response formats, and test your integration directly from the documentation.

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/

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.

Get your API credentials

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

Use the Test environment

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

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.

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.

Validate and move to Live

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

ENVIRONMENTS

Testing Your Integration

Build and validate your complete API workflow using Test credentials before enabling Live transactions. Keep credentials and data isolated between the two environments.

TEST

Test environment

Use Test API credentials to develop your integration, validate request payloads, and check success and error responses safely.

Use Test API Key and Salt Key.
Test required fields and invalid values.
Verify response parsing and retry behavior.

LIVE

Live environment

Switch to Live credentials only after the Test workflow has been reviewed and validated. Live credentials must remain server-side.

Use separate Live API Key and Salt Key.
Confirm production logging excludes credentials.
Monitor the first Live requests and responses.

CARD SCENARIOS

Test card payments

Use the test card details assigned to your FiatPe Test account to validate these common payment outcomes.

TEST MODE ONLY

SUCCESS

Successful card payment

Complete a standard card payment and verify the success response, transaction ID, and final payment status.

Expected: successful payment

DECLINE

Declined card payment

Trigger the decline scenario assigned to your Test account and confirm that the checkout displays a recoverable error.

Expected: payment declined

AUTHENTICATION

Card authentication

Validate the OTP or 3DS challenge flow when it is enabled for your integration, including cancellation and timeout paths.

Expected: authentication challenge

VALIDATION

Invalid card details

Submit an invalid expiry, CVV, or incomplete card form and verify that validation errors are handled without creating a payment.

Expected: validation error

Where to get test card details

Use only the test PAN, expiry date, CVV, and authentication values supplied with your FiatPe Test credentials. Contact FiatPe Support if these values are not included in your onboarding details.

Never enter real customer card details while testing.

✓

Go-live checklist

Complete these checks before switching to Live credentials.

01
Use only Test credentials while developing and validating the integration.
02
Verify successful requests, validation errors, and failed-response handling.
03
Confirm that duplicate requests, retries, and timeouts are handled safely.
04
Replace Test credentials with Live credentials only after validation is complete.

AUTHENTICATION

Create your Authorization key

FiatPe provides an API Key and Salt Key for accessing protected APIs. Combine both values using a colon, Base64 encode the complete string, and pass the encoded value in the Authorization header using the Basic scheme.

Get your credentials

FiatPe provides your API Key and Salt Key.

API Key: fp_test_abc123Salt Key: salt_xyz789

Combine the values

Join the API Key and Salt Key using a colon.

fp_test_abc123:salt_xyz789

Base64 encode the combined value

Encode the complete credential string without changing its format.

ZnBfdGVzdF9hYmMxMjM6c2FsdF94eXo3ODk=

Add it to the Authorization header

Prefix the Base64 encoded value with Basic.

Authorization: Basic ZnBfdGVzdF9hYmMxMjM6c2FsdF94eXo3ODk=

Important: Do not Base64 encode the API Key and Salt Key separately. First combine them as api_key:salt_key, then encode the complete value.

RESPONSES

Status Codes and Error Handling

Use the HTTP status code and response body together when deciding whether a request succeeded, should be corrected, or can be retried.

2xx

Success

The request was accepted and processed.

4xx

Request error

Review authentication, parameters, or request data.

5xx

Server error

Retry safely or contact FiatPe Support if the issue continues.

Validate: Check required fields and data types before sending a request.

Log safely: Record status codes and request IDs, but never log credentials.

Retry carefully: Retry only safe operations and use increasing delays for temporary failures.

SECURITY

Security Best Practices

Protect your FiatPe API credentials and integration by following these recommended security practices across Test and Live environments.

Keep API credentials server-side

Never expose your API Key, Salt Key, or Authorization value in frontend applications, browser code, mobile app bundles, or public repositories.

Store credentials securely

Keep credentials in environment variables, a secrets manager, or another protected server-side configuration system instead of hardcoding them in source code.

Use separate environment credentials

Maintain separate credentials for Test and Live and ensure requests are sent only to the matching environment.

Do not log sensitive headers

Avoid logging full API keys, Salt Keys, Authorization headers, or other sensitive authentication values in application logs.

Use HTTPS for all requests

Send FiatPe API requests only over secure HTTPS connections to protect credentials and transaction data in transit.

Important: Treat your API Key and Salt Key as sensitive credentials. If you suspect they have been exposed, contact FiatPe Support and rotate the affected credentials immediately.

REFERENCE

API Glossary

Common terms used throughout the FiatPe API documentation.

Endpoint: The URL used to access an API resource or operation.
Resource: An object managed through the API, such as an order or customer.
Payload: The JSON data sent in a request or returned in a response.
API credentials: The API Key and Salt Key used to authenticate requests.
Idempotency: A request behavior that prevents an operation from being applied more than once.
Pagination: Dividing a large collection into smaller pages of results.

SUPPORT

Need help with your integration?

Our team is available to help you with API integration, request and response formats, authentication, testing, and Live go-live support.

Integration Support

Get assistance with API implementation, authentication setup, request validation, response handling, and integration issues.

Testing & Go-Live Support

Get help during Test validation, Live readiness checks, and go-live activities.

Contact FiatPe Supportsupport@fiatpe.com