Retrieve a Payment Link

curl --request GET \
  --url https://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id} \
  --header 'X-Meridian-Api-Key: <x-meridian-api-key>' \
  --header 'X-Meridian-Signature: <api-key>' \
  --header 'X-Meridian-Timestamp: <x-meridian-timestamp>'

import requests

url = "https://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id}"

headers = {
    "X-Meridian-Api-Key": "<x-meridian-api-key>",
    "X-Meridian-Timestamp": "<x-meridian-timestamp>",
    "X-Meridian-Signature": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-Meridian-Api-Key': '<x-meridian-api-key>',
    'X-Meridian-Timestamp': '<x-meridian-timestamp>',
    'X-Meridian-Signature': '<api-key>'
  }
};

fetch('https://us-merchant.sandbox.api-us.meridianapps.dev/v1/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://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Meridian-Api-Key: <x-meridian-api-key>",
    "X-Meridian-Signature: <api-key>",
    "X-Meridian-Timestamp: <x-meridian-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Meridian-Api-Key", "<x-meridian-api-key>")
	req.Header.Add("X-Meridian-Timestamp", "<x-meridian-timestamp>")
	req.Header.Add("X-Meridian-Signature", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id}")
  .header("X-Meridian-Api-Key", "<x-meridian-api-key>")
  .header("X-Meridian-Timestamp", "<x-meridian-timestamp>")
  .header("X-Meridian-Signature", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-Meridian-Api-Key"] = '<x-meridian-api-key>'
request["X-Meridian-Timestamp"] = '<x-meridian-timestamp>'
request["X-Meridian-Signature"] = '<api-key>'

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

{
  "id": "usmer-kiqt7rz1qvwqnryhvbqf463q",
  "createdAt": "2026-07-02T20:31:25.000Z",
  "updatedAt": "2026-07-02T20:31:25.000Z",
  "linkToken": "de4261dd-548a-4cbc-9f48-9d13924e3d7d",
  "userId": null,
  "status": "ACTIVE",
  "statusReason": null,
  "initialAccessBy": "2026-07-03T20:31:20.000Z",
  "merchantId": "usmer-rtn86be1xb9jzb5qwib6z0i9",
  "recurrenceType": "SINGLE",
  "referenceId": "REF-ONEOFF-2",
  "referenceLabel": "One-off USD",
  "description": null,
  "creditAmount": "100.50",
  "creditCurrency": "USD",
  "debitCurrency": "USD",
  "nextPaymentDate": null,
  "lastPaymentDate": null,
  "paymentAttempts": 0,
  "startDate": null,
  "endDate": "2027-01-31",
  "collectionCount": null,
  "customFields": {
    "name": "John Doe",
    "email": "john@example.com"
  },
  "autopays": []
}

{
  "validationErrors": [
    {
      "type": "InvalidFormat",
      "fieldRef": "<string>",
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "errorCode": "<string>"
}

{
  "validationErrors": [
    {
      "type": "InvalidFormat",
      "fieldRef": "<string>",
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "errorCode": "<string>"
}

{
  "validationErrors": [
    {
      "type": "InvalidFormat",
      "fieldRef": "<string>",
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "errorCode": "<string>"
}

GET

payment-links

{id}

Retrieve a Payment Link

curl --request GET \
  --url https://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id} \
  --header 'X-Meridian-Api-Key: <x-meridian-api-key>' \
  --header 'X-Meridian-Signature: <api-key>' \
  --header 'X-Meridian-Timestamp: <x-meridian-timestamp>'

import requests

url = "https://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id}"

headers = {
    "X-Meridian-Api-Key": "<x-meridian-api-key>",
    "X-Meridian-Timestamp": "<x-meridian-timestamp>",
    "X-Meridian-Signature": "<api-key>"
}

response = requests.get(url, headers=headers)

print(response.text)

const options = {
  method: 'GET',
  headers: {
    'X-Meridian-Api-Key': '<x-meridian-api-key>',
    'X-Meridian-Timestamp': '<x-meridian-timestamp>',
    'X-Meridian-Signature': '<api-key>'
  }
};

fetch('https://us-merchant.sandbox.api-us.meridianapps.dev/v1/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://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Meridian-Api-Key: <x-meridian-api-key>",
    "X-Meridian-Signature: <api-key>",
    "X-Meridian-Timestamp: <x-meridian-timestamp>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-Meridian-Api-Key", "<x-meridian-api-key>")
	req.Header.Add("X-Meridian-Timestamp", "<x-meridian-timestamp>")
	req.Header.Add("X-Meridian-Signature", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id}")
  .header("X-Meridian-Api-Key", "<x-meridian-api-key>")
  .header("X-Meridian-Timestamp", "<x-meridian-timestamp>")
  .header("X-Meridian-Signature", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://us-merchant.sandbox.api-us.meridianapps.dev/v1/payment-links/{id}")

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

request = Net::HTTP::Get.new(url)
request["X-Meridian-Api-Key"] = '<x-meridian-api-key>'
request["X-Meridian-Timestamp"] = '<x-meridian-timestamp>'
request["X-Meridian-Signature"] = '<api-key>'

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

{
  "id": "usmer-kiqt7rz1qvwqnryhvbqf463q",
  "createdAt": "2026-07-02T20:31:25.000Z",
  "updatedAt": "2026-07-02T20:31:25.000Z",
  "linkToken": "de4261dd-548a-4cbc-9f48-9d13924e3d7d",
  "userId": null,
  "status": "ACTIVE",
  "statusReason": null,
  "initialAccessBy": "2026-07-03T20:31:20.000Z",
  "merchantId": "usmer-rtn86be1xb9jzb5qwib6z0i9",
  "recurrenceType": "SINGLE",
  "referenceId": "REF-ONEOFF-2",
  "referenceLabel": "One-off USD",
  "description": null,
  "creditAmount": "100.50",
  "creditCurrency": "USD",
  "debitCurrency": "USD",
  "nextPaymentDate": null,
  "lastPaymentDate": null,
  "paymentAttempts": 0,
  "startDate": null,
  "endDate": "2027-01-31",
  "collectionCount": null,
  "customFields": {
    "name": "John Doe",
    "email": "john@example.com"
  },
  "autopays": []
}

{
  "validationErrors": [
    {
      "type": "InvalidFormat",
      "fieldRef": "<string>",
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "errorCode": "<string>"
}

{
  "validationErrors": [
    {
      "type": "InvalidFormat",
      "fieldRef": "<string>",
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "errorCode": "<string>"
}

{
  "validationErrors": [
    {
      "type": "InvalidFormat",
      "fieldRef": "<string>",
      "message": "<string>"
    }
  ],
  "message": "<string>",
  "errorCode": "<string>"
}

Authorizations

X-Meridian-Signature

string

header

required

Meridian HMAC header authentication.

Required headers:

X-Meridian-Api-Key
X-Meridian-Timestamp
X-Meridian-Signature

X-Meridian-Signature is the HMAC SHA-256 signature of the canonical request string, computed per request as HMAC-SHA256(apiKey + timestamp + method + request URI including any query string + body). See Authentication for how to construct it.

Headers

X-Meridian-Api-Key

string

required

API key issued by Meridian during provisioning.

X-Meridian-Timestamp

string

required

Current time in milliseconds since the Unix epoch. Must be within 10 seconds of the request.

Path Parameters

string

required

Meridian id of the payment link.

Response

Retrieved data

A payment link and its current state.

string

required

Unique id of the payment link.

createdAt

string<date-time>

required

ISO-8601 timestamp (UTC) when the payment link was created.

updatedAt

string<date-time>

required

ISO-8601 timestamp (UTC) when the payment link was last updated.

linkToken

string

required

Non-guessable, URL-safe token that uniquely identifies the payment link and is exposed in payment URLs.

status

enum<string>

required

Current status of the payment link.

Available options:

ACTIVE,

PROCESSING,

FAILED,

INACTIVE,

EXPIRED,

LOCKED,

ARCHIVED,

COMPLETED

initialAccessBy

string<date-time>

required

ISO-8601 timestamp (UTC) by which the payment link must first be accessed. If it is not accessed by this time it expires and becomes invalid. The expiry window is set in the merchant configuration.

merchantId

string

required

Unique identifier of the merchant that owns the payment link.

recurrenceType

enum<string>

required

How the payment link handles recurrence.

Available options:

SINGLE,

RECURRING,

VARIABLE

referenceLabel

string

required

Human-readable label for the payment link.

creditCurrency

enum<string>

required

ISO-4217 currency code the merchant is paid out in.

Available options:

EUR,

USD,

GBP,

PHP,

MXN,

ZAR,

USDC_ETH,

USDC_SOL,

USDT_ETH,

USDT_SOL

debitCurrency

enum<string>

required

ISO-4217 currency code debited from the payer.

Available options:

EUR,

USD,

GBP,

PHP,

MXN,

ZAR,

USDC_ETH,

USDC_SOL,

USDT_ETH,

USDT_SOL

paymentAttempts

integer

required

Number of payment attempts initiated for the payment link.

userId

string | null

Meridian user id of the payer who attempted payment on this link, when one has.

statusReason

string | null

Optional detail about the current status of the payment link.

referenceId

string | null

Unique reference defined by the merchant to identify the payment link. Not shown to customers on single payment links.

description

string | null

Optional human-readable description for the payment link.

creditAmount

string | null

Amount collected per charge, returned as a decimal string such as "100.50". Null for VARIABLE links whose amount has not been set yet.

nextPaymentDate

string<date> | null

Pre-calculated date of the next scheduled payment.

lastPaymentDate

string<date> | null

Date the most recent payment attempt was initiated for the payment link.

startDate

string<date> | null

Start date from which the payment link can be paid. Payments are not allowed before this date.

endDate

string<date> | null

End date after which the payment link can no longer be paid.

collectionCount

integer | null

Number of installments the payer will be charged.

customFields

Map_String_String · object | null

Key-value map of custom fields defined by the merchant.

Show child attributes

autopays

Autopay · object[]

Auto pays set up by the payer to automatically collect payments on recurring links. Empty when none are configured.

Show child attributes

Getting Started

API Reference

Retrieve a Payment Link

Authorizations

Headers

Path Parameters

Response