API docs by Redocly

TeraPay Payment Gateway API (v1)

Download OpenAPI specification:Download

APIs for TeraPay payment gateway operations.

Account

Logs a portal user in via cookie-based authentication and returns their roles.

Authorizations:
(ApiKeyBearer)
Request Body schema:

The TeraPaymentGatewayAPI.Dtos.PortalUserLoginDto containing credentials.

username
required
string <email> non-empty

Username (usually the user’s email address) for sign-in.

password
required
string non-empty

The user’s plaintext password.

rememberMe
boolean

Whether to persist the login cookie across browser sessions.

Responses

Request samples

Content type
{
  • "username": "user@example.com",
  • "password": "string",
  • "rememberMe": true
}

Logs the current portal user out (clears auth cookie).

Authorizations:
(ApiKeyBearer)

Responses

Requests a password-reset email to be sent.

Authorizations:
(ApiKeyBearer)
Request Body schema:

The TeraPaymentGatewayAPI.Dtos.ForgotPasswordDto containing the user’s email.

email
string or null

The portal user’s email address.

Responses

Request samples

Content type
{
  • "email": "string"
}

Resets a user’s password using a valid token.

Authorizations:
(ApiKeyBearer)
Request Body schema:

The TeraPaymentGatewayAPI.Dtos.ResetPasswordDto containing email, token, and new password.

email
string or null

The portal user’s email address.

token
string or null

The password-reset token previously generated.

newPassword
string or null

The desired new password.

Responses

Request samples

Content type
{
  • "email": "string",
  • "token": "string",
  • "newPassword": "string"
}

APIUserPermissions

Applies the given override map for this user.

Authorizations:
(ApiKeyBearer)
path Parameters
apiUserId
required
string <uuid>
Request Body schema:
object or null

Map of PermissionID → IsAllowed (true=grant, false=revoke).

Responses

Request samples

Content type
{
  • "overrides": {
    }
}

Gets all permission overrides for a specific API user.

Authorizations:
(ApiKeyBearer)
path Parameters
apiUserId
required
string <uuid>

Responses

Gets all API users with their permission overrides.

Authorizations:
(ApiKeyBearer)

Responses

APIUsers

Creates a new API user under the authenticated client.

Authorizations:
(ApiKeyBearer)
Request Body schema:
developerName
required
string non-empty
developerEmail
required
string non-empty
developerPhoneNumber
required
string non-empty
roleId
required
string <uuid>

Responses

Request samples

Content type
{
  • "developerName": "string",
  • "developerEmail": "string",
  • "developerPhoneNumber": "string",
  • "roleId": "7382d58e-652a-4905-b7c9-bcca1e0e5391"
}

Response samples

Content type
No sample

Gets all API users linked to the logged-in user's client. SuperAdmin sees all.

Authorizations:
(ApiKeyBearer)

Responses

Retrieves a specific API user by their unique identifier.

Authorizations:
(ApiKeyBearer)
path Parameters
apiUserId
required
string <uuid>

The unique identifier of the API user to retrieve.

Responses

Banks

Retrieves all supported banks.

Authorizations:
(ApiKeyBearer)

Responses

Response samples

Content type
No sample

Retrieves a single bank by its 3-digit code.

Authorizations:
(ApiKeyBearer)
path Parameters
code
required
string = 3 characters

The 3-digit bank code.

Responses

Response samples

Content type
No sample

BulkDisbursement

Submit a new bulk disbursement batch.

Authorizations:
(ApiKeyBearer)
Request Body schema:

Batch submission DTO containing destination+amount items.

batchName
required
string non-empty

A human-readable name for this batch.

required
Array of objects (BatchItemDto)

The individual items to disburse.

Responses

Request samples

Content type
{
  • "batchName": "string",
  • "items": [
    ]
}

Response samples

Content type
No sample

Processes all "Pending" items in the given bulk disbursement batch: 1. Inserts a TeraPay transaction for each pending item, 2. Updates each batch item to "Processed" and stamps CompletedAt, 3. Returns lists of which items were processed and which were skipped.

Authorizations:
(ApiKeyBearer)
path Parameters
batchId
required
string <uuid>

The identifier of the batch to process.

Responses

Response samples

Content type
No sample

Gets the status of every item in a batch.

