Update Payment Link

Update a payment link

curl --request PATCH \
  --url https://sandbox-api.kotanipay.io/api/v3/payment-links/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "enabledPaymentMethods": [],
  "paymentMethodConfig": {
    "mobileMoneyProviders": [
      "<string>"
    ],
    "mobileMoneyCurrencies": [
      "KES",
      "GHS"
    ],
    "mobileMoneyCountries": [
      "<string>"
    ],
    "supportedCurrencies": [
      "<string>"
    ],
    "cryptoNetworks": [
      "<string>"
    ],
    "cryptoCurrencies": [
      "USDT",
      "USDC"
    ],
    "cardCurrencies": [
      "<string>"
    ],
    "cardCountries": [
      "<string>"
    ],
    "bankCurrencies": [
      "<string>"
    ],
    "bankCountries": [
      "<string>"
    ]
  },
  "maxUses": 123,
  "expiresAt": "2023-11-07T05:31:56Z",
  "callbackUrl": "<string>",
  "branding": {
    "logoUrl": "https://yourdomain.com/logo.png",
    "primaryColor": "#0084FF",
    "backgroundColor": "#FFFFFF"
  },
  "metadata": {}
}
'

import requests

url = "https://sandbox-api.kotanipay.io/api/v3/payment-links/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "enabledPaymentMethods": [],
    "paymentMethodConfig": {
        "mobileMoneyProviders": ["<string>"],
        "mobileMoneyCurrencies": ["KES", "GHS"],
        "mobileMoneyCountries": ["<string>"],
        "supportedCurrencies": ["<string>"],
        "cryptoNetworks": ["<string>"],
        "cryptoCurrencies": ["USDT", "USDC"],
        "cardCurrencies": ["<string>"],
        "cardCountries": ["<string>"],
        "bankCurrencies": ["<string>"],
        "bankCountries": ["<string>"]
    },
    "maxUses": 123,
    "expiresAt": "2023-11-07T05:31:56Z",
    "callbackUrl": "<string>",
    "branding": {
        "logoUrl": "https://yourdomain.com/logo.png",
        "primaryColor": "#0084FF",
        "backgroundColor": "#FFFFFF"
    },
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    enabledPaymentMethods: [],
    paymentMethodConfig: {
      mobileMoneyProviders: ['<string>'],
      mobileMoneyCurrencies: ['KES', 'GHS'],
      mobileMoneyCountries: ['<string>'],
      supportedCurrencies: ['<string>'],
      cryptoNetworks: ['<string>'],
      cryptoCurrencies: ['USDT', 'USDC'],
      cardCurrencies: ['<string>'],
      cardCountries: ['<string>'],
      bankCurrencies: ['<string>'],
      bankCountries: ['<string>']
    },
    maxUses: 123,
    expiresAt: '2023-11-07T05:31:56Z',
    callbackUrl: '<string>',
    branding: {
      logoUrl: 'https://yourdomain.com/logo.png',
      primaryColor: '#0084FF',
      backgroundColor: '#FFFFFF'
    },
    metadata: {}
  })
};

fetch('https://sandbox-api.kotanipay.io/api/v3/payment-links/{id}', 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.kotanipay.io/api/v3/payment-links/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'enabledPaymentMethods' => [
        
    ],
    'paymentMethodConfig' => [
        'mobileMoneyProviders' => [
                '<string>'
        ],
        'mobileMoneyCurrencies' => [
                'KES',
                'GHS'
        ],
        'mobileMoneyCountries' => [
                '<string>'
        ],
        'supportedCurrencies' => [
                '<string>'
        ],
        'cryptoNetworks' => [
                '<string>'
        ],
        'cryptoCurrencies' => [
                'USDT',
                'USDC'
        ],
        'cardCurrencies' => [
                '<string>'
        ],
        'cardCountries' => [
                '<string>'
        ],
        'bankCurrencies' => [
                '<string>'
        ],
        'bankCountries' => [
                '<string>'
        ]
    ],
    'maxUses' => 123,
    'expiresAt' => '2023-11-07T05:31:56Z',
    'callbackUrl' => '<string>',
    'branding' => [
        'logoUrl' => 'https://yourdomain.com/logo.png',
        'primaryColor' => '#0084FF',
        'backgroundColor' => '#FFFFFF'
    ],
    'metadata' => [
        
    ]
  ]),
  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://sandbox-api.kotanipay.io/api/v3/payment-links/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabledPaymentMethods\": [],\n  \"paymentMethodConfig\": {\n    \"mobileMoneyProviders\": [\n      \"<string>\"\n    ],\n    \"mobileMoneyCurrencies\": [\n      \"KES\",\n      \"GHS\"\n    ],\n    \"mobileMoneyCountries\": [\n      \"<string>\"\n    ],\n    \"supportedCurrencies\": [\n      \"<string>\"\n    ],\n    \"cryptoNetworks\": [\n      \"<string>\"\n    ],\n    \"cryptoCurrencies\": [\n      \"USDT\",\n      \"USDC\"\n    ],\n    \"cardCurrencies\": [\n      \"<string>\"\n    ],\n    \"cardCountries\": [\n      \"<string>\"\n    ],\n    \"bankCurrencies\": [\n      \"<string>\"\n    ],\n    \"bankCountries\": [\n      \"<string>\"\n    ]\n  },\n  \"maxUses\": 123,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"callbackUrl\": \"<string>\",\n  \"branding\": {\n    \"logoUrl\": \"https://yourdomain.com/logo.png\",\n    \"primaryColor\": \"#0084FF\",\n    \"backgroundColor\": \"#FFFFFF\"\n  },\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox-api.kotanipay.io/api/v3/payment-links/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabledPaymentMethods\": [],\n  \"paymentMethodConfig\": {\n    \"mobileMoneyProviders\": [\n      \"<string>\"\n    ],\n    \"mobileMoneyCurrencies\": [\n      \"KES\",\n      \"GHS\"\n    ],\n    \"mobileMoneyCountries\": [\n      \"<string>\"\n    ],\n    \"supportedCurrencies\": [\n      \"<string>\"\n    ],\n    \"cryptoNetworks\": [\n      \"<string>\"\n    ],\n    \"cryptoCurrencies\": [\n      \"USDT\",\n      \"USDC\"\n    ],\n    \"cardCurrencies\": [\n      \"<string>\"\n    ],\n    \"cardCountries\": [\n      \"<string>\"\n    ],\n    \"bankCurrencies\": [\n      \"<string>\"\n    ],\n    \"bankCountries\": [\n      \"<string>\"\n    ]\n  },\n  \"maxUses\": 123,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"callbackUrl\": \"<string>\",\n  \"branding\": {\n    \"logoUrl\": \"https://yourdomain.com/logo.png\",\n    \"primaryColor\": \"#0084FF\",\n    \"backgroundColor\": \"#FFFFFF\"\n  },\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.kotanipay.io/api/v3/payment-links/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabledPaymentMethods\": [],\n  \"paymentMethodConfig\": {\n    \"mobileMoneyProviders\": [\n      \"<string>\"\n    ],\n    \"mobileMoneyCurrencies\": [\n      \"KES\",\n      \"GHS\"\n    ],\n    \"mobileMoneyCountries\": [\n      \"<string>\"\n    ],\n    \"supportedCurrencies\": [\n      \"<string>\"\n    ],\n    \"cryptoNetworks\": [\n      \"<string>\"\n    ],\n    \"cryptoCurrencies\": [\n      \"USDT\",\n      \"USDC\"\n    ],\n    \"cardCurrencies\": [\n      \"<string>\"\n    ],\n    \"cardCountries\": [\n      \"<string>\"\n    ],\n    \"bankCurrencies\": [\n      \"<string>\"\n    ],\n    \"bankCountries\": [\n      \"<string>\"\n    ]\n  },\n  \"maxUses\": 123,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"callbackUrl\": \"<string>\",\n  \"branding\": {\n    \"logoUrl\": \"https://yourdomain.com/logo.png\",\n    \"primaryColor\": \"#0084FF\",\n    \"backgroundColor\": \"#FFFFFF\"\n  },\n  \"metadata\": {}\n}"

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

