Links | PayrazeHQ API Docs

get

List of payment links

Authorizations

Query parameters

perPageintegerOptional

Number of items per page

Example: 100

pageintegerOptional

Page number

Example: 1

Responses

200

Payment Links

application/json

Responseany

401

Request is unauthenticated

application/json

get

GET /api/v1/link/list HTTP/1.1
Host: payrazehq.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "items": [
    {
      "id": 1,
      "amount": 48934,
      "currency": {
        "id": 1,
        "name": "Ethereum",
        "code": "ETH"
      },
      "status": "Pending",
      "createdOn": "2025-07-15"
    }
  ],
  "currentPage": 1,
  "lastPage": 1,
  "itemsPerPage": 100,
  "pageItems": 4,
  "total": 4,
  "timestamp": "2024-05-29, 10:13:54"
}

post

Create a new link

Authorizations

Body

anyOptionalExample: {"currencyId":3,"amount":12.546}

Responses

200

Link successfully created

application/json

Responseany

401

Request is unauthenticated

application/json

500

Server error, something went wrong on the server

application/json

post

POST /api/v1/link/create HTTP/1.1
Host: payrazehq.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 32

{
  "currencyId": 3,
  "amount": 12.546
}

{
  "message": "Link created successfully.",
  "timestamp": "2024-01-01 12:12:00"
}

get

Details of a single link

Authorizations

Path parameters

idintegerRequired

ID of the payment link

Example: 1

Responses

200

Link details

application/json

Responseany

401

Request is unauthenticated

application/json

get

GET /api/v1/link/edit/{id} HTTP/1.1
Host: payrazehq.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "id": 1,
  "currency": {
    "id": 1,
    "name": "Ethereum",
    "code": "ETH"
  },
  "amount": 48934,
  "link": "http://localhost:9087/p/5e6ccf40",
  "hash": null,
  "status": "Pending",
  "createdAt": "2025-07-15"
}

put

Update a link

Authorizations

Path parameters

idintegerRequired

Link ID

Example: 1

Body

anyOptionalExample: {"currencyId":3,"amount":12.430834345}

Responses

200

Link updated successfully.

application/json

Responseany

401

Request is unauthenticated

application/json

404

Link not found

application/json

500

Server error, something went wrong on the server

application/json

put

PUT /api/v1/link/update/{id} HTTP/1.1
Host: payrazehq.com
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "currencyId": 3,
  "amount": 12.430834345
}

{
  "message": "Link updated successfully.",
  "timestamp": "2024-01-01 12:12:00"
}

delete

Delete a link

Authorizations

Path parameters

idintegerRequiredExample: 1

Responses

200

Link deleted successfully

application/json

Responseany

400

Already Paid

application/json

401

UnAuthentication

application/json

500

Server error, something went wrong on the server

application/json

delete

DELETE /api/v1/link/delete/{id} HTTP/1.1
Host: payrazehq.com
Authorization: YOUR_API_KEY
Accept: */*

{
  "message": "Link deleted successfully",
  "timestamp": "2024-01-01, 00:00:00"
}