API docs by Redocly

Fiatsend API (1.2.1)

Download OpenAPI specification:

Introduction

The Fiatsend API provides programmatic access for accounts, wallet management, P2P transfers, payment requests, disbursements, and more.

Prerequisites

  • Sign Up or Login.
  • Complete profile and ID/Phone/Email verification.
  • Create a wallet (GHS/KES/NGN only). Wallets/accounts must be activated by our team before API use.
  • For help, schedule via Calendly or email dev@fiatsend.com.

Generating Your API Keys

  • Login at https://app.fiatsend.network.
  • Complete your profile and verification.
  • Click your Profile Picture → Edit Profile → Security tab.
  • Select API Key and generate your keys.

Authentication

Headers required on all requests:

  • X-API-USER: Your user/account ID
  • X-API-KEY: Your secret API key
  • X-API-PUBKEY: Your API public key
  • X-API-VASKEY: VAS/merchant ID key if applicable

Note: Never commit your secret keys to git or expose in client-side code. Manage keys through your Fiatsend dashboard.

Create Fiatsend Account

Create a new Fiatsend account by providing wallet address, signature, and phone number. Note: Created accounts must be activated by the Fiatsend team before use.

Authorizations:
ApiKeyAuthOAuth2
header Parameters
X-API-USER
required
string

Your user/account ID

X-API-KEY
required
string

Your secret API key

X-API-PUBKEY
required
string

Your API public key

X-API-VASKEY
string

VAS/merchant ID key if applicable

Request Body schema: application/json
required
wallet_address
required
string
signature
required
string
phone_number
required
string

Responses

Request samples

Content type
application/json
{
  • "wallet_address": "string",
  • "signature": "string",
  • "phone_number": "string"
}

Retrieve Account Details

Authorizations:
ApiKeyAuthOAuth2
path Parameters
user_id
required
string
header Parameters
X-API-USER
required
string

Your user/account ID

X-API-KEY
required
string

Your secret API key

X-API-PUBKEY
required
string

Your API public key

X-API-VASKEY
string

VAS/merchant ID key if applicable

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "name": "string",
  • "email": "string",
  • "phone_number": "string",
  • "created_at": "2019-08-24T14:15:22Z",
  • "status": "active"
}

Account Status

Authorizations:
ApiKeyAuthOAuth2
path Parameters
user_id
required
string
header Parameters
X-API-USER
required
string

Your user/account ID

X-API-KEY
required
string

Your secret API key

X-API-PUBKEY
required
string

Your API public key

X-API-VASKEY
string

VAS/merchant ID key if applicable

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

List Transactions

Authorizations:
ApiKeyAuthOAuth2
path Parameters
agent_id
required
number
query Parameters
from
string <date-time>
to
string <date-time>
header Parameters
X-API-USER
required
string

Your user/account ID

X-API-KEY
required
string

Your secret API key

X-API-PUBKEY
required
string

Your API public key

X-API-VASKEY
string

VAS/merchant ID key if applicable

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Resolve Mobile Number

Resolve a phone number to a Fiatsend wallet address.

Authorizations:
ApiKeyAuthOAuth2
path Parameters
phone_number
required
string
header Parameters
X-API-USER
required
string

Your user/account ID

X-API-KEY
required
string

Your secret API key

X-API-PUBKEY
required
string

Your API public key

X-API-VASKEY
string

VAS/merchant ID key if applicable

Responses

Response samples

Content type
application/json
{
  • "wallet_address": "string"
}

Initiate Transfer

Initiate a transfer to a wallet.

Authorizations:
ApiKeyAuthOAuth2
header Parameters
X-API-USER
required
string

Your user/account ID

X-API-KEY
required
string

Your secret API key

X-API-PUBKEY
required
string

Your API public key

X-API-VASKEY
string

VAS/merchant ID key if applicable

Request Body schema: application/json
from_account
required
string
to_account
required
string
amount
required
number
currency
required
string

Responses

Request samples

Content type
application/json
{
  • "from_account": "string",
  • "to_account": "string",
  • "amount": 0,
  • "currency": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "from_account": "string",
  • "to_account": "string",
  • "amount": 0,
  • "currency": "string",
  • "status": "string",
  • "created_at": "2019-08-24T14:15:22Z"
}

Transfer Status

Fetch status for a given transaction ID.

Authorizations:
ApiKeyAuthOAuth2
path Parameters
id
required
string
header Parameters
X-API-USER
required
string

Your user/account ID

X-API-KEY
required
string

Your secret API key

X-API-PUBKEY
required
string

Your API public key

X-API-VASKEY
string

VAS/merchant ID key if applicable

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Send to another Fiatsend user (P2P)

Send to another Fiatsend user using their mobile number.

Authorizations:
ApiKeyAuthOAuth2
header Parameters
X-API-USER
required
string

Your user/account ID

X-API-KEY
required
string

Your secret API key

X-API-PUBKEY
required
string

Your API public key

X-API-VASKEY
string

VAS/merchant ID key if applicable

Request Body schema: application/json
required
from_number
required
string
to_number
required
string
amount
required
number
currency
string

Responses

Request samples

Content type
application/json
{
  • "from_number": "string",
  • "to_number": "string",
  • "amount": 0,
  • "currency": "string"
}

Initiate Payment

Initiate payment request to a recipient.

Authorizations:
ApiKeyAuthOAuth2
header Parameters
X-API-USER
required
string

Your user/account ID

X-API-KEY
required
string

Your secret API key

X-API-PUBKEY
required
string

Your API public key

X-API-VASKEY
string

VAS/merchant ID key if applicable

Request Body schema: application/json
required
agent_id
required
number
recipient_number
required
string
otp_code
string

Only required for first-time request

amount
required
number

Responses

Request samples

Content type
application/json
{
  • "agent_id": 0,
  • "recipient_number": "string",
  • "otp_code": "string",
  • "amount": 0
}

Disburse Payment

Disburse a payment to a recipient.

Authorizations:
ApiKeyAuthOAuth2
header Parameters
X-API-USER
required
string

Your user/account ID

X-API-KEY
required
string

Your secret API key

X-API-PUBKEY
required
string

Your API public key

X-API-VASKEY
string

VAS/merchant ID key if applicable

Request Body schema: application/json
required
agent_id
required
number
recipient_number
required
string
amount
required
number
currency
string

Responses

Request samples

Content type
application/json
{
  • "agent_id": 0,
  • "recipient_number": "string",
  • "amount": 0,
  • "currency": "string"
}

Generate Transaction ID

Generate a transaction/payment ID for later use in the system.

Authorizations:
ApiKeyAuthOAuth2
header Parameters
X-API-USER
required
string

Your user/account ID

X-API-KEY
required
string

Your secret API key

X-API-PUBKEY
required
string

Your API public key

X-API-VASKEY
string

VAS/merchant ID key if applicable

Request Body schema: application/json
optional
purpose
string

Responses

Request samples

Content type
application/json
{
  • "purpose": "string"
}

Response samples

Content type
application/json
{
  • "transaction_id": "string"
}

Payment Webhook

Webhook endpoint to receive payment status notifications.

Authorizations:
ApiKeyAuthOAuth2
Request Body schema: application/json
required
transaction_id
string
status
string
event_type
string

Responses

Request samples

Content type
application/json
{
  • "transaction_id": "string",
  • "status": "string",
  • "event_type": "string"
}

Fetch Real-Time Exchange Rates

Get real-time exchange rates.

Authorizations:
ApiKeyAuthOAuth2

Responses

Response samples

Content type
application/json
[
  • {
    }
]