{
  "success": true,
  "message": "Payment link updated successfully",
  "data": {
    "id": "<string>",
    "shortCode": "<string>",
    "url": "https://pay.kotanipay.com/abc123",
    "name": "<string>",
    "type": "standard",
    "pricing": {
      "type": "fixed",
      "currency": "KES",
      "referenceCurrency": "KES",
      "amount": 123,
      "minAmount": 123,
      "maxAmount": 123,
      "packages": [
        {
          "id": "<string>",
          "name": "<string>",
          "amount": 123,
          "currency": "KES",
          "description": "<string>"
        }
      ]
    },
    "enabledPaymentMethods": [
      "mobile_money"
    ],
    "usageType": "single_use",
    "currentUses": 123,
    "isActive": true,
    "collectCustomerInfo": {
      "email": "required",
      "phone": "required",
      "name": "required",
      "address": "required"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "paymentMethodConfig": {
      "mobileMoneyProviders": [
        "<string>"
      ],
      "mobileMoneyCurrencies": [
        "KES",
        "GHS"
      ],
      "mobileMoneyCountries": [
        "<string>"
      ],
      "supportedCurrencies": [
        "<string>"
      ],
      "cryptoNetworks": [
        "<string>"
      ],
      "cryptoCurrencies": [
        "USDT",
        "USDC"
      ],
      "cardCurrencies": [
        "<string>"
      ],
      "cardCountries": [
        "<string>"
      ],
      "bankCurrencies": [
        "<string>"
      ],
      "bankCountries": [
        "<string>"
      ]
    },
    "maxUses": 123,
    "expiresAt": "2023-11-07T05:31:56Z",
    "afterPayment": {
      "type": "message",
      "message": "<string>",
      "redirectUrl": "https://yourdomain.com/thank-you"
    },
    "branding": {
      "logoUrl": "https://yourdomain.com/logo.png",
      "primaryColor": "#0084FF",
      "backgroundColor": "#FFFFFF"
    },
    "qrCodeUrl": "<string>",
    "lastUsedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "message": "Invalid API Key",
  "data": {}
}

PATCH

api

payment-links

{id}

Update a payment link

curl --request PATCH \
  --url https://sandbox-api.kotanipay.io/api/v3/payment-links/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "enabledPaymentMethods": [],
  "paymentMethodConfig": {
    "mobileMoneyProviders": [
      "<string>"
    ],
    "mobileMoneyCurrencies": [
      "KES",
      "GHS"
    ],
    "mobileMoneyCountries": [
      "<string>"
    ],
    "supportedCurrencies": [
      "<string>"
    ],
    "cryptoNetworks": [
      "<string>"
    ],
    "cryptoCurrencies": [
      "USDT",
      "USDC"
    ],
    "cardCurrencies": [
      "<string>"
    ],
    "cardCountries": [
      "<string>"
    ],
    "bankCurrencies": [
      "<string>"
    ],
    "bankCountries": [
      "<string>"
    ]
  },
  "maxUses": 123,
  "expiresAt": "2023-11-07T05:31:56Z",
  "callbackUrl": "<string>",
  "branding": {
    "logoUrl": "https://yourdomain.com/logo.png",
    "primaryColor": "#0084FF",
    "backgroundColor": "#FFFFFF"
  },
  "metadata": {}
}
'

import requests

url = "https://sandbox-api.kotanipay.io/api/v3/payment-links/{id}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "enabledPaymentMethods": [],
    "paymentMethodConfig": {
        "mobileMoneyProviders": ["<string>"],
        "mobileMoneyCurrencies": ["KES", "GHS"],
        "mobileMoneyCountries": ["<string>"],
        "supportedCurrencies": ["<string>"],
        "cryptoNetworks": ["<string>"],
        "cryptoCurrencies": ["USDT", "USDC"],
        "cardCurrencies": ["<string>"],
        "cardCountries": ["<string>"],
        "bankCurrencies": ["<string>"],
        "bankCountries": ["<string>"]
    },
    "maxUses": 123,
    "expiresAt": "2023-11-07T05:31:56Z",
    "callbackUrl": "<string>",
    "branding": {
        "logoUrl": "https://yourdomain.com/logo.png",
        "primaryColor": "#0084FF",
        "backgroundColor": "#FFFFFF"
    },
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    enabledPaymentMethods: [],
    paymentMethodConfig: {
      mobileMoneyProviders: ['<string>'],
      mobileMoneyCurrencies: ['KES', 'GHS'],
      mobileMoneyCountries: ['<string>'],
      supportedCurrencies: ['<string>'],
      cryptoNetworks: ['<string>'],
      cryptoCurrencies: ['USDT', 'USDC'],
      cardCurrencies: ['<string>'],
      cardCountries: ['<string>'],
      bankCurrencies: ['<string>'],
      bankCountries: ['<string>']
    },
    maxUses: 123,
    expiresAt: '2023-11-07T05:31:56Z',
    callbackUrl: '<string>',
    branding: {
      logoUrl: 'https://yourdomain.com/logo.png',
      primaryColor: '#0084FF',
      backgroundColor: '#FFFFFF'
    },
    metadata: {}
  })
};

fetch('https://sandbox-api.kotanipay.io/api/v3/payment-links/{id}', 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.kotanipay.io/api/v3/payment-links/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'description' => '<string>',
    'enabledPaymentMethods' => [
        
    ],
    'paymentMethodConfig' => [
        'mobileMoneyProviders' => [
                '<string>'
        ],
        'mobileMoneyCurrencies' => [
                'KES',
                'GHS'
        ],
        'mobileMoneyCountries' => [
                '<string>'
        ],
        'supportedCurrencies' => [
                '<string>'
        ],
        'cryptoNetworks' => [
                '<string>'
        ],
        'cryptoCurrencies' => [
                'USDT',
                'USDC'
        ],
        'cardCurrencies' => [
                '<string>'
        ],
        'cardCountries' => [
                '<string>'
        ],
        'bankCurrencies' => [
                '<string>'
        ],
        'bankCountries' => [
                '<string>'
        ]
    ],
    'maxUses' => 123,
    'expiresAt' => '2023-11-07T05:31:56Z',
    'callbackUrl' => '<string>',
    'branding' => [
        'logoUrl' => 'https://yourdomain.com/logo.png',
        'primaryColor' => '#0084FF',
        'backgroundColor' => '#FFFFFF'
    ],
    'metadata' => [
        
    ]
  ]),
  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://sandbox-api.kotanipay.io/api/v3/payment-links/{id}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabledPaymentMethods\": [],\n  \"paymentMethodConfig\": {\n    \"mobileMoneyProviders\": [\n      \"<string>\"\n    ],\n    \"mobileMoneyCurrencies\": [\n      \"KES\",\n      \"GHS\"\n    ],\n    \"mobileMoneyCountries\": [\n      \"<string>\"\n    ],\n    \"supportedCurrencies\": [\n      \"<string>\"\n    ],\n    \"cryptoNetworks\": [\n      \"<string>\"\n    ],\n    \"cryptoCurrencies\": [\n      \"USDT\",\n      \"USDC\"\n    ],\n    \"cardCurrencies\": [\n      \"<string>\"\n    ],\n    \"cardCountries\": [\n      \"<string>\"\n    ],\n    \"bankCurrencies\": [\n      \"<string>\"\n    ],\n    \"bankCountries\": [\n      \"<string>\"\n    ]\n  },\n  \"maxUses\": 123,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"callbackUrl\": \"<string>\",\n  \"branding\": {\n    \"logoUrl\": \"https://yourdomain.com/logo.png\",\n    \"primaryColor\": \"#0084FF\",\n    \"backgroundColor\": \"#FFFFFF\"\n  },\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://sandbox-api.kotanipay.io/api/v3/payment-links/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabledPaymentMethods\": [],\n  \"paymentMethodConfig\": {\n    \"mobileMoneyProviders\": [\n      \"<string>\"\n    ],\n    \"mobileMoneyCurrencies\": [\n      \"KES\",\n      \"GHS\"\n    ],\n    \"mobileMoneyCountries\": [\n      \"<string>\"\n    ],\n    \"supportedCurrencies\": [\n      \"<string>\"\n    ],\n    \"cryptoNetworks\": [\n      \"<string>\"\n    ],\n    \"cryptoCurrencies\": [\n      \"USDT\",\n      \"USDC\"\n    ],\n    \"cardCurrencies\": [\n      \"<string>\"\n    ],\n    \"cardCountries\": [\n      \"<string>\"\n    ],\n    \"bankCurrencies\": [\n      \"<string>\"\n    ],\n    \"bankCountries\": [\n      \"<string>\"\n    ]\n  },\n  \"maxUses\": 123,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"callbackUrl\": \"<string>\",\n  \"branding\": {\n    \"logoUrl\": \"https://yourdomain.com/logo.png\",\n    \"primaryColor\": \"#0084FF\",\n    \"backgroundColor\": \"#FFFFFF\"\n  },\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox-api.kotanipay.io/api/v3/payment-links/{id}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"enabledPaymentMethods\": [],\n  \"paymentMethodConfig\": {\n    \"mobileMoneyProviders\": [\n      \"<string>\"\n    ],\n    \"mobileMoneyCurrencies\": [\n      \"KES\",\n      \"GHS\"\n    ],\n    \"mobileMoneyCountries\": [\n      \"<string>\"\n    ],\n    \"supportedCurrencies\": [\n      \"<string>\"\n    ],\n    \"cryptoNetworks\": [\n      \"<string>\"\n    ],\n    \"cryptoCurrencies\": [\n      \"USDT\",\n      \"USDC\"\n    ],\n    \"cardCurrencies\": [\n      \"<string>\"\n    ],\n    \"cardCountries\": [\n      \"<string>\"\n    ],\n    \"bankCurrencies\": [\n      \"<string>\"\n    ],\n    \"bankCountries\": [\n      \"<string>\"\n    ]\n  },\n  \"maxUses\": 123,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"callbackUrl\": \"<string>\",\n  \"branding\": {\n    \"logoUrl\": \"https://yourdomain.com/logo.png\",\n    \"primaryColor\": \"#0084FF\",\n    \"backgroundColor\": \"#FFFFFF\"\n  },\n  \"metadata\": {}\n}"

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

