Create Provider

Creates a new payment provider entry for tracking and analytics. Providers represent payment service providers (like Paystack, Flutterwave) that you integrate with. Providers are used for tracking and analytics purposes only - no credentials are stored.

Request Body

string

required

Provider display name (e.g., “Paystack”, “Flutterwave”)

string

required

Unique identifier for the provider. Must be:

Lowercase
No spaces (use underscores or hyphens)
Unique within your account
Examples: “paystack”, “flutterwave”, “stripe”

boolean

default:"true"

Whether provider is active

Example Request

{
  "name": "Paystack",
  "slug": "paystack",
  "enabled": true
}

Response

string

Response status (“success”)

string

Success message

object

Provider object

string

Provider ID

string

Account ID

string

Provider name

string

Provider slug

boolean

Whether provider is enabled

string

ISO 8601 timestamp

string

ISO 8601 timestamp

Example Response

{
  "status": "success",
  "message": "Provider created successfully",
  "data": {
    "id": "prv_xxxxxxxxxxxxx",
    "accountId": "1dae3dd7-7194-479d-a8af-8ebf3c258a05",
    "name": "Paystack",
    "slug": "paystack",
    "enabled": true,
    "createdAt": "2025-11-12T17:46:07.000Z",
    "updatedAt": "2025-11-12T17:46:07.000Z"
  }
}

Error Responses

409 Conflict: Provider slug already exists for your account
400 Bad Request: Invalid input data

Notes

The slug must be unique per account
Providers are used for analytics and tracking only
No payment credentials are stored

API Documentation

Collections

Providers

Request Body

Example Request

Response

Example Response

Error Responses

Notes

​Request Body

​Example Request

​Response

​Example Response

​Error Responses

​Notes

Request Body

Example Request

Response

Example Response

Error Responses

Notes