Create a drop-in link

curl --request POST \
  --url https://api.staging.payrails.io/merchant/dropInLinks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "workspaceId": "c8f9e0a1-b2c3-4d5e-961f-1234567890ab",
  "amount": {
    "value": "500.00",
    "currency": "EUR"
  },
  "expiresAt": "2025-03-01T23:59:59Z"
}
'

import requests

url = "https://api.staging.payrails.io/merchant/dropInLinks"

payload = {
    "workspaceId": "c8f9e0a1-b2c3-4d5e-961f-1234567890ab",
    "amount": {
        "value": "500.00",
        "currency": "EUR"
    },
    "expiresAt": "2025-03-01T23:59:59Z"
}
headers = {
    "x-idempotency-key": "<x-idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-idempotency-key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    workspaceId: 'c8f9e0a1-b2c3-4d5e-961f-1234567890ab',
    amount: {value: '500.00', currency: 'EUR'},
    expiresAt: '2025-03-01T23:59:59Z'
  })
};

fetch('https://api.staging.payrails.io/merchant/dropInLinks', 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.staging.payrails.io/merchant/dropInLinks",
  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([
    'workspaceId' => 'c8f9e0a1-b2c3-4d5e-961f-1234567890ab',
    'amount' => [
        'value' => '500.00',
        'currency' => 'EUR'
    ],
    'expiresAt' => '2025-03-01T23:59:59Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-idempotency-key: <x-idempotency-key>"
  ],
]);

$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.staging.payrails.io/merchant/dropInLinks"

	payload := strings.NewReader("{\n  \"workspaceId\": \"c8f9e0a1-b2c3-4d5e-961f-1234567890ab\",\n  \"amount\": {\n    \"value\": \"500.00\",\n    \"currency\": \"EUR\"\n  },\n  \"expiresAt\": \"2025-03-01T23:59:59Z\"\n}")

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

	req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
	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.staging.payrails.io/merchant/dropInLinks")
  .header("x-idempotency-key", "<x-idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"c8f9e0a1-b2c3-4d5e-961f-1234567890ab\",\n  \"amount\": {\n    \"value\": \"500.00\",\n    \"currency\": \"EUR\"\n  },\n  \"expiresAt\": \"2025-03-01T23:59:59Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.staging.payrails.io/merchant/dropInLinks")

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

request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"c8f9e0a1-b2c3-4d5e-961f-1234567890ab\",\n  \"amount\": {\n    \"value\": \"500.00\",\n    \"currency\": \"EUR\"\n  },\n  \"expiresAt\": \"2025-03-01T23:59:59Z\"\n}"

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "workspaceId": "c8f9e0a1-b2c3-4d5e-961f-1234567890ab",
  "dropInLinkUrl": "https://merchant.payrails.io/public/redirect/dropInLink/123e4567-e89b-12d3-a456-426614174000/550e8400-e29b-41d4-a716-446655440000",
  "status": "enabled",
  "amount": {
    "value": "500.00",
    "currency": "EUR"
  },
  "paidAmount": {
    "value": "0.00",
    "currency": "EUR"
  },
  "allowPartialFulfillment": false,
  "workflowCode": "payment-acceptance",
  "description": "Checkout for INV-2024-001.",
  "merchantReference": "INV-2024-001",
  "meta": {
    "customer_id": "cus_998877"
  },
  "expiresAt": "2025-03-01T23:59:59Z",
  "createdAt": "2025-02-27T10:30:00Z"
}

{
  "errors": [
    {
      "id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
      "code": "request.malformed",
      "detail": "The request has malformed syntax",
      "docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestmalformed"
    }
  ]
}

{
  "errors": [
    {
      "id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
      "code": "request.unauthorized",
      "detail": "The request lacks necessary credentials to perform the specified action",
      "docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestunauthorized"
    }
  ]
}

{
  "errors": [
    {
      "id": "e7db22b3-914e-4975-928e-9edfb0885bea",
      "code": "request.forbidden",
      "detail": "The request credentials lack the required permissions to perform the specified action",
      "docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestforbidden"
    }
  ]
}

{
  "errors": [
    {
      "id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
      "code": "request.not-found",
      "detail": "The requested resource was not found",
      "docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestnot-found"
    }
  ]
}

