Create and Pay Requests

The Request Network API provides an interface for creating and paying requests within your application.

Talk to an expert

Discover how Request Network API can enhance your app's features - book a call with us.

Core Functionality

At its core, the Request Network API empowers you to:

• Create Requests: Define payment requests with information such as payee, payer (optional), amount, currency, and recurrence (optional).

• Facilitate Payments: Return transaction calldata, ready to be signed by end-users and sent to the blockchain for secure and transparent value transfer.

• Deliver Webhook Notifications: Receive instant updates on payment status changes, enabling your application to react dynamically to completed transactions.

Create a new request

post

Create a new payment request

Header parameters

x-api-keystringRequired

API key for authentication

Body

payerstringOptional

The wallet address of the payer

payeestringRequired

The wallet address of the payee

amountstringRequired

The payable amount of the invoice, in human readable format

invoiceCurrencystringRequired

Invoice Currency ID, from the Request Network Token List e.g: USD

paymentCurrencystringRequired

Payment currency ID, from the Request Network Token List e.g: ETH-sepolia-sepolia

Responses

201

Request created successfully

application/json

400

Validation failed

application/json

401

Unauthorized

404

Wallet not found

429

Too Many Requests

post

HTTPcURLJavaScriptPython

POST /v1/request HTTP/1.1
Host: api.request.network
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 206

{
  "payee": "0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7",
  "amount": "10",
  "invoiceCurrency": "USD",
  "paymentCurrency": "ETH-sepolia-sepolia",
  "recurrence": {
    "startDate": "2025-01-01T00:00:00.000Z",
    "frequency": "DAILY"
  }
}

{
  "paymentReference": "0xb3581f0b0f74cc61",
  "requestID": "01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb"
}

Get request status

get

Get the status of a payment request

Path parameters

paymentReferencestringRequired

The payment reference of the request

Example: 0xb3581f0b0f74cc61

Header parameters

x-api-keystringRequired

API key for authentication

Responses

200

Request status retrieved successfully

application/json

401

Unauthorized

404

Request not found

429

Too Many Requests

get

HTTPcURLJavaScriptPython

GET /v1/request/{paymentReference} HTTP/1.1
Host: api.request.network
x-api-key: text
Accept: */*

{
  "hasBeenPaid": true,
  "paymentReference": "0xb3581f0b0f74cc61",
  "requestId": "01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb",
  "isListening": false,
  "txHash": "0x1234567890abcdef1234567890abcdef1234567890abcdef1234567890abcdef"
}

Stop a recurring request

patch

Stop a recurring request

Path parameters

paymentReferencestringRequired

The payment reference of the request

Example: 0xb3581f0b0f74cc61

Header parameters

x-api-keystringRequired

API key for authentication

Responses

200

Recurrence stopped successfully

401

Unauthorized

404

Request not found

429

Too Many Requests

patch

HTTPcURLJavaScriptPython

PATCH /v1/request/{paymentReference}/stop-recurrence HTTP/1.1
Host: api.request.network
x-api-key: text
Accept: */*

No content

Get payment calldata

get

Get the calldata needed to pay a request.

Path parameters

paymentReferencestringRequired

The payment reference of the request

Example: 0xb3581f0b0f74cc61

Query parameters

walletstringOptional

The wallet address of the payer.

Example: 0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7

chainstring · enumOptional

The source chain of the cross chain payment

Possible values:

tokenstring · enumOptional

The source token of the cross chain payment

Possible values:

amountstringOptional

The amount to pay, in human readable format

Header parameters

x-api-keystringRequired

API key for authentication

Responses

200

Payment calldata retrieved successfully

application/json

400

Validation failed

application/json

401

Unauthorized

404

Request not found

429

Too Many Requests

get

HTTPcURLJavaScriptPython

GET /v1/request/{paymentReference}/pay HTTP/1.1
Host: api.request.network
x-api-key: text
Accept: */*

{
  "transactions": [
    {
      "data": "0xb868980b...00",
      "to": "0x11BF2fDA23bF0A98365e1A4e04A87C9339e8687",
      "value": {
        "type": "BigNumber",
        "hex": "0x038d7ea4c68000"
      }
    }
  ],
  "metadata": {
    "stepsRequired": 1,
    "needsApproval": false,
    "approvalTransactionIndex": null,
    "hasEnoughBalance": true,
    "hasEnoughGas": true
  }
}

Initiate a payment

post

Initiate a payment without having to create a request first

Header parameters

x-api-keystringRequired

API key for authentication

Body

payeestringRequired

The wallet address of the payee

amountstringRequired

The payable amount of the invoice, in human readable format

invoiceCurrencystringRequired

Invoice Currency ID, from the Request Network Token List e.g: USD

paymentCurrencystringRequired

Payment currency ID, from the Request Network Token List e.g: ETH-sepolia-sepolia

Responses

201

Request created and payment initiated successfully

application/json

Responseany

401

Unauthorized

404

Wallet not found

429

Too Many Requests

post

HTTPcURLJavaScriptPython

POST /v1/pay HTTP/1.1
Host: api.request.network
x-api-key: text
Content-Type: application/json
Accept: */*
Content-Length: 132

{
  "payee": "0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7",
  "amount": "10",
  "invoiceCurrency": "USD",
  "paymentCurrency": "ETH-sepolia-sepolia"
}

{
  "requestID": "01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb",
  "paymentReference": "0xb3581f0b0f74cc61",
  "transactions": [
    {
      "data": "0xb868980b...00",
      "to": "0x11BF2fDA23bF0A98365e1A4e04A87C9339e8687",
      "value": {
        "type": "BigNumber",
        "hex": "0x038d7ea4c68000"
      }
    }
  ],
  "metadata": {
    "stepsRequired": 1,
    "needsApproval": false,
    "approvalTransactionIndex": null,
    "hasEnoughBalance": true,
    "hasEnoughGas": true
  }
}

For detailed information on all available endpoints and their parameters, please refer to the full Request Network API Reference

Create and Pay Request Workflow

The following diagram illustrates the typical flow for creating and paying requests using the Request Network API: