Skip to main content
This API allows you to create and manage payment claim links for customers to submit cryptocurrency payment information.
​
id
string
Unique identifier with pcl_ prefix (e.g., pcl_abc123def456).
​
object
string
Always "payment_claim_link".
​
status
string
Link status: active, used, or expired.
​
expires_at
string
When the link expires (ISO 8601).
​
max_uses
integer
Maximum number of times the link can be used.
​
use_count
integer
Number of times the link has been used.
​
used_at
string
When the link was last used (ISO 8601). null if never used.
​
metadata
string
Additional notes or metadata.
​
link
string
The full URL to share with the customer.
​
customer_id
string
The customer this link belongs to.
​
crypto_payment_claim_id
string
ID of the resulting payment claim. null if not used.
​
usable
boolean
Whether the link can still be used.
​
expired
boolean
Whether the link has expired.
​
created_at
string
When the link was created (ISO 8601).
​
updated_at
string
When the link was last updated (ISO 8601).
GET /v1/payment_claim_links
Retrieves a paginated list of all payment claim links in your account. Links are ordered by creation date (newest first).
​
page
integer
default:"1"
Page number for pagination. Results are returned 25 items per page.
curl https://api.gettrxn.com/v1/payment_claim_links \
  -H "Authorization: Bearer $TRXN_TOKEN"
Response
{
  "payment_claim_links": [
    {
      "id": "pcl_abc123def456",
      "object": "payment_claim_link",
      "status": "active",
      "expires_at": "2025-01-26T12:00:00Z",
      "max_uses": 1,
      "use_count": 0,
      "used_at": null,
      "metadata": "Payment for Invoice #123",
      "link": "https://gettrxn.com/payment-claim/RTL1LDMHAdL6JR64ai7frBpphuuNig9q",
      "customer_id": "cust_xyz789",
      "crypto_payment_claim_id": null,
      "usable": true,
      "expired": false,
      "created_at": "2025-01-25T12:00:00Z",
      "updated_at": "2025-01-25T12:00:00Z"
    }
  ],
  "pagination": {
    "page": 1,
    "pages": 3,
    "count": 67
  }
}

GET /v1/payment_claim_links/:id
Retrieves a specific payment claim link by ID.
​
id
string
required
The payment claim link’s ID (e.g., pcl_abc123def456).
curl https://api.gettrxn.com/v1/payment_claim_links/pcl_abc123def456 \
  -H "Authorization: Bearer $TRXN_TOKEN"
Response
{
  "id": "pcl_abc123def456",
  "object": "payment_claim_link",
  "status": "active",
  "expires_at": "2025-01-26T12:00:00Z",
  "max_uses": 1,
  "use_count": 0,
  "used_at": null,
  "metadata": "Payment for Invoice #123",
  "link": "https://gettrxn.com/payment-claim/RTL1LDMHAdL6JR64ai7frBpphuuNig9q",
  "customer_id": "cust_xyz789",
  "crypto_payment_claim_id": null,
  "usable": true,
  "expired": false,
  "created_at": "2025-01-25T12:00:00Z",
  "updated_at": "2025-01-25T12:00:00Z"
}

POST /v1/payment_claim_links
Creates a new payment claim link for a customer.
​
customer_id
string
required
The customer’s ID (e.g., cust_abc123def456). Must belong to your account.
​
expires_at
string
When the link expires (ISO 8601 format). Defaults to 24 hours from now.
​
max_uses
integer
default:"1"
Maximum number of times the link can be used. Must be greater than 0.
​
metadata
string
Additional notes or metadata for the link.
curl -X POST https://api.gettrxn.com/v1/payment_claim_links \
  -H "Authorization: Bearer $TRXN_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "customer_id": "cust_abc123def456",
    "expires_at": "2025-01-26T10:00:00Z",
    "max_uses": 1,
    "metadata": "Payment for Invoice #123"
  }'
Response
{
  "id": "pcl_xyz789abc123",
  "object": "payment_claim_link",
  "status": "active",
  "expires_at": "2025-01-26T10:00:00Z",
  "max_uses": 1,
  "use_count": 0,
  "used_at": null,
  "metadata": "Payment for Invoice #123",
  "link": "https://gettrxn.com/payment-claim/RTL1LDMHAdL6JR64ai7frBpphuuNig9q",
  "customer_id": "cust_abc123def456",
  "crypto_payment_claim_id": null,
  "usable": true,
  "expired": false,
  "created_at": "2025-01-25T14:30:00Z",
  "updated_at": "2025-01-25T14:30:00Z"
}

​
Error responses

Customer not found
{
  "error": {
    "type": "invalid_request_error",
    "code": "resource_not_found",
    "message": "Customer not found",
    "param": "customer_id"
  }
}
Invalid max_uses
{
  "error": {
    "type": "invalid_request_error",
    "code": "parameter_invalid",
    "message": "Max uses must be greater than 0",
    "param": "max_uses"
  }
}

DELETE /v1/payment_claim_links/:id
Deletes a payment claim link.
​
id
string
required
The payment claim link’s ID (e.g., pcl_xyz789abc123).
curl -X DELETE https://api.gettrxn.com/v1/payment_claim_links/pcl_xyz789abc123 \
  -H "Authorization: Bearer $TRXN_TOKEN"
Returns 204 No Content on successful deletion.
StatusDescription
activeLink is active and can be used.
usedLink has reached its max_uses limit.
expiredLink has expired (past expires_at).
The usable field indicates whether a link can still be used. A link is usable if:
  • Status is active.
  • Not expired (expires_at is in the future).
  • Use count is less than max_uses.

​
Usage flow

  1. Create a payment claim link for a customer using their ID.
  2. Share the link with the customer (via email, SMS, etc.).
  3. Customer visits the link and submits their payment information.
  4. Review the submission in your dashboard under Crypto Payment Claims.
  5. Approve or reject the payment claim.
  6. Optionally delete the link if no longer needed.

​
Sandbox support

The API respects sandbox scoping. If your API token is associated with a sandbox, you can only access links created in that sandbox. Links created in sandbox mode will be isolated from production data.