{
  "errors": [
    {
      "id": "07a1d642-dbf5-47d3-8563-700514b38e46",
      "code": "request.header.missing",
      "detail": "The request is missing a required header",
      "docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestheadermissing"
    }
  ]
}

POST

https://api.staging.payrails.io

merchant

dropInLinks

Create a drop-in link

curl --request POST \
  --url https://api.staging.payrails.io/merchant/dropInLinks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "workspaceId": "c8f9e0a1-b2c3-4d5e-961f-1234567890ab",
  "amount": {
    "value": "500.00",
    "currency": "EUR"
  },
  "expiresAt": "2025-03-01T23:59:59Z"
}
'

import requests

url = "https://api.staging.payrails.io/merchant/dropInLinks"

payload = {
    "workspaceId": "c8f9e0a1-b2c3-4d5e-961f-1234567890ab",
    "amount": {
        "value": "500.00",
        "currency": "EUR"
    },
    "expiresAt": "2025-03-01T23:59:59Z"
}
headers = {
    "x-idempotency-key": "<x-idempotency-key>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-idempotency-key': '<x-idempotency-key>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    workspaceId: 'c8f9e0a1-b2c3-4d5e-961f-1234567890ab',
    amount: {value: '500.00', currency: 'EUR'},
    expiresAt: '2025-03-01T23:59:59Z'
  })
};

fetch('https://api.staging.payrails.io/merchant/dropInLinks', 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.staging.payrails.io/merchant/dropInLinks",
  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([
    'workspaceId' => 'c8f9e0a1-b2c3-4d5e-961f-1234567890ab',
    'amount' => [
        'value' => '500.00',
        'currency' => 'EUR'
    ],
    'expiresAt' => '2025-03-01T23:59:59Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-idempotency-key: <x-idempotency-key>"
  ],
]);

$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.staging.payrails.io/merchant/dropInLinks"

	payload := strings.NewReader("{\n  \"workspaceId\": \"c8f9e0a1-b2c3-4d5e-961f-1234567890ab\",\n  \"amount\": {\n    \"value\": \"500.00\",\n    \"currency\": \"EUR\"\n  },\n  \"expiresAt\": \"2025-03-01T23:59:59Z\"\n}")

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

	req.Header.Add("x-idempotency-key", "<x-idempotency-key>")
	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.staging.payrails.io/merchant/dropInLinks")
  .header("x-idempotency-key", "<x-idempotency-key>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"workspaceId\": \"c8f9e0a1-b2c3-4d5e-961f-1234567890ab\",\n  \"amount\": {\n    \"value\": \"500.00\",\n    \"currency\": \"EUR\"\n  },\n  \"expiresAt\": \"2025-03-01T23:59:59Z\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.staging.payrails.io/merchant/dropInLinks")

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

request = Net::HTTP::Post.new(url)
request["x-idempotency-key"] = '<x-idempotency-key>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"workspaceId\": \"c8f9e0a1-b2c3-4d5e-961f-1234567890ab\",\n  \"amount\": {\n    \"value\": \"500.00\",\n    \"currency\": \"EUR\"\n  },\n  \"expiresAt\": \"2025-03-01T23:59:59Z\"\n}"

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

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "workspaceId": "c8f9e0a1-b2c3-4d5e-961f-1234567890ab",
  "dropInLinkUrl": "https://merchant.payrails.io/public/redirect/dropInLink/123e4567-e89b-12d3-a456-426614174000/550e8400-e29b-41d4-a716-446655440000",
  "status": "enabled",
  "amount": {
    "value": "500.00",
    "currency": "EUR"
  },
  "paidAmount": {
    "value": "0.00",
    "currency": "EUR"
  },
  "allowPartialFulfillment": false,
  "workflowCode": "payment-acceptance",
  "description": "Checkout for INV-2024-001.",
  "merchantReference": "INV-2024-001",
  "meta": {
    "customer_id": "cus_998877"
  },
  "expiresAt": "2025-03-01T23:59:59Z",
  "createdAt": "2025-02-27T10:30:00Z"
}

{
  "errors": [
    {
      "id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
      "code": "request.malformed",
      "detail": "The request has malformed syntax",
      "docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestmalformed"
    }
  ]
}

