Create a new transaction ( STABLE )
curl --request POST \
--url https://api.grailpay.com/3p/api/v1/transaction \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payer_uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"payee_uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"processor_mid": "234234234",
"amount": "100",
"transaction_fee": "1.2",
"client_reference_id": "adsssd",
"payout_delay_days_min": "1",
"speed": "fast",
"company_name": "Company-1",
"description": "lladsdf asldfs",
"addenda": "",
"source_bank_account": {
"uuid": "9c330a70-84de-46c3-a380-70b34799b1d3"
},
"destination_bank_account": {
"uuid": "9c330a70-84de-46c3-a380-70b34799b1d3"
}
}
'import requests
url = "https://api.grailpay.com/3p/api/v1/transaction"
payload = {
"payer_uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"payee_uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"processor_mid": "234234234",
"amount": "100",
"transaction_fee": "1.2",
"client_reference_id": "adsssd",
"payout_delay_days_min": "1",
"speed": "fast",
"company_name": "Company-1",
"description": "lladsdf asldfs",
"addenda": "",
"source_bank_account": { "uuid": "9c330a70-84de-46c3-a380-70b34799b1d3" },
"destination_bank_account": { "uuid": "9c330a70-84de-46c3-a380-70b34799b1d3" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payer_uuid: '9c330a70-84de-46c3-a380-70b34799b1d3',
payee_uuid: '9c330a70-84de-46c3-a380-70b34799b1d3',
processor_mid: '234234234',
amount: '100',
transaction_fee: '1.2',
client_reference_id: 'adsssd',
payout_delay_days_min: '1',
speed: 'fast',
company_name: 'Company-1',
description: 'lladsdf asldfs',
addenda: '',
source_bank_account: {uuid: '9c330a70-84de-46c3-a380-70b34799b1d3'},
destination_bank_account: {uuid: '9c330a70-84de-46c3-a380-70b34799b1d3'}
})
};
fetch('https://api.grailpay.com/3p/api/v1/transaction', 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.grailpay.com/3p/api/v1/transaction",
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([
'payer_uuid' => '9c330a70-84de-46c3-a380-70b34799b1d3',
'payee_uuid' => '9c330a70-84de-46c3-a380-70b34799b1d3',
'processor_mid' => '234234234',
'amount' => '100',
'transaction_fee' => '1.2',
'client_reference_id' => 'adsssd',
'payout_delay_days_min' => '1',
'speed' => 'fast',
'company_name' => 'Company-1',
'description' => 'lladsdf asldfs',
'addenda' => '',
'source_bank_account' => [
'uuid' => '9c330a70-84de-46c3-a380-70b34799b1d3'
],
'destination_bank_account' => [
'uuid' => '9c330a70-84de-46c3-a380-70b34799b1d3'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.grailpay.com/3p/api/v1/transaction"
payload := strings.NewReader("{\n \"payer_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"payee_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"processor_mid\": \"234234234\",\n \"amount\": \"100\",\n \"transaction_fee\": \"1.2\",\n \"client_reference_id\": \"adsssd\",\n \"payout_delay_days_min\": \"1\",\n \"speed\": \"fast\",\n \"company_name\": \"Company-1\",\n \"description\": \"lladsdf asldfs\",\n \"addenda\": \"\",\n \"source_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n },\n \"destination_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.grailpay.com/3p/api/v1/transaction")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payer_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"payee_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"processor_mid\": \"234234234\",\n \"amount\": \"100\",\n \"transaction_fee\": \"1.2\",\n \"client_reference_id\": \"adsssd\",\n \"payout_delay_days_min\": \"1\",\n \"speed\": \"fast\",\n \"company_name\": \"Company-1\",\n \"description\": \"lladsdf asldfs\",\n \"addenda\": \"\",\n \"source_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n },\n \"destination_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.grailpay.com/3p/api/v1/transaction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payer_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"payee_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"processor_mid\": \"234234234\",\n \"amount\": \"100\",\n \"transaction_fee\": \"1.2\",\n \"client_reference_id\": \"adsssd\",\n \"payout_delay_days_min\": \"1\",\n \"speed\": \"fast\",\n \"company_name\": \"Company-1\",\n \"description\": \"lladsdf asldfs\",\n \"addenda\": \"\",\n \"source_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n },\n \"destination_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "",
"data": {
"uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"payer_uuid": "7d021f9a-b5f4-4668-8d78-0f448f55f984",
"payee_uuid": "ec82930a-b59e-4ed2-83dd-0f041bfa5baa",
"transaction_status": "PAYOUT_COMPLETE",
"currency": "USD",
"amount": 57163,
"transaction_fee": 0,
"client_reference_id": "stageN5@123",
"payout_delay_days": 0,
"company_name": "a-z, A-Z, 12-'3.",
"description": null,
"addenda": null,
"type": "api",
"spped": "sameday",
"processor_mid": "123131123",
"batch_payout_id": "78e84f6a-c36e-4c9e-86bf-6ff4a492be90",
"capture_status": "CAPTURE_COMPLETE",
"payout_status": "PAYOUT_COMPLETE",
"clawback_status": null,
"reverse_payout_status": null,
"failure_code": null,
"failure_reason": null,
"cancel_reason": null,
"payer_bank_account": {
"uuid": "9c3306a6-743f-4f8f-9a33-dcd081a06204",
"aggregator_type": "bank_link"
},
"payee_bank_account": {
"uuid": "9c33090b-c0fb-42ce-9ad8-921665d15a90",
"aggregator_type": "bank_link"
},
"payout_ach_return_code": "R01",
"payout_failure_reason": "Insufficient funds",
"trace_ids": {
"capture_trace_id": "ach_92lhg3vbf76qxzp",
"payout_trace_id": "ach_57ytkdw84mncxvq",
"reverse_payout_trace_id": "",
"refunds": [
{
"refund_uuid": "",
"refund_capture_trace_id": "",
"refund_payout_trace_id": ""
}
]
},
"created_at": "2024-06-03 15:58:44",
"updated_at": "2024-06-04 18:30:30"
},
"errors": null,
"error_code": null
}{
"status": false,
"message": "Invalid Token",
"data": null,
"errors": null,
"error_code": null
}{
"status": true,
"message": "Forbidden",
"data": "",
"errors": null,
"error_code": null
}{
"status": true,
"message": "Not Found",
"data": "",
"errors": null,
"error_code": null
}{
"status": true,
"message": "Unprocessable Entity",
"data": "",
"errors": null,
"error_code": null
}Transactions
Create a new transaction ( STABLE )
Once authenticated, the client application can send a request to create a new transaction by providing relevant details such as the payment amount, sender and receiver. GrailPay will then return a UUID, which serves as the unique identifier and can be used to fetch the details and status of the transaction. Please note that only one transaction can be created per request.
POST
/
3p
/
api
/
v1
/
transaction
Create a new transaction ( STABLE )
curl --request POST \
--url https://api.grailpay.com/3p/api/v1/transaction \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"payer_uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"payee_uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"processor_mid": "234234234",
"amount": "100",
"transaction_fee": "1.2",
"client_reference_id": "adsssd",
"payout_delay_days_min": "1",
"speed": "fast",
"company_name": "Company-1",
"description": "lladsdf asldfs",
"addenda": "",
"source_bank_account": {
"uuid": "9c330a70-84de-46c3-a380-70b34799b1d3"
},
"destination_bank_account": {
"uuid": "9c330a70-84de-46c3-a380-70b34799b1d3"
}
}
'import requests
url = "https://api.grailpay.com/3p/api/v1/transaction"
payload = {
"payer_uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"payee_uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"processor_mid": "234234234",
"amount": "100",
"transaction_fee": "1.2",
"client_reference_id": "adsssd",
"payout_delay_days_min": "1",
"speed": "fast",
"company_name": "Company-1",
"description": "lladsdf asldfs",
"addenda": "",
"source_bank_account": { "uuid": "9c330a70-84de-46c3-a380-70b34799b1d3" },
"destination_bank_account": { "uuid": "9c330a70-84de-46c3-a380-70b34799b1d3" }
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
payer_uuid: '9c330a70-84de-46c3-a380-70b34799b1d3',
payee_uuid: '9c330a70-84de-46c3-a380-70b34799b1d3',
processor_mid: '234234234',
amount: '100',
transaction_fee: '1.2',
client_reference_id: 'adsssd',
payout_delay_days_min: '1',
speed: 'fast',
company_name: 'Company-1',
description: 'lladsdf asldfs',
addenda: '',
source_bank_account: {uuid: '9c330a70-84de-46c3-a380-70b34799b1d3'},
destination_bank_account: {uuid: '9c330a70-84de-46c3-a380-70b34799b1d3'}
})
};
fetch('https://api.grailpay.com/3p/api/v1/transaction', 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.grailpay.com/3p/api/v1/transaction",
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([
'payer_uuid' => '9c330a70-84de-46c3-a380-70b34799b1d3',
'payee_uuid' => '9c330a70-84de-46c3-a380-70b34799b1d3',
'processor_mid' => '234234234',
'amount' => '100',
'transaction_fee' => '1.2',
'client_reference_id' => 'adsssd',
'payout_delay_days_min' => '1',
'speed' => 'fast',
'company_name' => 'Company-1',
'description' => 'lladsdf asldfs',
'addenda' => '',
'source_bank_account' => [
'uuid' => '9c330a70-84de-46c3-a380-70b34799b1d3'
],
'destination_bank_account' => [
'uuid' => '9c330a70-84de-46c3-a380-70b34799b1d3'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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.grailpay.com/3p/api/v1/transaction"
payload := strings.NewReader("{\n \"payer_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"payee_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"processor_mid\": \"234234234\",\n \"amount\": \"100\",\n \"transaction_fee\": \"1.2\",\n \"client_reference_id\": \"adsssd\",\n \"payout_delay_days_min\": \"1\",\n \"speed\": \"fast\",\n \"company_name\": \"Company-1\",\n \"description\": \"lladsdf asldfs\",\n \"addenda\": \"\",\n \"source_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n },\n \"destination_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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.grailpay.com/3p/api/v1/transaction")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"payer_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"payee_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"processor_mid\": \"234234234\",\n \"amount\": \"100\",\n \"transaction_fee\": \"1.2\",\n \"client_reference_id\": \"adsssd\",\n \"payout_delay_days_min\": \"1\",\n \"speed\": \"fast\",\n \"company_name\": \"Company-1\",\n \"description\": \"lladsdf asldfs\",\n \"addenda\": \"\",\n \"source_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n },\n \"destination_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.grailpay.com/3p/api/v1/transaction")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"payer_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"payee_uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\",\n \"processor_mid\": \"234234234\",\n \"amount\": \"100\",\n \"transaction_fee\": \"1.2\",\n \"client_reference_id\": \"adsssd\",\n \"payout_delay_days_min\": \"1\",\n \"speed\": \"fast\",\n \"company_name\": \"Company-1\",\n \"description\": \"lladsdf asldfs\",\n \"addenda\": \"\",\n \"source_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n },\n \"destination_bank_account\": {\n \"uuid\": \"9c330a70-84de-46c3-a380-70b34799b1d3\"\n }\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "",
"data": {
"uuid": "9c330a70-84de-46c3-a380-70b34799b1d3",
"payer_uuid": "7d021f9a-b5f4-4668-8d78-0f448f55f984",
"payee_uuid": "ec82930a-b59e-4ed2-83dd-0f041bfa5baa",
"transaction_status": "PAYOUT_COMPLETE",
"currency": "USD",
"amount": 57163,
"transaction_fee": 0,
"client_reference_id": "stageN5@123",
"payout_delay_days": 0,
"company_name": "a-z, A-Z, 12-'3.",
"description": null,
"addenda": null,
"type": "api",
"spped": "sameday",
"processor_mid": "123131123",
"batch_payout_id": "78e84f6a-c36e-4c9e-86bf-6ff4a492be90",
"capture_status": "CAPTURE_COMPLETE",
"payout_status": "PAYOUT_COMPLETE",
"clawback_status": null,
"reverse_payout_status": null,
"failure_code": null,
"failure_reason": null,
"cancel_reason": null,
"payer_bank_account": {
"uuid": "9c3306a6-743f-4f8f-9a33-dcd081a06204",
"aggregator_type": "bank_link"
},
"payee_bank_account": {
"uuid": "9c33090b-c0fb-42ce-9ad8-921665d15a90",
"aggregator_type": "bank_link"
},
"payout_ach_return_code": "R01",
"payout_failure_reason": "Insufficient funds",
"trace_ids": {
"capture_trace_id": "ach_92lhg3vbf76qxzp",
"payout_trace_id": "ach_57ytkdw84mncxvq",
"reverse_payout_trace_id": "",
"refunds": [
{
"refund_uuid": "",
"refund_capture_trace_id": "",
"refund_payout_trace_id": ""
}
]
},
"created_at": "2024-06-03 15:58:44",
"updated_at": "2024-06-04 18:30:30"
},
"errors": null,
"error_code": null
}{
"status": false,
"message": "Invalid Token",
"data": null,
"errors": null,
"error_code": null
}{
"status": true,
"message": "Forbidden",
"data": "",
"errors": null,
"error_code": null
}{
"status": true,
"message": "Not Found",
"data": "",
"errors": null,
"error_code": null
}{
"status": true,
"message": "Unprocessable Entity",
"data": "",
"errors": null,
"error_code": null
}Authorizations
Token-based authentication using Authorization: Bearer <YOUR_API_KEY> provided by the GrailPay Support Team.
Body
application/json
Example:
"9c330a70-84de-46c3-a380-70b34799b1d3"
Example:
"9c330a70-84de-46c3-a380-70b34799b1d3"
Example:
"234234234"
Example:
"100"
Example:
"1.2"
Example:
"adsssd"
Example:
"1"
Example:
"fast"
Example:
"Company-1"
Example:
"lladsdf asldfs"
Example:
""
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
BeforePayout, AfterPayout ⌘I