Beladed Payments API

Create Payment Link

beta

Create Payment Link through the reviewed Beladed Payments contract.

POST/api/payment/link/create

Authentication: secret key
Minimum permission: edit
Accounts: Business, Streamer
Platforms: server
Stability: beta

curl --request POST 'https://api.beladed.dev/api/payment/link/create' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'X-Beladed-API-Key: BELADED_SECRET_KEY' \
  --data '{
  "source": {
    "nickname": "Test payment link 1",
    "amount_details": {
      "amount_type": "FIXED",
      "total_amount": 7500,
      "currency": "USD"
    },
    "allowed_payment_methods": [
      "PAYMENT_CARD",
      "BANK_ACCOUNT"
    ],
    "payment_frequency": "ONE_TIME",
    "description": "Test payment link",
    "merchantId": "id_demo_001",
    "cardId": "id_demo_001",
    "identityId": "id_demo_001",
    "items": [
      {
        "name": "Holiday Dinner Contribution",
        "quantity": "1",
        "image_details": {
          "primary_image_url": "https://merchant.example.invalid/assets/example.png"
        }
      }
    ]
  }
}'

const response = await fetch("https://api.beladed.dev/api/payment/link/create", {
  method: "POST",
  headers: {
  "Accept": "application/json",
  "Content-Type": "application/json",
  "X-Beladed-API-Key": "BELADED_SECRET_KEY"
},
  body: JSON.stringify({
  "source": {
    "nickname": "Test payment link 1",
    "amount_details": {
      "amount_type": "FIXED",
      "total_amount": 7500,
      "currency": "USD"
    },
    "allowed_payment_methods": [
      "PAYMENT_CARD",
      "BANK_ACCOUNT"
    ],
    "payment_frequency": "ONE_TIME",
    "description": "Test payment link",
    "merchantId": "id_demo_001",
    "cardId": "id_demo_001",
    "identityId": "id_demo_001",
    "items": [
      {
        "name": "Holiday Dinner Contribution",
        "quantity": "1",
        "image_details": {
          "primary_image_url": "https://merchant.example.invalid/assets/example.png"
        }
      }
    ]
  }
})
});
const data = await response.json();

import requests

response = requests.request(
    "POST",
    "https://api.beladed.dev/api/payment/link/create",
    headers={"Accept":"application/json","Content-Type":"application/json","X-Beladed-API-Key":"BELADED_SECRET_KEY"},
    json={
  "source": {
    "nickname": "Test payment link 1",
    "amount_details": {
      "amount_type": "FIXED",
      "total_amount": 7500,
      "currency": "USD"
    },
    "allowed_payment_methods": [
      "PAYMENT_CARD",
      "BANK_ACCOUNT"
    ],
    "payment_frequency": "ONE_TIME",
    "description": "Test payment link",
    "merchantId": "id_demo_001",
    "cardId": "id_demo_001",
    "identityId": "id_demo_001",
    "items": [
      {
        "name": "Holiday Dinner Contribution",
        "quantity": "1",
        "image_details": {
          "primary_image_url": "https://merchant.example.invalid/assets/example.png"
        }
      }
    ]
  }
},
    timeout=30,
)
response.raise_for_status()
data = response.json()

<?php
$client = curl_init("https://api.beladed.dev/api/payment/link/create");
curl_setopt_array($client, [
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => ["Accept: application/json","Content-Type: application/json","X-Beladed-API-Key: BELADED_SECRET_KEY"],
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_POSTFIELDS => json_encode({
  "source": {
    "nickname": "Test payment link 1",
    "amount_details": {
      "amount_type": "FIXED",
      "total_amount": 7500,
      "currency": "USD"
    },
    "allowed_payment_methods": [
      "PAYMENT_CARD",
      "BANK_ACCOUNT"
    ],
    "payment_frequency": "ONE_TIME",
    "description": "Test payment link",
    "merchantId": "id_demo_001",
    "cardId": "id_demo_001",
    "identityId": "id_demo_001",
    "items": [
      {
        "name": "Holiday Dinner Contribution",
        "quantity": "1",
        "image_details": {
          "primary_image_url": "https://merchant.example.invalid/assets/example.png"
        }
      }
    ]
  }
}),
]);
$response = curl_exec($client);