{
  "errors": [
    {
      "id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
      "code": "request.unauthorized",
      "detail": "The request lacks necessary credentials to perform the specified action",
      "docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestunauthorized"
    }
  ]
}

{
  "errors": [
    {
      "id": "e7db22b3-914e-4975-928e-9edfb0885bea",
      "code": "request.forbidden",
      "detail": "The request credentials lack the required permissions to perform the specified action",
      "docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestforbidden"
    }
  ]
}

{
  "errors": [
    {
      "id": "a24bc325-3929-4d9d-9c08-b3aa532685b7",
      "code": "request.not-found",
      "detail": "The requested resource was not found",
      "docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestnot-found"
    }
  ]
}

{
  "errors": [
    {
      "id": "07a1d642-dbf5-47d3-8563-700514b38e46",
      "code": "request.header.missing",
      "detail": "The request is missing a required header",
      "docUrl": "https://docs.payrails.com/docs/resources/error-codes#requestheadermissing"
    }
  ]
}

Authorizations

Authorization

string

header

required

You can use an OAuth2 JWT bearer token in the Authorization header of your API requests for supported endpoints: Authorization: Bearer <YOUR_JWT_HERE>. These tokens are valid for 10 minutes and can be requested via the access token endpoint endpoint.

Headers

x-idempotency-key

string<uuid>

required

Idempotency key to be used. Sending again the same key would return the same result without re-executing the update.

Body

application/json

workspaceId

string<uuid>

required

Unique identifier of a workspace in Payrails.

amount

object

required

Hide child attributes

amount.value

string

required

Decimal amount of the major currency unit. Can be any precision.

Pattern: [0-9]+(\.[0-9]+)?

Example:

"12.50"

amount.currency

string

required

ISO 3-letter currency code.

Pattern: ^[A-Z]{3}$

Example:

"EUR"

expiresAt

string<date-time>

required

Expiration timestamp in ISO 8601 format with timezone, for e.g. 2025-03-01T23:59:59Z. After this time the link is no longer valid.

workflowCode

string

default:payment-acceptance

Workflow code to use for the drop-in link execution.

allowPartialFulfillment

boolean

default:false

Whether the link can be paid in multiple partial payments.

description

string

Human-readable description displayed for the payment link.

merchantReference

string

Merchant reference for reconciliation, for e.g. an invoice number.

Response

Created.

string<uuid>

required

Unique identifier of the drop-in link.

workspaceId

string<uuid>

required

Unique identifier of a workspace in Payrails.

dropInLinkUrl

string<uri>

required

Public URL that can be shared with payers.

status

enum<string>

required

Current status of the drop-in link.

Available options:

enabled,

closed,

expired,

deleted

amount

object

required

Total amount configured for the payment link (decimal string value, ISO 3-letter currency code).

Hide child attributes

amount.value

string

required

Decimal amount of the major currency unit. Can be any precision.

Pattern: [0-9]+(\.[0-9]+)?

Example:

"12.50"

amount.currency

string

required

ISO 3-letter currency code.

Pattern: ^[A-Z]{3}$

Example:

"EUR"

paidAmount

object

required

Total amount paid so far (decimal string value, ISO 3-letter currency code).

Hide child attributes

paidAmount.value

string

required

Decimal amount of the major currency unit. Can be any precision.

Pattern: [0-9]+(\.[0-9]+)?

Example:

"12.50"

paidAmount.currency

string

required

ISO 3-letter currency code.

Pattern: ^[A-Z]{3}$

Example:

"EUR"

allowPartialFulfillment

boolean

required

Whether the link allows partial payments.

workflowCode

string

required

Workflow code used for executions created from this link.

expiresAt

string<date-time>

required

Expiration timestamp in ISO 8601 format with timezone, e.g. 2025-03-01T23:59:59Z.

createdAt

string<date-time>

required

Creation timestamp of the drop-in link.

executionId

string<uuid>

Workflow execution ID associated with the drop-in link, when one has been created.

description

string

Human-readable description of the payment link.

merchantReference

string

Merchant reference for reconciliation (commonly, the identifier of the order on the Merchant's system e.g. an invoice number).