Create hosted payment
curl --request POST \
--url https://api.orafi.app/v1/transactions/payment \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": 100,
"currency": "USDC",
"network": "SUI",
"customer": {
"fullname": "John Doe",
"email": "john@example.com"
},
"customerId": "cmxsds23...",
"txRef": "cmxsds...",
"redirectUrl": "www.example.com"
}
'import requests
url = "https://api.orafi.app/v1/transactions/payment"
payload = {
"amount": 100,
"currency": "USDC",
"network": "SUI",
"customer": {
"fullname": "John Doe",
"email": "john@example.com"
},
"customerId": "cmxsds23...",
"txRef": "cmxsds...",
"redirectUrl": "www.example.com"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 100,
currency: 'USDC',
network: 'SUI',
customer: {fullname: 'John Doe', email: 'john@example.com'},
customerId: 'cmxsds23...',
txRef: 'cmxsds...',
redirectUrl: 'www.example.com'
})
};
fetch('https://api.orafi.app/v1/transactions/payment', 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://api.orafi.app/v1/transactions/payment",
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' => 100,
'currency' => 'USDC',
'network' => 'SUI',
'customer' => [
'fullname' => 'John Doe',
'email' => 'john@example.com'
],
'customerId' => 'cmxsds23...',
'txRef' => 'cmxsds...',
'redirectUrl' => 'www.example.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.orafi.app/v1/transactions/payment"
payload := strings.NewReader("{\n \"amount\": 100,\n \"currency\": \"USDC\",\n \"network\": \"SUI\",\n \"customer\": {\n \"fullname\": \"John Doe\",\n \"email\": \"john@example.com\"\n },\n \"customerId\": \"cmxsds23...\",\n \"txRef\": \"cmxsds...\",\n \"redirectUrl\": \"www.example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.orafi.app/v1/transactions/payment")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 100,\n \"currency\": \"USDC\",\n \"network\": \"SUI\",\n \"customer\": {\n \"fullname\": \"John Doe\",\n \"email\": \"john@example.com\"\n },\n \"customerId\": \"cmxsds23...\",\n \"txRef\": \"cmxsds...\",\n \"redirectUrl\": \"www.example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orafi.app/v1/transactions/payment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 100,\n \"currency\": \"USDC\",\n \"network\": \"SUI\",\n \"customer\": {\n \"fullname\": \"John Doe\",\n \"email\": \"john@example.com\"\n },\n \"customerId\": \"cmxsds23...\",\n \"txRef\": \"cmxsds...\",\n \"redirectUrl\": \"www.example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Payment created successfully",
"data": {
"id": "payment_abc123",
"amount": 100,
"amountInUSDC": 100,
"token": "USDC",
"depositAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
"txRef": "tx_ref_123",
"status": "CONFIRMED",
"paymentMethod": "HOSTED_CHECKOUT",
"subscriptionId": "<string>",
"subscription": {
"id": "sub_abc123",
"customerId": "<string>",
"planId": "<string>",
"network": "SUI",
"status": "PENDING",
"startsAt": "2023-11-07T05:31:56Z",
"endsAt": "2023-11-07T05:31:56Z",
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"redirectUrl": "https://example.com/success",
"paylinkId": "<string>",
"customerId": "<string>",
"transactionId": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"message": "Validation error message"
}{
"success": false,
"message": "Unauthorized access"
}Payments
Create Payment
Create a new hosted payment. Requires API key authentication.
POST
/
transactions
/
payment
Create hosted payment
curl --request POST \
--url https://api.orafi.app/v1/transactions/payment \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": 100,
"currency": "USDC",
"network": "SUI",
"customer": {
"fullname": "John Doe",
"email": "john@example.com"
},
"customerId": "cmxsds23...",
"txRef": "cmxsds...",
"redirectUrl": "www.example.com"
}
'import requests
url = "https://api.orafi.app/v1/transactions/payment"
payload = {
"amount": 100,
"currency": "USDC",
"network": "SUI",
"customer": {
"fullname": "John Doe",
"email": "john@example.com"
},
"customerId": "cmxsds23...",
"txRef": "cmxsds...",
"redirectUrl": "www.example.com"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: 100,
currency: 'USDC',
network: 'SUI',
customer: {fullname: 'John Doe', email: 'john@example.com'},
customerId: 'cmxsds23...',
txRef: 'cmxsds...',
redirectUrl: 'www.example.com'
})
};
fetch('https://api.orafi.app/v1/transactions/payment', 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://api.orafi.app/v1/transactions/payment",
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' => 100,
'currency' => 'USDC',
'network' => 'SUI',
'customer' => [
'fullname' => 'John Doe',
'email' => 'john@example.com'
],
'customerId' => 'cmxsds23...',
'txRef' => 'cmxsds...',
'redirectUrl' => 'www.example.com'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://api.orafi.app/v1/transactions/payment"
payload := strings.NewReader("{\n \"amount\": 100,\n \"currency\": \"USDC\",\n \"network\": \"SUI\",\n \"customer\": {\n \"fullname\": \"John Doe\",\n \"email\": \"john@example.com\"\n },\n \"customerId\": \"cmxsds23...\",\n \"txRef\": \"cmxsds...\",\n \"redirectUrl\": \"www.example.com\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://api.orafi.app/v1/transactions/payment")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 100,\n \"currency\": \"USDC\",\n \"network\": \"SUI\",\n \"customer\": {\n \"fullname\": \"John Doe\",\n \"email\": \"john@example.com\"\n },\n \"customerId\": \"cmxsds23...\",\n \"txRef\": \"cmxsds...\",\n \"redirectUrl\": \"www.example.com\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.orafi.app/v1/transactions/payment")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 100,\n \"currency\": \"USDC\",\n \"network\": \"SUI\",\n \"customer\": {\n \"fullname\": \"John Doe\",\n \"email\": \"john@example.com\"\n },\n \"customerId\": \"cmxsds23...\",\n \"txRef\": \"cmxsds...\",\n \"redirectUrl\": \"www.example.com\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Payment created successfully",
"data": {
"id": "payment_abc123",
"amount": 100,
"amountInUSDC": 100,
"token": "USDC",
"depositAddress": "0x742d35Cc6634C0532925a3b844Bc9e7595f0bEb",
"txRef": "tx_ref_123",
"status": "CONFIRMED",
"paymentMethod": "HOSTED_CHECKOUT",
"subscriptionId": "<string>",
"subscription": {
"id": "sub_abc123",
"customerId": "<string>",
"planId": "<string>",
"network": "SUI",
"status": "PENDING",
"startsAt": "2023-11-07T05:31:56Z",
"endsAt": "2023-11-07T05:31:56Z",
"canceledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
},
"redirectUrl": "https://example.com/success",
"paylinkId": "<string>",
"customerId": "<string>",
"transactionId": "<string>",
"createdAt": "2023-11-07T05:31:56Z"
}
}{
"success": false,
"message": "Validation error message"
}{
"success": false,
"message": "Unauthorized access"
}Authorizations
API key for merchant authentication required for most endpoints
Body
application/json
Payment amount
Example:
100
Payment currency
Example:
"USDC"
Network for payment
Available options:
SUI Example:
"SUI"
Customer information (optional)
Show child attributes
Show child attributes
Existing customer ID (optional)
Example:
"cmxsds23..."
Unique transaction reference
Example:
"cmxsds..."
URL to redirect after payment
Example:
"www.example.com"