{
  "success": true,
  "message": "Payment link updated successfully",
  "data": {
    "id": "<string>",
    "shortCode": "<string>",
    "url": "https://pay.kotanipay.com/abc123",
    "name": "<string>",
    "type": "standard",
    "pricing": {
      "type": "fixed",
      "currency": "KES",
      "referenceCurrency": "KES",
      "amount": 123,
      "minAmount": 123,
      "maxAmount": 123,
      "packages": [
        {
          "id": "<string>",
          "name": "<string>",
          "amount": 123,
          "currency": "KES",
          "description": "<string>"
        }
      ]
    },
    "enabledPaymentMethods": [
      "mobile_money"
    ],
    "usageType": "single_use",
    "currentUses": 123,
    "isActive": true,
    "collectCustomerInfo": {
      "email": "required",
      "phone": "required",
      "name": "required",
      "address": "required"
    },
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "paymentMethodConfig": {
      "mobileMoneyProviders": [
        "<string>"
      ],
      "mobileMoneyCurrencies": [
        "KES",
        "GHS"
      ],
      "mobileMoneyCountries": [
        "<string>"
      ],
      "supportedCurrencies": [
        "<string>"
      ],
      "cryptoNetworks": [
        "<string>"
      ],
      "cryptoCurrencies": [
        "USDT",
        "USDC"
      ],
      "cardCurrencies": [
        "<string>"
      ],
      "cardCountries": [
        "<string>"
      ],
      "bankCurrencies": [
        "<string>"
      ],
      "bankCountries": [
        "<string>"
      ]
    },
    "maxUses": 123,
    "expiresAt": "2023-11-07T05:31:56Z",
    "afterPayment": {
      "type": "message",
      "message": "<string>",
      "redirectUrl": "https://yourdomain.com/thank-you"
    },
    "branding": {
      "logoUrl": "https://yourdomain.com/logo.png",
      "primaryColor": "#0084FF",
      "backgroundColor": "#FFFFFF"
    },
    "qrCodeUrl": "<string>",
    "lastUsedAt": "2023-11-07T05:31:56Z"
  }
}

{
  "success": false,
  "message": "Invalid API Key",
  "data": {}
}

Update a payment link’s name, pricing, enabled payment methods, expiry, or branding.

type and usageType cannot be changed after creation — create a new link instead.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string

required

Body

application/json

Note: type and usageType cannot be changed after creation.

name

string

description

string

pricing

object

Show child attributes

enabledPaymentMethods

enum<string>[]

Available options:

mobile_money,

bank,

card,

crypto

paymentMethodConfig

object

Restricts which providers/currencies/networks/countries are offered per payment method. All fields optional — omit to allow everything enabled on your account.

Show child attributes

maxUses

number

expiresAt

string<date-time>

collectCustomerInfo

object

Whether email, phone, name, and address are required, optional, or not collected at checkout.

Show child attributes

afterPayment

object

Show child attributes

callbackUrl

string

branding

object

Show child attributes

metadata

object

Response

success

boolean

Example:

true

message

string

Example:

"Payment link updated successfully"

data

object

Show child attributes

Getting Started

Health & System

Authentication & Setup

Fiat Wallets

Crypto Wallets

Customer Management

Mobile Money Deposits

Mobile Money Withdrawals

SMS

Card Deposits

Bank Deposits

Bank Withdrawals

Kenya Withdrawals

Country & Service Support

Exchange Rates

Onramp (Buy Crypto)

Offramp (Sell Crypto)

Crypto Deposits (On-Chain)

Settlement Requests

Settlement Batches

Saved Beneficiaries

Cross-Border Payments

KYC & Compliance

Payment Links

Bulk Payments

Authorizations

Path Parameters

Body

Response