Create Link

Create Link

POST /pay-link

Create Payment Link

cURL

curl --request POST \
  --url https://testapi.fractalpay.com/api/v1/pay-link \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "amount": "4.55",
  "merchant_key": "{{merchant_key}}",
  "order_id": "22111fdz",
  "invoice_number": "345"
}
'

import requests

url = "https://testapi.fractalpay.com/api/v1/pay-link"

payload = {
    "amount": "4.55",
    "merchant_key": "{{merchant_key}}",
    "order_id": "22111fdz",
    "invoice_number": "345"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amount: '4.55',
    merchant_key: '{{merchant_key}}',
    order_id: '22111fdz',
    invoice_number: '345'
  })
};

fetch('https://testapi.fractalpay.com/api/v1/pay-link', 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://testapi.fractalpay.com/api/v1/pay-link",
  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' => '4.55',
    'merchant_key' => '{{merchant_key}}',
    'order_id' => '22111fdz',
    'invoice_number' => '345'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Basic <encoded-value>",
    "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://testapi.fractalpay.com/api/v1/pay-link"

	payload := strings.NewReader("{\n  \"amount\": \"4.55\",\n  \"merchant_key\": \"{{merchant_key}}\",\n  \"order_id\": \"22111fdz\",\n  \"invoice_number\": \"345\"\n}")

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

	req.Header.Add("Authorization", "Basic <encoded-value>")
	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://testapi.fractalpay.com/api/v1/pay-link")
  .header("Authorization", "Basic <encoded-value>")
  .header("Content-Type", "application/json")
  .body("{\n  \"amount\": \"4.55\",\n  \"merchant_key\": \"{{merchant_key}}\",\n  \"order_id\": \"22111fdz\",\n  \"invoice_number\": \"345\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://testapi.fractalpay.com/api/v1/pay-link")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amount\": \"4.55\",\n  \"merchant_key\": \"{{merchant_key}}\",\n  \"order_id\": \"22111fdz\",\n  \"invoice_number\": \"345\"\n}"

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

201

{
  "data": {
    "order_id": "22111fdz",
    "payment_link": "https://testapi.fractalpay.com/authcheck-paymentlink/u6j3garacoj",
    "sales_id": "txn_c2e0adab55"
  },
  "message": "Quick Pay Order created successfully.",
  "result": true
}

Authorizations

Authorization · string · header · required

Use your Fractal API credentials.

Username = Client ID Password = Secret Key

Sandbox credentials can be generated from the Test Portal.

Body

application/json

amount · string · required

Example:

"4.55"

merchant_key · string · required

The merchant's unique key. Returned in the merchant_key field of the get merchants by client call.

Example:

"{{merchant_key}}"

order_id · string · required

Example:

"22111fdz"

invoice_number · string

Example:

"345"

allow_card · boolean · default: true

Allow card as a payment method. At least one of allow_card or allow_ach must be true — setting both to false will result in an error.

Example:

true

allow_ach · boolean · default: true

Allow ACH as a payment method. At least one of allow_card or allow_ach must be true — setting both to false will result in an error.

Example:

true

Response

201 - application/json

Create Link

data · object

Show child attributes

message · string

Example:

"Quick Pay Order created successfully."

result · boolean

Example:

true