Skip to main content
POST
/
v2
/
request
Create a new request
curl --request POST \
  --url https://api.stage.request.network/v2/request \
  --header 'Content-Type: application/json' \
  --data '{
  "payee": "0x6923831ACf5c327260D7ac7C9DfF5b1c3cB3C7D7",
  "amount": "10",
  "invoiceCurrency": "USD",
  "paymentCurrency": "ETH-sepolia-sepolia",
  "isCryptoToFiatAvailable": false,
  "recurrence": {
    "startDate": "2030-01-01",
    "frequency": "DAILY"
  }
}'
{
  "paymentReference": "0xb3581f0b0f74cc61",
  "requestId": "01e273ecc29d4b526df3a0f1f05ffc59372af8752c2b678096e49ac270416a7cdb"
}

Headers

​
x-api-key
string

API key for authentication (optional if using Client ID)

​
x-client-id
string

Client ID for frontend authentication (optional if using API key)

​
Origin
string

Origin header (required for Client ID auth, automatically set by browser)

Body

application/json
​
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

​
payee
string

The wallet address of the payee. Required for all requests except crypto-to-fiat

​
recurrence
object

The recurrence of the invoice

​
isCryptoToFiatAvailable
boolean

Whether crypto-to-fiat payment is available for this request

​
customerInfo
object

Optional customer information for merchant receipt tracking

​
reference
string

Merchant reference for receipt tracking and identification

Required string length: 1 - 255
​
originalRequestId
string

ID of the original request for recurring payments

Minimum length: 1
​
originalRequestPaymentReference
string

Payment reference of the original request for recurring payments

Minimum length: 1

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"

⌘I