require "net/http"
require "json"

uri = URI("https://api.beladed.dev/api/payment/link/create")
request = Net::HTTP::Post.new(uri)
request["Accept"] = "application/json"
request["Content-Type"] = "application/json"
request["X-Beladed-API-Key"] = "BELADED_SECRET_KEY"
request.body = "{\n  \"source\": {\n    \"nickname\": \"Test payment link 1\",\n    \"amount_details\": {\n      \"amount_type\": \"FIXED\",\n      \"total_amount\": 7500,\n      \"currency\": \"USD\"\n    },\n    \"allowed_payment_methods\": [\n      \"PAYMENT_CARD\",\n      \"BANK_ACCOUNT\"\n    ],\n    \"payment_frequency\": \"ONE_TIME\",\n    \"description\": \"Test payment link\",\n    \"merchantId\": \"id_demo_001\",\n    \"cardId\": \"id_demo_001\",\n    \"identityId\": \"id_demo_001\",\n    \"items\": [\n      {\n        \"name\": \"Holiday Dinner Contribution\",\n        \"quantity\": \"1\",\n        \"image_details\": {\n          \"primary_image_url\": \"https://merchant.example.invalid/assets/example.png\"\n        }\n      }\n    ]\n  }\n}"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

var request = java.net.http.HttpRequest.newBuilder()
    .uri(java.net.URI.create("https://api.beladed.dev/api/payment/link/create"))
    .header("Accept", "application/json")
    .header("Content-Type", "application/json")
    .header("X-Beladed-API-Key", "BELADED_SECRET_KEY")
    .method("POST", java.net.http.HttpRequest.BodyPublishers.ofString("{\n  \"source\": {\n    \"nickname\": \"Test payment link 1\",\n    \"amount_details\": {\n      \"amount_type\": \"FIXED\",\n      \"total_amount\": 7500,\n      \"currency\": \"USD\"\n    },\n    \"allowed_payment_methods\": [\n      \"PAYMENT_CARD\",\n      \"BANK_ACCOUNT\"\n    ],\n    \"payment_frequency\": \"ONE_TIME\",\n    \"description\": \"Test payment link\",\n    \"merchantId\": \"id_demo_001\",\n    \"cardId\": \"id_demo_001\",\n    \"identityId\": \"id_demo_001\",\n    \"items\": [\n      {\n        \"name\": \"Holiday Dinner Contribution\",\n        \"quantity\": \"1\",\n        \"image_details\": {\n          \"primary_image_url\": \"https://merchant.example.invalid/assets/example.png\"\n        }\n      }\n    ]\n  }\n}"))
    .build();
var response = java.net.http.HttpClient.newHttpClient().send(request, java.net.http.HttpResponse.BodyHandlers.ofString());

package main

import (
  "bytes"
  "net/http"
)

func callBeladed() (*http.Response, error) {
  body := []byte("{\n  \"source\": {\n    \"nickname\": \"Test payment link 1\",\n    \"amount_details\": {\n      \"amount_type\": \"FIXED\",\n      \"total_amount\": 7500,\n      \"currency\": \"USD\"\n    },\n    \"allowed_payment_methods\": [\n      \"PAYMENT_CARD\",\n      \"BANK_ACCOUNT\"\n    ],\n    \"payment_frequency\": \"ONE_TIME\",\n    \"description\": \"Test payment link\",\n    \"merchantId\": \"id_demo_001\",\n    \"cardId\": \"id_demo_001\",\n    \"identityId\": \"id_demo_001\",\n    \"items\": [\n      {\n        \"name\": \"Holiday Dinner Contribution\",\n        \"quantity\": \"1\",\n        \"image_details\": {\n          \"primary_image_url\": \"https://merchant.example.invalid/assets/example.png\"\n        }\n      }\n    ]\n  }\n}")
  request, err := http.NewRequest("POST", "https://api.beladed.dev/api/payment/link/create", bytes.NewReader(body))
  if err != nil { return nil, err }
  request.Header.Set("Accept", "application/json")
  request.Header.Set("Content-Type", "application/json")
  request.Header.Set("X-Beladed-API-Key", "BELADED_SECRET_KEY")
  return http.DefaultClient.Do(request)
}