Authorizations:
(ApiKeyBearer)
path Parameters
batchId
required
string <uuid>

The batch identifier.

Responses

Response samples

Content type
No sample

Retry one or more failed items in a batch.

Authorizations:
(ApiKeyBearer)
path Parameters
batchId
required
string <uuid>

The batch identifier.

Request Body schema:

DTO containing the list of ItemIds to retry.

batchId
required
string <uuid>

The batch whose items are being retried.

itemIds
required
Array of strings <uuid>

The item IDs (from TeraPaymentGatewayAPI.Dtos.SubmitBatchResultDto.ItemIds) to retry.

Responses

Request samples

Content type
{
  • "batchId": "5579c111-9c50-47e2-af92-f16d52e63189",
  • "itemIds": [
    ]
}

Response samples

Content type
No sample

CardPayments

1. Tokenize a raw card into a reusable token.

Authorizations:
(ApiKeyBearer)
Request Body schema:
cardNumber
required
string <credit-card> non-empty
expiryMonth
integer <int32> [ 1 .. 12 ]
expiryYear
integer <int32> [ 2021 .. 2100 ]
cvv
required
string [ 3 .. 4 ] characters

Responses

Request samples

Content type
{
  • "cardNumber": "string",
  • "expiryMonth": 1,
  • "expiryYear": 2021,
  • "cvv": "stri"
}

2. Authorize a payment on a token. Might require 3DS.

Authorizations:
(ApiKeyBearer)
Request Body schema:
token
required
string non-empty
amount
number <double> >= 0.01
currency
required
string non-empty
orderId
string or null

Responses

Request samples

Content type
{
  • "token": "string",
  • "amount": 0.01,
  • "currency": "string",
  • "orderId": "string"
}

3. Capture a previously authorized payment.

Authorizations:
(ApiKeyBearer)
Request Body schema:
authorizationId
required
string non-empty
amount
number <double> >= 0.01

Responses

Request samples

Content type
{
  • "authorizationId": "string",
  • "amount": 0.01
}

4. Verify 3DS challenge result (PARes).

Authorizations:
(ApiKeyBearer)
Request Body schema:
authorizationId
required
string non-empty
paRes
required
string non-empty

Responses

Request samples

Content type
{
  • "authorizationId": "string",
  • "paRes": "string"
}

Checkout

Issues a new hosted-checkout session and returns the session URL and metadata.

Authorizations:
(ApiKeyBearer)
Request Body schema:

The checkout session creation request.

amount
required
number <double>
currency
required
string = 3 characters
returnUrl
required
string <uri> non-empty

Responses

Request samples

Content type
{}

Response samples

Content type
No sample

Fetches a single checkout session by session ID.

Authorizations:
(ApiKeyBearer)
path Parameters
sessionId
required
string <uuid>

The unique identifier of the checkout session.

Responses

Response samples

Content type
No sample

Clients

Registers a new client in Pending state, creates a portal-admin user for them, and emails initial credentials. A CompanyAdmin must later approve the client.

Authorizations:
(ApiKeyBearer)
Request Body schema:

The client registration DTO.

clientType
string or null

Type of client: "Individual" or "Company".

name
string or null

Name of the client.

contactPerson
string or null

Primary contact person for the client.

phoneNumber
string or null

Phone number of the client.

emailAddress
string or null

Email address of the client.

address
string or null

Street address of the client.

city
string or null

City of the client's address.

state
string or null

State or province of the client's address.

country
string or null

Country of the client's address.

Responses

Request samples

Content type
{
  • "clientType": "string",
  • "name": "string",
  • "contactPerson": "string",
  • "phoneNumber": "string",
  • "emailAddress": "string",
  • "address": "string",
  • "city": "string",
  • "state": "string",
  • "country": "string"
}

Response samples

Content type
No sample

Gets all clients, each with its type, total API‐user count, and list of API users.

Authorizations:
(ApiKeyBearer)

Responses

Response samples

Content type
No sample

Lists all clients that are awaiting approval (IsActive == false). Only portal users in the CompanyAdmin role may call this.

Authorizations:
(ApiKeyBearer)

Responses

Response samples

Content type
No sample

Approves a pending client, setting TeraPaymentGatewayAPI.Models.Client.IsActive to true, and—if the client is an Individual—automatically provisions exactly one API user and emails them their API key. Only portal users in the CompanyAdmin role may call this.

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string <uuid>

The GUID of the client to approve.

Responses

Deactivates an active client (sets TeraPaymentGatewayAPI.Models.Client.IsActive to false).

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string <uuid>

The GUID of the client to deactivate.

Responses

Rejects a pending client registration, marking as inactive and optionally sending a notification.

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string <uuid>

The GUID of the client to reject.

query Parameters
reason
string

Reason for rejection.

Responses

Returns the number of API users belonging to a specific client.

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string <uuid>

The client’s GUID.

Responses

Returns the total number of API users across all clients.

Authorizations:
(ApiKeyBearer)

Responses

Retrieves a client by its unique identifier.

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string <uuid>

The GUID of the client.

Responses

Response samples

Content type
No sample

Customers

Registers a new wallet customer.

Authorizations:
(ApiKeyBearer)
Request Body schema:

Registration data including email, password, and full name.

email
required
string <email> [ 1 .. 200 ] characters

Customer’s email address (login). Must be unique.

password
required
string >= 8 characters

Plaintext password (minimum requirements enforced in controller).

fullName
string or null <= 200 characters

Customer’s full name (optional).

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "password": "stringst",
  • "fullName": "string"
}

Retrieves a customer's details by ID.

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string <uuid>

The customer's unique identifier (GUID).

Responses

Response samples

Content type
No sample

Authenticates a wallet customer and issues a JWT token if credentials are valid.

Authorizations:
(ApiKeyBearer)
Request Body schema:

Login data including email and password.

email
required
string <email> [ 1 .. 200 ] characters

The customer’s email address (login identifier).

password
required
string >= 8 characters

The customer’s plaintext password. Must satisfy any password policy (e.g. ≥ 8 characters).

Responses

Request samples

Content type
{
  • "email": "user@example.com",
  • "password": "stringst"
}

CustomerWallet

Gets the current wallet balance of the authenticated customer.

Authorizations:
(ApiKeyBearer)

Responses

Adds funds to the authenticated customer's wallet.

Authorizations:
(ApiKeyBearer)
Request Body schema:

Top-up data including amount and description.

amount
required
number <double> >= 0.01

Amount to credit (must be positive).

description
required
string [ 1 .. 200 ] characters

Description for the ledger entry (max 200 chars).

Responses

Request samples

Content type
{
  • "amount": 0.01,
  • "description": "string"
}

Transfers funds from the authenticated customer's wallet to another user's wallet.

Authorizations:
(ApiKeyBearer)
Request Body schema:

Transfer details including recipient ID, amount, and description.

recipientCustomerId
required
string <uuid>

The GUID of the recipient customer.

amount
required
number <double> >= 0.01

Amount to transfer (must be positive).

description
required
string [ 1 .. 200 ] characters

Description for the ledger entries (max 200 chars).

Responses

Request samples

Content type
{
  • "recipientCustomerId": "8adbfb1f-b340-48e8-82df-6ed4bd37d070",
  • "amount": 0.01,
  • "description": "string"
}

Makes a payment from the authenticated customer's wallet.

Authorizations:
(ApiKeyBearer)
Request Body schema:

Payment information including amount, description, and external reference.

amount
required
number <double> >= 0.01

Amount to debit (must be positive).

description
required
string [ 1 .. 200 ] characters

Description for the ledger entry (max 200 chars).

externalReference
required
string [ 1 .. 100 ] characters

External reference (e.g. merchant invoice ID, max 100 chars).

Responses

Request samples

Content type
{
  • "amount": 0.01,
  • "description": "string",
  • "externalReference": "string"
}

Retrieves a transaction statement for the authenticated customer's wallet.

Authorizations:
(ApiKeyBearer)
query Parameters
startDate
string <date-time>

Start date for the statement (format: yyyy-MM-dd).

endDate
string <date-time>

End date for the statement (format: yyyy-MM-dd).

type
string

Optional filter for transaction type. Use "credit" or "debit" as dropdown values.

format
string
Default: "json"

Output format. Use "json" or "csv" as dropdown values. Default is "json".

Responses

Kyc

Uploads a KYC document (PDF or image) for the currently authenticated customer.

Authorizations:
(ApiKeyBearer)
Request Body schema: multipart/form-data
file
required
string <binary>

Responses

Retrieves the status of a previously uploaded KYC document.

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string <uuid>

The unique identifier of the document to check.

Responses

Response samples

Content type
No sample

Uploads multiple KYC documents (PDF or images) for the authenticated customer.

Authorizations:
(ApiKeyBearer)
Request Body schema: multipart/form-data
Files
required
Array of strings <binary>

Responses

KycAdmin

3. Admin lists all pending KYC docs.

Authorizations:
(ApiKeyBearer)

Responses

Response samples

Content type
No sample

4. Admin verifies or rejects a document.

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string <uuid>
Request Body schema:
newStatus
required
string non-empty
reason
string or null

Responses

Request samples

Content type
{
  • "newStatus": "string",
  • "reason": "string"
}

Metrics

Gets overall API metrics.

Authorizations:
(ApiKeyBearer)

Responses

Response samples

Content type
No sample

Payment

1. Initiates a fund transfer with fraud checks, creates a Transaction + OTP + flags.

Authorizations:
(ApiKeyBearer)
Request Body schema:
accountNumber
required
string [ 0 .. 34 ] characters

Full BBAN account number of the recipient.

amount
required
number <double> >= 0.01

Amount to be transferred.

narration
string or null

Optional narration for the transaction. Defaults to "Transfer to {AccountNumber}" if not specified.

Responses

Request samples

Content type
{
  • "accountNumber": "string",
  • "amount": 0.01,
  • "narration": "string"
}

2. Authorizes a pending transaction (bypassed bank calls here).

Authorizations:
(ApiKeyBearer)
Request Body schema:
transactionId
required
string <uuid>

The ID of the transaction to authorize.

otpCode
required
string = 6 characters

The OTP code sent to the user’s email/SMS.

Responses

Request samples

Content type
{
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc",
  • "otpCode": "string"
}

3. Resends the OTP for a pending transaction.

Authorizations:
(ApiKeyBearer)
Request Body schema:
transactionId
required
string <uuid>

Identifier of the transaction for which the OTP should be resent.

Responses

Request samples

Content type
{
  • "transactionId": "75906707-8c31-479c-b354-aa805c4cefbc"
}

4a. Gets pending transactions.

Authorizations:
(ApiKeyBearer)

Responses

Response samples

Content type
No sample

4b. Gets completed transactions.

Authorizations:
(ApiKeyBearer)

Responses

Response samples

Content type
No sample

4c. Gets a single transaction by ID.

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
No sample

4d. Gets transactions in a date range.

Authorizations:
(ApiKeyBearer)
query Parameters
from
string <date-time>
to
string <date-time>

Responses

Response samples

Content type
No sample

5. Bulk mobile‐money payouts with per-entry fraud checks.

Authorizations:
(ApiKeyBearer)
Request Body schema:
required
Array of objects (MobilePaymentEntry)

A collection of mobile‐money payment instructions.

Responses

Request samples

Content type
{
  • "payments": [
    ]
}

6a. Client-to-client bulk bank transfer with fraud per entry.

Authorizations:
(ApiKeyBearer)
Request Body schema:
destinationClientId
required
string <uuid>

The GUID of the destination client (e.g. NASSIT) to which funds are being sent.

accountNumber
required
string >= 3 characters

The bank account number of the destination client. Used for all entries in this bulk transfer. Must be at least 3 digits so the bank-code can be derived.

required
Array of objects (ClientTransferEntry) non-empty

The list of individual transfers (one per beneficiary/employee).

Responses

Request samples

Content type
{
  • "destinationClientId": "4716f81e-b3da-45bc-9ba7-eb482a49850e",
  • "accountNumber": "string",
  • "entries": [
    ]
}

6b. Client-to-client bulk mobile transfer with fraud per entry.

Authorizations:
(ApiKeyBearer)
Request Body schema:
destinationClientId
required
string <uuid>

The GUID of the destination client (e.g. NASSIT) to which funds are being sent.

phoneNumber
required
string <tel> non-empty

The beneficiary’s phone number (including country code).

required
Array of objects (ClientMobileTransferEntry) non-empty

The list of individual transfers (one per ledger entry). Each entry will credit the same PhoneNumber but with its own amount and narration.

Responses

Request samples

Content type
{
  • "destinationClientId": "4716f81e-b3da-45bc-9ba7-eb482a49850e",
  • "phoneNumber": "string",
  • "entries": [
    ]
}

Permissions

Retrieves all registered permissions.

Authorizations:
(ApiKeyBearer)

Responses

Response samples

Content type
No sample

Creates a new permission and assigns it to the SuperAdmin role.

Authorizations:
(ApiKeyBearer)
Request Body schema:

Permission definition.

name
string or null

Unique name of the permission (e.g., "Banks.Read").

httpMethod
string or null

HTTP method this permission covers (e.g., "GET", "POST").

routePattern
string or null

The route pattern this permission applies to (e.g., "/api/banks").

Responses

Request samples

Content type
{
  • "name": "string",
  • "httpMethod": "string",
  • "routePattern": "string"
}

Response samples

Content type
No sample

Retrieves a specific permission by its ID.

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string <uuid>

The permission ID (GUID).

Responses

Response samples

Content type
No sample

Creates multiple permissions in a single request and assigns them to the SuperAdmin role. Existing permissions are skipped. The result shows which ones were created or skipped.

Authorizations:
(ApiKeyBearer)
Request Body schema:

List of permissions to create.

Array
name
string or null

Unique name of the permission (e.g., "Banks.Read").

httpMethod
string or null

HTTP method this permission covers (e.g., "GET", "POST").

routePattern
string or null

The route pattern this permission applies to (e.g., "/api/banks").

Responses

Request samples

Content type
[
  • {
    }
]

PortalUsers

Creates a new portal user and optionally issues API credentials.

Authorizations:
(ApiKeyBearer)
Request Body schema:

The user creation request.

userName
string or null

The desired username for the new portal user.

email
string or null

The email address for the new portal user.

roles
Array of strings or null

The roles to assign to the new portal user.

generateApiKey
boolean

If true, also issue an API key/secret pair for programmatic access.

Responses

Request samples

Content type
{
  • "userName": "string",
  • "email": "string",
  • "roles": [
    ],
  • "generateApiKey": true
}

Retrieves all portal users visible to the current user.

Authorizations:
(ApiKeyBearer)

Responses

Response samples

Content type
No sample

Deletes the specified portal user.

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string

The user ID to delete.

Responses

Reports

1. Gets all transactions initiated by any API user for the specified client.

Authorizations:
(ApiKeyBearer)
path Parameters
clientId
required
string <uuid>

The client's unique identifier.

Responses

Response samples

Content type
No sample

2. Gets transaction volume (count and total amount) for a client, optionally filtered by type ("bank" or "mobile").

Authorizations:
(ApiKeyBearer)
path Parameters
clientId
required
string <uuid>

The client's unique identifier.

query Parameters
type
string

If "bank", includes only those whose ReceiverBankCode matches a known bank code; if "mobile", only those whose ReceiverBankCode (with any leading zero stripped) matches a telco code; otherwise both.

Responses

3. Gets the number of API calls (audit-log entries) grouped by API user for a client.

Authorizations:
(ApiKeyBearer)
path Parameters
clientId
required
string <uuid>

The client's unique identifier.

Responses

Response samples

Content type
No sample

4. Retrieves detailed audit-log entries (timestamps, endpoints, status codes) for each API user under a client.

Authorizations:
(ApiKeyBearer)
path Parameters
clientId
required
string <uuid>

The client's unique identifier.

Responses

Response samples

Content type
No sample

4. Gets a detailed list of all transactions for a given client, including amount, type (BankTransfer|MobileMoney), date, status, and reference number.

Authorizations:
(ApiKeyBearer)
path Parameters
clientId
required
string <uuid>

The client’s unique identifier.

Responses

Response samples

Content type
No sample

Lists all card transactions, optionally filtered by status.

Authorizations:
(ApiKeyBearer)
query Parameters
status
string

Responses

Response samples

Content type
No sample

Lists card transactions within a specific date range.

Authorizations:
(ApiKeyBearer)
query Parameters
from
string <date-time>
to
string <date-time>

Responses

Response samples

Content type
No sample

Returns summary statistics for card transactions.

Authorizations:
(ApiKeyBearer)

Responses

5. List all hosted-checkout sessions (with paging).

Authorizations:
(ApiKeyBearer)
query Parameters
page
integer <int32>
Default: 1

1-based page number (default 1).

pageSize
integer <int32>
Default: 50

