Create a payment link

curl

curl -X POST https://api.paybridgenp.com/v1/payment-links \
  -H "Authorization: Bearer sk_test_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Donation", "amount": 10000 }'

import requests

url = "https://api.paybridgenp.com/v1/payment-links"

payload = {
    "title": "Donation",
    "description": "<string>",
    "amount": 10000,
    "minAmount": 123,
    "maxAmount": 123,
    "currency": "NPR",
    "maxUses": 5000,
    "expiresAt": "2023-11-07T05:31:56Z",
    "redirectUrl": "<string>",
    "inactiveMessage": "<string>",
    "metadata": {},
    "customerName": "<string>",
    "customerEmail": "jsmith@example.com",
    "customerPhone": "<string>",
    "referenceId": "<string>",
    "collectAddress": True
}
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({
    title: 'Donation',
    description: '<string>',
    amount: 10000,
    minAmount: 123,
    maxAmount: 123,
    currency: 'NPR',
    maxUses: 5000,
    expiresAt: '2023-11-07T05:31:56Z',
    redirectUrl: '<string>',
    inactiveMessage: '<string>',
    metadata: {},
    customerName: '<string>',
    customerEmail: 'jsmith@example.com',
    customerPhone: '<string>',
    referenceId: '<string>',
    collectAddress: true
  })
};

fetch('https://api.paybridgenp.com/v1/payment-links', 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.paybridgenp.com/v1/payment-links",
  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([
    'title' => 'Donation',
    'description' => '<string>',
    'amount' => 10000,
    'minAmount' => 123,
    'maxAmount' => 123,
    'currency' => 'NPR',
    'maxUses' => 5000,
    'expiresAt' => '2023-11-07T05:31:56Z',
    'redirectUrl' => '<string>',
    'inactiveMessage' => '<string>',
    'metadata' => [
        
    ],
    'customerName' => '<string>',
    'customerEmail' => 'jsmith@example.com',
    'customerPhone' => '<string>',
    'referenceId' => '<string>',
    'collectAddress' => true
  ]),
  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.paybridgenp.com/v1/payment-links"

	payload := strings.NewReader("{\n  \"title\": \"Donation\",\n  \"description\": \"<string>\",\n  \"amount\": 10000,\n  \"minAmount\": 123,\n  \"maxAmount\": 123,\n  \"currency\": \"NPR\",\n  \"maxUses\": 5000,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"redirectUrl\": \"<string>\",\n  \"inactiveMessage\": \"<string>\",\n  \"metadata\": {},\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"customerPhone\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"collectAddress\": true\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.paybridgenp.com/v1/payment-links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Donation\",\n  \"description\": \"<string>\",\n  \"amount\": 10000,\n  \"minAmount\": 123,\n  \"maxAmount\": 123,\n  \"currency\": \"NPR\",\n  \"maxUses\": 5000,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"redirectUrl\": \"<string>\",\n  \"inactiveMessage\": \"<string>\",\n  \"metadata\": {},\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"customerPhone\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"collectAddress\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paybridgenp.com/v1/payment-links")

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  \"title\": \"Donation\",\n  \"description\": \"<string>\",\n  \"amount\": 10000,\n  \"minAmount\": 123,\n  \"maxAmount\": 123,\n  \"currency\": \"NPR\",\n  \"maxUses\": 5000,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"redirectUrl\": \"<string>\",\n  \"inactiveMessage\": \"<string>\",\n  \"metadata\": {},\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"customerPhone\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"collectAddress\": true\n}"

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

{
  "id": "lnk_01j9x2k3m4n5p6q7r8s9t0u1v2",
  "livemode": true,
  "title": "Donation",
  "description": "<string>",
  "amount": 10000,
  "minAmount": 123,
  "maxAmount": 123,
  "currency": "NPR",
  "active": true,
  "maxUses": 123,
  "usedCount": 0,
  "expiresAt": "2023-11-07T05:31:56Z",
  "redirectUrl": "<string>",
  "inactiveMessage": "<string>",
  "customerName": "<string>",
  "customerEmail": "<string>",
  "customerPhone": "<string>",
  "collectAddress": true,
  "customerLine1": "<string>",
  "customerLine2": "<string>",
  "customerCity": "<string>",
  "customerState": "<string>",
  "customerPostalCode": "<string>",
  "customerCountry": "<string>",
  "referenceId": "<string>",
  "metadata": {},
  "url": "https://paybridgenp.com/pay/lnk_01j9x2k3m4n5p6q7r8s9t0u1v2",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "request_id": "req_2Je91NlWKuXkdXUJOK9gaHNW",
    "suspension": {
      "suspended_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    },
    "pause": {
      "paused_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "request_id": "req_2Je91NlWKuXkdXUJOK9gaHNW",
    "suspension": {
      "suspended_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    },
    "pause": {
      "paused_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "request_id": "req_2Je91NlWKuXkdXUJOK9gaHNW",
    "suspension": {
      "suspended_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    },
    "pause": {
      "paused_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "request_id": "req_2Je91NlWKuXkdXUJOK9gaHNW",
    "suspension": {
      "suspended_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    },
    "pause": {
      "paused_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  }
}

POST

payment-links

curl

curl -X POST https://api.paybridgenp.com/v1/payment-links \
  -H "Authorization: Bearer sk_test_your_key" \
  -H "Content-Type: application/json" \
  -d '{ "title": "Donation", "amount": 10000 }'

import requests

url = "https://api.paybridgenp.com/v1/payment-links"

payload = {
    "title": "Donation",
    "description": "<string>",
    "amount": 10000,
    "minAmount": 123,
    "maxAmount": 123,
    "currency": "NPR",
    "maxUses": 5000,
    "expiresAt": "2023-11-07T05:31:56Z",
    "redirectUrl": "<string>",
    "inactiveMessage": "<string>",
    "metadata": {},
    "customerName": "<string>",
    "customerEmail": "jsmith@example.com",
    "customerPhone": "<string>",
    "referenceId": "<string>",
    "collectAddress": True
}
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({
    title: 'Donation',
    description: '<string>',
    amount: 10000,
    minAmount: 123,
    maxAmount: 123,
    currency: 'NPR',
    maxUses: 5000,
    expiresAt: '2023-11-07T05:31:56Z',
    redirectUrl: '<string>',
    inactiveMessage: '<string>',
    metadata: {},
    customerName: '<string>',
    customerEmail: 'jsmith@example.com',
    customerPhone: '<string>',
    referenceId: '<string>',
    collectAddress: true
  })
};

fetch('https://api.paybridgenp.com/v1/payment-links', 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.paybridgenp.com/v1/payment-links",
  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([
    'title' => 'Donation',
    'description' => '<string>',
    'amount' => 10000,
    'minAmount' => 123,
    'maxAmount' => 123,
    'currency' => 'NPR',
    'maxUses' => 5000,
    'expiresAt' => '2023-11-07T05:31:56Z',
    'redirectUrl' => '<string>',
    'inactiveMessage' => '<string>',
    'metadata' => [
        
    ],
    'customerName' => '<string>',
    'customerEmail' => 'jsmith@example.com',
    'customerPhone' => '<string>',
    'referenceId' => '<string>',
    'collectAddress' => true
  ]),
  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.paybridgenp.com/v1/payment-links"

	payload := strings.NewReader("{\n  \"title\": \"Donation\",\n  \"description\": \"<string>\",\n  \"amount\": 10000,\n  \"minAmount\": 123,\n  \"maxAmount\": 123,\n  \"currency\": \"NPR\",\n  \"maxUses\": 5000,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"redirectUrl\": \"<string>\",\n  \"inactiveMessage\": \"<string>\",\n  \"metadata\": {},\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"customerPhone\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"collectAddress\": true\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.paybridgenp.com/v1/payment-links")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Donation\",\n  \"description\": \"<string>\",\n  \"amount\": 10000,\n  \"minAmount\": 123,\n  \"maxAmount\": 123,\n  \"currency\": \"NPR\",\n  \"maxUses\": 5000,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"redirectUrl\": \"<string>\",\n  \"inactiveMessage\": \"<string>\",\n  \"metadata\": {},\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"customerPhone\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"collectAddress\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paybridgenp.com/v1/payment-links")

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  \"title\": \"Donation\",\n  \"description\": \"<string>\",\n  \"amount\": 10000,\n  \"minAmount\": 123,\n  \"maxAmount\": 123,\n  \"currency\": \"NPR\",\n  \"maxUses\": 5000,\n  \"expiresAt\": \"2023-11-07T05:31:56Z\",\n  \"redirectUrl\": \"<string>\",\n  \"inactiveMessage\": \"<string>\",\n  \"metadata\": {},\n  \"customerName\": \"<string>\",\n  \"customerEmail\": \"jsmith@example.com\",\n  \"customerPhone\": \"<string>\",\n  \"referenceId\": \"<string>\",\n  \"collectAddress\": true\n}"

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

{
  "id": "lnk_01j9x2k3m4n5p6q7r8s9t0u1v2",
  "livemode": true,
  "title": "Donation",
  "description": "<string>",
  "amount": 10000,
  "minAmount": 123,
  "maxAmount": 123,
  "currency": "NPR",
  "active": true,
  "maxUses": 123,
  "usedCount": 0,
  "expiresAt": "2023-11-07T05:31:56Z",
  "redirectUrl": "<string>",
  "inactiveMessage": "<string>",
  "customerName": "<string>",
  "customerEmail": "<string>",
  "customerPhone": "<string>",
  "collectAddress": true,
  "customerLine1": "<string>",
  "customerLine2": "<string>",
  "customerCity": "<string>",
  "customerState": "<string>",
  "customerPostalCode": "<string>",
  "customerCountry": "<string>",
  "referenceId": "<string>",
  "metadata": {},
  "url": "https://paybridgenp.com/pay/lnk_01j9x2k3m4n5p6q7r8s9t0u1v2",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "request_id": "req_2Je91NlWKuXkdXUJOK9gaHNW",
    "suspension": {
      "suspended_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    },
    "pause": {
      "paused_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "request_id": "req_2Je91NlWKuXkdXUJOK9gaHNW",
    "suspension": {
      "suspended_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    },
    "pause": {
      "paused_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "request_id": "req_2Je91NlWKuXkdXUJOK9gaHNW",
    "suspension": {
      "suspended_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    },
    "pause": {
      "paused_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  }
}

{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "request_id": "req_2Je91NlWKuXkdXUJOK9gaHNW",
    "suspension": {
      "suspended_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    },
    "pause": {
      "paused_at": "2023-11-07T05:31:56Z",
      "reason": "<string>"
    }
  }
}

Authorizations

Authorization

string

header

required

Your PayBridgeNP API key. Obtain one from the dashboard under Settings → API Keys. Prefix: sk_test_ for testing, sk_live_ for production.

Headers

Idempotency-Key

string

A unique key to safely retry the request without creating duplicate links.

Body

application/json

title

string

required

Shown on the payment page.

Maximum string length: 100

Example:

"Donation"

description

string | null

Maximum string length: 500

amount

integer | null

Fixed amount in paisa. Omit to let the customer enter an amount (then use minAmount/maxAmount).

Example:

10000

minAmount

integer | null

Minimum customer-entered amount in paisa.

maxAmount

integer | null

Maximum customer-entered amount in paisa (max NPR 100,000).

currency

enum<string>

default:NPR

Available options:

NPR

provider

enum<string> | null

Lock to a provider, or omit to let the customer pick.

Available options:

esewa,

khalti,

fonepay

maxUses

integer | null

Usage cap. Omit for unlimited.

Required range: 1 <= x <= 10000

expiresAt

string<date-time> | null

ISO date; must be in the future and within 1 year.

redirectUrl

string<uri> | null

https:// URL the customer is sent to after a successful payment.

inactiveMessage

string | null

Maximum string length: 300

metadata

object | null

Arbitrary key-value data (max 4 KB).

customerName

string | null

Maximum string length: 100

customerEmail

string<email> | null

customerPhone

string | null

Maximum string length: 20

referenceId

string | null

Your internal identifier.

Maximum string length: 100

collectAddress

boolean

Collect a billing address on the checkout page.

Response

Payment link created.

string

Example:

"lnk_01j9x2k3m4n5p6q7r8s9t0u1v2"

livemode

boolean

true when created with a live key, false for sandbox.

mode

enum<string>

Available options:

sandbox,

live

title

string

Shown on the payment page.

Example:

"Donation"

description

string | null

amount

integer | null

Fixed amount in paisa. null when the customer enters their own amount (see minAmount/maxAmount).

Example:

10000

minAmount

integer | null

Minimum customer-entered amount in paisa (only when amount is null).

maxAmount

integer | null

Maximum customer-entered amount in paisa (only when amount is null).

currency

string

Example:

"NPR"

provider

enum<string> | null

Locked provider, or null if the customer picks.

Available options:

esewa,

khalti,

fonepay

active

boolean

maxUses

integer | null

Usage cap, or null for unlimited.

usedCount

integer

Number of completed payments through this link.

Example:

0

expiresAt

string<date-time> | null

redirectUrl

string<uri> | null

Where the customer is sent after a successful payment.

inactiveMessage

string | null

Shown when the link is not usable.

customerName

string | null

Pre-filled on the checkout page.

customerEmail

string | null

customerPhone

string | null

collectAddress

boolean

customerLine1

string | null

customerLine2

string | null

customerCity

string | null

customerState

string | null

customerPostalCode

string | null

customerCountry

string | null

referenceId

string | null

Your internal identifier for this link.

metadata

object | null

url

string<uri>

Public hosted payment page for this link.

Example:

"https://paybridgenp.com/pay/lnk_01j9x2k3m4n5p6q7r8s9t0u1v2"

createdAt

string<date-time>

updatedAt

string<date-time>

Overview

Checkout

Payment Links

Payments

Refunds

Webhooks

Account

Billing

Providers

SMS

Create a payment link

Authorizations

Headers

Body

Response