using var client = new HttpClient();
using var request = new HttpRequestMessage(new HttpMethod("POST"), "https://api.beladed.dev/api/payment/link/create");
request.Headers.TryAddWithoutValidation("Accept", "application/json");
request.Headers.TryAddWithoutValidation("Content-Type", "application/json");
request.Headers.TryAddWithoutValidation("X-Beladed-API-Key", "BELADED_SECRET_KEY");
request.Content = new StringContent("{\n  \"source\": {\n    \"nickname\": \"Test payment link 1\",\n    \"amount_details\": {\n      \"amount_type\": \"FIXED\",\n      \"total_amount\": 7500,\n      \"currency\": \"USD\"\n    },\n    \"allowed_payment_methods\": [\n      \"PAYMENT_CARD\",\n      \"BANK_ACCOUNT\"\n    ],\n    \"payment_frequency\": \"ONE_TIME\",\n    \"description\": \"Test payment link\",\n    \"merchantId\": \"id_demo_001\",\n    \"cardId\": \"id_demo_001\",\n    \"identityId\": \"id_demo_001\",\n    \"items\": [\n      {\n        \"name\": \"Holiday Dinner Contribution\",\n        \"quantity\": \"1\",\n        \"image_details\": {\n          \"primary_image_url\": \"https://merchant.example.invalid/assets/example.png\"\n        }\n      }\n    ]\n  }\n}", System.Text.Encoding.UTF8, "application/json");
using var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();

var request = URLRequest(url: URL(string: "https://api.beladed.dev/api/payment/link/create")!)
request.httpMethod = "POST"
request.setValue("application/json", forHTTPHeaderField: "Accept")
request.setValue("application/json", forHTTPHeaderField: "Content-Type")
request.setValue("BELADED_SECRET_KEY", forHTTPHeaderField: "X-Beladed-API-Key")
request.httpBody = "{\n  \"source\": {\n    \"nickname\": \"Test payment link 1\",\n    \"amount_details\": {\n      \"amount_type\": \"FIXED\",\n      \"total_amount\": 7500,\n      \"currency\": \"USD\"\n    },\n    \"allowed_payment_methods\": [\n      \"PAYMENT_CARD\",\n      \"BANK_ACCOUNT\"\n    ],\n    \"payment_frequency\": \"ONE_TIME\",\n    \"description\": \"Test payment link\",\n    \"merchantId\": \"id_demo_001\",\n    \"cardId\": \"id_demo_001\",\n    \"identityId\": \"id_demo_001\",\n    \"items\": [\n      {\n        \"name\": \"Holiday Dinner Contribution\",\n        \"quantity\": \"1\",\n        \"image_details\": {\n          \"primary_image_url\": \"https://merchant.example.invalid/assets/example.png\"\n        }\n      }\n    ]\n  }\n}".data(using: .utf8)
let (data, response) = try await URLSession.shared.data(for: request)

