POST
/
v1
/
request
Create a new request
curl --request POST \
  --url https://api.request.network/v1/request \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '{
  "payee": "0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7",
  "amount": "10",
  "invoiceCurrency": "USD",
  "paymentCurrency": "ETH-sepolia-sepolia",
  "recurrence": {
    "startDate": "2030-01-01",
    "frequency": "DAILY"
  }
}'
{
  "paymentReference": "0xb3581f0b0f74cc61",
  "requestID": "01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb"
}

Headers

​
x-api-key
string
required

API key for authentication

Body

application/json
​
payee
string
required

The wallet address of the payee

​
amount
string
required

The payable amount of the invoice, in human readable format

​
invoiceCurrency
string
required

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

​
paymentCurrency
string
required

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

​
payer
string

The wallet address of the payer

​
recurrence
object

The recurrence of the invoice

Response

Request created successfully

​
paymentReference
string

Unique identifier of the request, used to pay the request as well as check the status of the request

Example:

"0xb3581f0b0f74cc61"

​
requestID
string

Unique identifier of the request, commonly used to look up a request in Request Scan

Example:

"01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb"