using System.Net.Http;

using var client = new HttpClient();
var response = await client.GetAsync("https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/orde");
Console.WriteLine(await response.Content.ReadAsStringAsync());

curl --request POST \
  --url https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order \
  --header 'Content-Type: application/json' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '
{
  "amount": 1000,
  "description": "VANS+",
  "currency": "ETB",
  "customerName": "test",
  "customerPhoneNumber": "+251987654567",
  "items": [
    {
      "productId": "6812220726f547936d6c1976",
      "quantity": 1,
      "item_name": "mobile",
      "unit_price": 500
    }
  ],
  "callbackURL": "https://example.com/start_pay_callback",
  "customerEmail": "test12@gmail.com",
  "expiredAt": "2025-07-01T23:59:59Z",
  "redirectUrl": "https://google.com",
  "metadata": {
    "order_reference": "ORD-2025-001",
    "custom_field": "any value"
  }
}
'

import requests

url = "https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order"

payload = {
    "amount": 1000,
    "description": "VANS+",
    "currency": "ETB",
    "customerName": "test",
    "customerPhoneNumber": "+251987654567",
    "items": [
        {
            "productId": "6812220726f547936d6c1976",
            "quantity": 1,
            "item_name": "mobile",
            "unit_price": 500
        }
    ],
    "callbackURL": "https://example.com/start_pay_callback",
    "customerEmail": "test12@gmail.com",
    "expiredAt": "2025-07-01T23:59:59Z",
    "redirectUrl": "https://google.com",
    "metadata": {
        "order_reference": "ORD-2025-001",
        "custom_field": "any value"
    }
}
headers = {
    "x-api-secret": "<x-api-secret>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-secret': '<x-api-secret>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 1000,
    description: 'VANS+',
    currency: 'ETB',
    customerName: 'test',
    customerPhoneNumber: '+251987654567',
    items: [
      {
        productId: '6812220726f547936d6c1976',
        quantity: 1,
        item_name: 'mobile',
        unit_price: 500
      }
    ],
    callbackURL: 'https://example.com/start_pay_callback',
    customerEmail: 'test12@gmail.com',
    expiredAt: '2025-07-01T23:59:59Z',
    redirectUrl: 'https://google.com',
    metadata: {order_reference: 'ORD-2025-001', custom_field: 'any value'}
  })
};

fetch('https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 1000,
    'description' => 'VANS+',
    'currency' => 'ETB',
    'customerName' => 'test',
    'customerPhoneNumber' => '+251987654567',
    'items' => [
        [
                'productId' => '6812220726f547936d6c1976',
                'quantity' => 1,
                'item_name' => 'mobile',
                'unit_price' => 500
        ]
    ],
    'callbackURL' => 'https://example.com/start_pay_callback',
    'customerEmail' => 'test12@gmail.com',
    'expiredAt' => '2025-07-01T23:59:59Z',
    'redirectUrl' => 'https://google.com',
    'metadata' => [
        'order_reference' => 'ORD-2025-001',
        'custom_field' => 'any value'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-secret: <x-api-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order"

	payload := strings.NewReader("{\n  \"amount\": 1000,\n  \"description\": \"VANS+\",\n  \"currency\": \"ETB\",\n  \"customerName\": \"test\",\n  \"customerPhoneNumber\": \"+251987654567\",\n  \"items\": [\n    {\n      \"productId\": \"6812220726f547936d6c1976\",\n      \"quantity\": 1,\n      \"item_name\": \"mobile\",\n      \"unit_price\": 500\n    }\n  ],\n  \"callbackURL\": \"https://example.com/start_pay_callback\",\n  \"customerEmail\": \"test12@gmail.com\",\n  \"expiredAt\": \"2025-07-01T23:59:59Z\",\n  \"redirectUrl\": \"https://google.com\",\n  \"metadata\": {\n    \"order_reference\": \"ORD-2025-001\",\n    \"custom_field\": \"any value\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-secret", "<x-api-secret>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order")
  .header("x-api-secret", "<x-api-secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1000,\n  \"description\": \"VANS+\",\n  \"currency\": \"ETB\",\n  \"customerName\": \"test\",\n  \"customerPhoneNumber\": \"+251987654567\",\n  \"items\": [\n    {\n      \"productId\": \"6812220726f547936d6c1976\",\n      \"quantity\": 1,\n      \"item_name\": \"mobile\",\n      \"unit_price\": 500\n    }\n  ],\n  \"callbackURL\": \"https://example.com/start_pay_callback\",\n  \"customerEmail\": \"test12@gmail.com\",\n  \"expiredAt\": \"2025-07-01T23:59:59Z\",\n  \"redirectUrl\": \"https://google.com\",\n  \"metadata\": {\n    \"order_reference\": \"ORD-2025-001\",\n    \"custom_field\": \"any value\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 1000,\n  \"description\": \"VANS+\",\n  \"currency\": \"ETB\",\n  \"customerName\": \"test\",\n  \"customerPhoneNumber\": \"+251987654567\",\n  \"items\": [\n    {\n      \"productId\": \"6812220726f547936d6c1976\",\n      \"quantity\": 1,\n      \"item_name\": \"mobile\",\n      \"unit_price\": 500\n    }\n  ],\n  \"callbackURL\": \"https://example.com/start_pay_callback\",\n  \"customerEmail\": \"test12@gmail.com\",\n  \"expiredAt\": \"2025-07-01T23:59:59Z\",\n  \"redirectUrl\": \"https://google.com\",\n  \"metadata\": {\n    \"order_reference\": \"ORD-2025-001\",\n    \"custom_field\": \"any value\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "timestamp": "2023-11-07T05:31:56Z",
  "message": "Order created successfully",
  "data": {
    "order_id": "<string>",
    "status": "<string>",
    "amount": 123,
    "currency": "<string>",
    "payment_url": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "metadata": {
      "merchant_id": "12345",
      "customer_id": "cust_67890",
      "order_reference": "ORD-2025-001"
    }
  }
}

{
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "BadRequestException",
    "message": "Missing required payload data, pk and payload is required"
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "GEN_004",
    "message": "An unexpected server error occurred."
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "ABC_001",
    "message": "not found"
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "GEN_004",
    "message": "An unexpected server error occurred."
  }
}

POST

trdp

order

using System.Net.Http;

using var client = new HttpClient();
var response = await client.GetAsync("https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/orde");
Console.WriteLine(await response.Content.ReadAsStringAsync());

curl --request POST \
  --url https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order \
  --header 'Content-Type: application/json' \
  --header 'x-api-secret: <x-api-secret>' \
  --data '
{
  "amount": 1000,
  "description": "VANS+",
  "currency": "ETB",
  "customerName": "test",
  "customerPhoneNumber": "+251987654567",
  "items": [
    {
      "productId": "6812220726f547936d6c1976",
      "quantity": 1,
      "item_name": "mobile",
      "unit_price": 500
    }
  ],
  "callbackURL": "https://example.com/start_pay_callback",
  "customerEmail": "test12@gmail.com",
  "expiredAt": "2025-07-01T23:59:59Z",
  "redirectUrl": "https://google.com",
  "metadata": {
    "order_reference": "ORD-2025-001",
    "custom_field": "any value"
  }
}
'

import requests

url = "https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order"

payload = {
    "amount": 1000,
    "description": "VANS+",
    "currency": "ETB",
    "customerName": "test",
    "customerPhoneNumber": "+251987654567",
    "items": [
        {
            "productId": "6812220726f547936d6c1976",
            "quantity": 1,
            "item_name": "mobile",
            "unit_price": 500
        }
    ],
    "callbackURL": "https://example.com/start_pay_callback",
    "customerEmail": "test12@gmail.com",
    "expiredAt": "2025-07-01T23:59:59Z",
    "redirectUrl": "https://google.com",
    "metadata": {
        "order_reference": "ORD-2025-001",
        "custom_field": "any value"
    }
}
headers = {
    "x-api-secret": "<x-api-secret>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-secret': '<x-api-secret>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: 1000,
    description: 'VANS+',
    currency: 'ETB',
    customerName: 'test',
    customerPhoneNumber: '+251987654567',
    items: [
      {
        productId: '6812220726f547936d6c1976',
        quantity: 1,
        item_name: 'mobile',
        unit_price: 500
      }
    ],
    callbackURL: 'https://example.com/start_pay_callback',
    customerEmail: 'test12@gmail.com',
    expiredAt: '2025-07-01T23:59:59Z',
    redirectUrl: 'https://google.com',
    metadata: {order_reference: 'ORD-2025-001', custom_field: 'any value'}
  })
};

fetch('https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'amount' => 1000,
    'description' => 'VANS+',
    'currency' => 'ETB',
    'customerName' => 'test',
    'customerPhoneNumber' => '+251987654567',
    'items' => [
        [
                'productId' => '6812220726f547936d6c1976',
                'quantity' => 1,
                'item_name' => 'mobile',
                'unit_price' => 500
        ]
    ],
    'callbackURL' => 'https://example.com/start_pay_callback',
    'customerEmail' => 'test12@gmail.com',
    'expiredAt' => '2025-07-01T23:59:59Z',
    'redirectUrl' => 'https://google.com',
    'metadata' => [
        'order_reference' => 'ORD-2025-001',
        'custom_field' => 'any value'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-secret: <x-api-secret>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order"

	payload := strings.NewReader("{\n  \"amount\": 1000,\n  \"description\": \"VANS+\",\n  \"currency\": \"ETB\",\n  \"customerName\": \"test\",\n  \"customerPhoneNumber\": \"+251987654567\",\n  \"items\": [\n    {\n      \"productId\": \"6812220726f547936d6c1976\",\n      \"quantity\": 1,\n      \"item_name\": \"mobile\",\n      \"unit_price\": 500\n    }\n  ],\n  \"callbackURL\": \"https://example.com/start_pay_callback\",\n  \"customerEmail\": \"test12@gmail.com\",\n  \"expiredAt\": \"2025-07-01T23:59:59Z\",\n  \"redirectUrl\": \"https://google.com\",\n  \"metadata\": {\n    \"order_reference\": \"ORD-2025-001\",\n    \"custom_field\": \"any value\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-secret", "<x-api-secret>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order")
  .header("x-api-secret", "<x-api-secret>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": 1000,\n  \"description\": \"VANS+\",\n  \"currency\": \"ETB\",\n  \"customerName\": \"test\",\n  \"customerPhoneNumber\": \"+251987654567\",\n  \"items\": [\n    {\n      \"productId\": \"6812220726f547936d6c1976\",\n      \"quantity\": 1,\n      \"item_name\": \"mobile\",\n      \"unit_price\": 500\n    }\n  ],\n  \"callbackURL\": \"https://example.com/start_pay_callback\",\n  \"customerEmail\": \"test12@gmail.com\",\n  \"expiredAt\": \"2025-07-01T23:59:59Z\",\n  \"redirectUrl\": \"https://google.com\",\n  \"metadata\": {\n    \"order_reference\": \"ORD-2025-001\",\n    \"custom_field\": \"any value\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.starpayethiopia.com/v1/starpay-api/trdp/order")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-secret"] = '<x-api-secret>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": 1000,\n  \"description\": \"VANS+\",\n  \"currency\": \"ETB\",\n  \"customerName\": \"test\",\n  \"customerPhoneNumber\": \"+251987654567\",\n  \"items\": [\n    {\n      \"productId\": \"6812220726f547936d6c1976\",\n      \"quantity\": 1,\n      \"item_name\": \"mobile\",\n      \"unit_price\": 500\n    }\n  ],\n  \"callbackURL\": \"https://example.com/start_pay_callback\",\n  \"customerEmail\": \"test12@gmail.com\",\n  \"expiredAt\": \"2025-07-01T23:59:59Z\",\n  \"redirectUrl\": \"https://google.com\",\n  \"metadata\": {\n    \"order_reference\": \"ORD-2025-001\",\n    \"custom_field\": \"any value\"\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "status": "success",
  "timestamp": "2023-11-07T05:31:56Z",
  "message": "Order created successfully",
  "data": {
    "order_id": "<string>",
    "status": "<string>",
    "amount": 123,
    "currency": "<string>",
    "payment_url": "<string>",
    "expires_at": "2023-11-07T05:31:56Z",
    "metadata": {
      "merchant_id": "12345",
      "customer_id": "cust_67890",
      "order_reference": "ORD-2025-001"
    }
  }
}

{
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "BadRequestException",
    "message": "Missing required payload data, pk and payload is required"
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "GEN_004",
    "message": "An unexpected server error occurred."
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "ABC_001",
    "message": "not found"
  }
}

{
  "message": "Something wrong",
  "status": "error",
  "timestamp": "2025-05-07T07:31:30.824Z",
  "path": "/v2/starpay-api/",
  "error": {
    "code": "GEN_004",
    "message": "An unexpected server error occurred."
  }
}

Create a Transaction

Creates a new payment session and returns a payment URL that can be used to collect payment from a customer. Use this endpoint whenever you want to initiate a payment through StarPay.

Endpoint

POST /trdp/order

Authentication

Include your API secret in the request header. Header

x-api-secret (string) — Required for merchant endpoints. Your StarPay API secret key. Generate this key from the Merchant Portal under API Keys.

Example:

x-api-secret: X/2uxXAjJqaai5gRzXHzcFPcx9E6B3pibBbVSoce1U23q5hR2Sr5pxlh6WLQZBep

Request Body

amount

The amount to be charged to the customer. Type: number — Required Example:

description

A short description of the payment. This may be displayed to the customer during checkout. Type: string — Required Example:

"Purchase of VANS Shoes"

currency

The currency used for the transaction. Currently supported: ETB Type: string — Required Example:

"ETB"

customerName

The full name of the customer making the payment. Type: string — Required Example:

"John Doe"

customerPhoneNumber

The customer’s phone number. This number may be used for payment verification and payment initiation. Type: string — Required Example:

"+251987654567"

items

List of products or services included in the transaction. Type: array — Required Example:

[
	{
		"name": "VANS Shoe",
		"quantity": 1,
		"price": 1000
	}
]

callbackURL

A server-to-server notification URL that StarPay will call when the payment status changes. Use this to automatically update your system after a successful or failed payment. Type: string — Optional Example:

"https://example.com/webhooks/starpay"

Successful Callback Example

{
	"billRefNo": "33WJ8946WB",
	"status": "PAID",
	"timestamp": "2025-12-10T11:05:37.566Z",
	"message": "Payment successful",
	"merchantId": "6888dc21ee7cbfe63657144f",
	"customerId": "656445e6-20fa-440d-b8c9-0a588d1ca05b",
	"externalReferenceId": "CLA9SR5XR9",
	"amount": 1,
	"payment_type": "USSD_PUSH",
	"receipt_url": "https://receipt.starpayethiopia.com/receiptqa/WST-33WJ8946WB"
}

Failed Callback Example

{
	"billRefNo": "5I974ZLE60",
	"status": "FAILED",
	"message": "Payment failed"
}

redirectUrl

The URL where customers will be redirected after completing payment. Typically a success or order confirmation page. Type: string — Optional Example:

"https://yourstore.com/payment-success"

customerEmail

Customer email address. Type: string — Optional Example:

"customer@example.com"

expiredAt

The date and time when the payment session expires (ISO 8601 format). After expiration, the customer can no longer complete the payment. Type: string — Optional Example:

"2025-07-01T23:59:59Z"

metadata

Additional custom data associated with the transaction. Returned in callbacks and transaction status responses. Type: object — Optional Example:

{
	"order_reference": "ORD-2025-001",
	"customer_type": "premium"
}

Example Request

curl --request POST \
	--url https://api.starpayethiopia.com/trdp/order \
	--header 'Content-Type: application/json' \
	--header 'x-api-secret: YOUR_API_SECRET' \
	--data '{
		"amount": 1000,
		"currency": "ETB",
		"description": "Purchase of VANS Shoes",
		"customerName": "John Doe",
		"customerPhoneNumber": "+251987654567",
		"callbackURL": "https://example.com/webhooks/starpay",
		"redirectUrl": "https://yourstore.com/payment-success"
	}'

Response

Success Response

{
	"status": "success",
	"timestamp": "2025-07-01T10:30:00Z",
	"message": "Order created successfully",
	"data": {
		"billRefNo": "33WJ8946WB",
		"paymentUrl": "https://pay.starpayethiopia.com/checkout/33WJ8946WB"
	}
}

Next Steps

After creating a transaction:

Redirect the customer to the paymentUrl.
Wait for a callback notification from StarPay.
Verify the callback signature using your Callback Key (see Callback Signature Verification).
Update the payment status in your system.
Optionally query the Transaction Status API for additional verification.

This endpoint documentation follows the structure developers expect: overview, authentication, request parameters, examples, and webhook guidance.

Headers

x-api-secret

string

required

The App Secret provided by CBE.

Example:

"X/2uxXAjJqaai5gRzXHzcFPcx9E6B3pibBbVSoce1U23q5hR2Sr5pxlh6WLQZBep"

Body

application/json

The request body(payload) includes the following fields:

api_secret
callbackURL If you want to receive the customer back in your application after the transaction, you can provide a callback URL. Starpay will automatically redirect the user to your URL when the payment is completed successfully or Failed.

If you provide a callbackURL, StarPay will send the following response to that URL after a successful payment.

{
 
 billRefNo: '33WJ8946WB',
 status: 'PAID' OR 'SETTLED',
 timestamp: '2025-12-10T11:05:37.566Z',
 message: 'Payment successful',
 merchantId: '6888dc21ee7cbfe63657144f',
 customerId: '656445e6-20fa-440d-b8c9-0a588d1ca05b',
 externalReferenceId: 'CLA9SR5XR9',
 amount: 1,
 payment_type: 'USSD_PUSH',
 receipt_url: 'https://receipt.starpayethiopia.com/receiptqa/WST-33WJ8946WB'
}

The error response for failed payments.

{
 
  billRefNo: '5I974ZLE60',
  status: 'FAILED',
  message: 'Payment failed'
}

Create session.

amount

number

required

Example:

1000

description

string

required

Example:

"VANS+"

currency

string

required

Example:

"ETB"

customerName

string

required

Example:

"test"

customerPhoneNumber

string

required

Example:

"+251987654567"

items

object[]

required

Show child attributes

callbackURL

string

Example:

"https://example.com/start_pay_callback"

customerEmail

string<email>

Example:

"test12@gmail.com"

expiredAt

string

Example:

"2025-07-01T23:59:59Z"

redirectUrl

string

-The URL where the payment gateway will automatically redirect the customer after a successful payment. This is used to bring the customer back to your website or app to show a confirmation page, receipt, or next steps.

Example:

"https://google.com"

metadata

object

Additional custom information that you can send with the order. This field allows you to include extra data (e.g., order reference, custom fields) that will be returned in the payment response and webhook notifications.

Example:

{
  "order_reference": "ORD-2025-001",
  "custom_field": "any value"
}

Response

The request was successful, and a new resource was created.

status

string

required

Example:

"success"

timestamp

string<date-time>

required

message

string

required

Example:

"Order created successfully"

data

object

required

Show child attributes

Introduction

Payment Verification

Get started

Api Reference

Create Transaction

Create a Transaction

Endpoint

Authentication

Request Body

amount

description

currency

customerName

customerPhoneNumber

items

callbackURL

Successful Callback Example

Failed Callback Example

redirectUrl

customerEmail

expiredAt

metadata

Example Request

Response

Success Response

Next Steps

Headers

Body

If you provide a callbackURL, StarPay will send the following response to that URL after a successful payment.

The error response for failed payments.

Response

​Create a Transaction

​Endpoint

​Authentication

​Request Body

​amount

​description

​currency

​customerName

​customerPhoneNumber

​items

​callbackURL

​Successful Callback Example

​Failed Callback Example

​redirectUrl

​customerEmail

​expiredAt

​metadata

​Example Request

​Response

​Success Response

​Next Steps

Headers

Body

If you provide a callbackURL, StarPay will send the following response to that URL after a successful payment.

The error response for failed payments.

Response

Create a Transaction

Endpoint

Authentication

Request Body

amount

description

currency

customerName

customerPhoneNumber

items

callbackURL

Successful Callback Example

Failed Callback Example

redirectUrl

customerEmail

expiredAt

metadata

Example Request

Response

Success Response

Next Steps