val request = okhttp3.Request.Builder()
  .url("https://api.beladed.dev/api/payment/link/create")
  .addHeader("Accept", "application/json")
  .addHeader("Content-Type", "application/json")
  .addHeader("X-Beladed-API-Key", "BELADED_SECRET_KEY")
  .method("POST", okhttp3.RequestBody.create(okhttp3.MediaType.get("application/json"), "{\n  \"source\": {\n    \"nickname\": \"Test payment link 1\",\n    \"amount_details\": {\n      \"amount_type\": \"FIXED\",\n      \"total_amount\": 7500,\n      \"currency\": \"USD\"\n    },\n    \"allowed_payment_methods\": [\n      \"PAYMENT_CARD\",\n      \"BANK_ACCOUNT\"\n    ],\n    \"payment_frequency\": \"ONE_TIME\",\n    \"description\": \"Test payment link\",\n    \"merchantId\": \"id_demo_001\",\n    \"cardId\": \"id_demo_001\",\n    \"identityId\": \"id_demo_001\",\n    \"items\": [\n      {\n        \"name\": \"Holiday Dinner Contribution\",\n        \"quantity\": \"1\",\n        \"image_details\": {\n          \"primary_image_url\": \"https://merchant.example.invalid/assets/example.png\"\n        }\n      }\n    ]\n  }\n}"))
  .build()
val response = okhttp3.OkHttpClient().newCall(request).execute()

Parameters

This operation has no documented parameters.

Request body

Requestapplication/json

Schema

{
  "type": "object",
  "properties": {
    "source": {
      "type": "object",
      "properties": {
        "nickname": {
          "type": "string"
        },
        "amount_details": {
          "type": "object",
          "properties": {
            "amount_type": {
              "type": "string"
            },
            "total_amount": {
              "type": "integer"
            },
            "currency": {
              "type": "string"
            }
          }
        },
        "allowed_payment_methods": {
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "payment_frequency": {
          "type": "string"
        },
        "description": {
          "type": "string"
        },
        "merchantId": {
          "type": "string"
        },
        "cardId": {
          "type": "string"
        },
        "identityId": {
          "type": "string"
        },
        "items": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "name": {
                "type": "string"
              },
              "quantity": {
                "type": "string"
              },
              "image_details": {
                "type": "object",
                "properties": {
                  "primary_image_url": {
                    "type": "string"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}

{
  "source": {
    "nickname": "Test payment link 1",
    "amount_details": {
      "amount_type": "FIXED",
      "total_amount": 7500,
      "currency": "USD"
    },
    "allowed_payment_methods": [
      "PAYMENT_CARD",
      "BANK_ACCOUNT"
    ],
    "payment_frequency": "ONE_TIME",
    "description": "Test payment link",
    "merchantId": "id_demo_001",
    "cardId": "id_demo_001",
    "identityId": "id_demo_001",
    "items": [
      {
        "name": "Holiday Dinner Contribution",
        "quantity": "1",
        "image_details": {
          "primary_image_url": "https://merchant.example.invalid/assets/example.png"
        }
      }
    ]
  }
}

Responses

200The request succeeded.

Responseapplication/json

Schema

{
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "properties": {
        "id": {
          "type": "string"
        },
        "status": {
          "type": "string"
        }
      }
    },
    "requestId": {
      "type": "string"
    }
  }
}

{
  "data": {
    "id": "id_demo_001",
    "status": "available"
  },
  "requestId": "req_demo_001"
}

Errors

400invalid_request

The request did not satisfy the documented contract.

401authentication_required

The credential is missing or invalid.

403not_authorized

The account, product scope, permission, or origin is not eligible.

404not_found

The requested public or account-owned resource was not found.

429rate_limited

Retry after the current product limit resets.

Reliability

Idempotency: No public Idempotency-Key guarantee is declared; use a stable client reference and confirm resource state before retrying.
Pagination: Not applicable.
Rate limit: Subject to current account, product, and abuse-protection limits. Honor Retry-After when returned.
Webhook events: No related public event is declared.

Contract provenance

This operation is published from reviewed repository contracts. Source metadata is included for traceability without exposing internal implementation details.

Route owner: ../beladed-api-cloudflare/src/functions/payment.js
Handler owner: ../beladed-api-cloudflare/src/functions/core/PaymentPaymentLink.js
Verified: 2026-07-11