Items per page (default 50).

Responses

Response samples

Content type
No sample

6. Summarize hosted-checkout volume and counts by status, optionally within a date range.

Authorizations:
(ApiKeyBearer)
query Parameters
from
string <date-time>

Start date (inclusive).

to
string <date-time>

End date (inclusive).

Responses

Get summary of all submitted disbursement batches.

Authorizations:
(ApiKeyBearer)

Responses

Get status details for a specific batch.

Authorizations:
(ApiKeyBearer)
path Parameters
batchId
required
string <uuid>

Responses

Get a report of all retry attempts.

Authorizations:
(ApiKeyBearer)

Responses

Get report of all failed items across all batches.

Authorizations:
(ApiKeyBearer)

Responses

Reconciliation report for a completed or in‐progress batch. Returns JSON by default, or CSV if ?format=csv.

Authorizations:
(ApiKeyBearer)
path Parameters
batchId
required
string <uuid>

The batch identifier.

query Parameters
format
string
Default: "json"

Optional: "csv" for CSV output.

Responses

RolePermissions

Replaces this role’s permissions with the provided list.

Authorizations:
(ApiKeyBearer)
path Parameters
roleId
required
string <uuid>
Request Body schema:
permissionIds
Array of strings or null <uuid>

List of PermissionIDs that this role should have.

Responses

Request samples

Content type
{
  • "permissionIds": [
    ]
}

Roles

Gets all roles.

Authorizations:
(ApiKeyBearer)

Responses

Response samples

Content type
No sample

Creates a new role with initial permissions.

Authorizations:
(ApiKeyBearer)
Request Body schema:
name
required
string non-empty
permissionIds
required
Array of strings <uuid>

List of PermissionIDs to assign.

Responses

Request samples

Content type
{
  • "name": "string",
  • "permissionIds": [
    ]
}

Response samples

Content type
No sample

Adds a permission to an existing role.

Authorizations:
(ApiKeyBearer)
path Parameters
roleId
required
string <uuid>
Request Body schema:
permissionID
required
string <uuid>

Responses

Request samples

Content type
{
  • "permissionID": "d57090d9-f9fa-46d9-b523-d140efcb932c"
}

Removes a permission from a role.

Authorizations:
(ApiKeyBearer)
path Parameters
roleId
required
string <uuid>
permissionId
required
string <uuid>

Responses

SandboxApiKeys

Lists all sandbox API keys owned by the current user.

Authorizations:
(ApiKeyBearer)

Responses

Response samples

Content type
No sample

Generates a new sandbox API key for the current user and returns the raw key.

Authorizations:
(ApiKeyBearer)
Request Body schema:
description
string or null

Optional descriptive name for this key (not stored, just for request clarity).

Responses

Request samples

Content type
{
  • "description": "string"
}

Revokes an existing sandbox API key. Revoked keys can no longer be used.

Authorizations:
(ApiKeyBearer)
path Parameters
id
required
string <uuid>

Responses

Sms

Send a one-off SMS.

Authorizations:
(ApiKeyBearer)
Request Body schema:

{ "phoneNumber": "recipient", "message": "your text" }

phoneNumber
required
string <tel> non-empty

Recipient phone number, including country code (e.g. "23277123456").

message
required
string [ 1 .. 320 ] characters

The SMS message body (max ~160 chars, depending on gateway).

Responses

Request samples

Content type
{
  • "phoneNumber": "string",
  • "message": "string"
}

Send a bulk SMS to multiple recipients.

Authorizations:
(ApiKeyBearer)
Request Body schema:

{ "phoneNumbers": ["+23276123456", "+23276543210"], "message": "Hello all!" }

phoneNumbers
Array of strings or null

List of phone numbers to send the message to.

message
string or null

The SMS message content.

Responses

Request samples

Content type
{
  • "phoneNumbers": [
    ],
  • "message": "string"
}

Send a one-off SMS with a custom SenderId.

Authorizations:
(ApiKeyBearer)
Request Body schema:

{ "phoneNumber": "recipient", "message": "text", "senderId": "CustomSender" }

phoneNumber
required
string non-empty
message
required
string non-empty
senderId
required
string [ 1 .. 11 ] characters

Responses

Request samples

Content type
{
  • "phoneNumber": "string",
  • "message": "string",
  • "senderId": "string"
}