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, and currency details.

• 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

Create a new payment request

post

/v1/request

Header parameters

x-api-keystringrequired

API key for authentication

Body

payerstring

payeestringrequired

amountstringrequired

invoiceCurrencystringrequired

paymentCurrencystringrequired

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.request.network/v1/request' \
  --header 'x-api-key: text' \
  --header 'Content-Type: application/json'

201

401

404

429

201

{
  "requestID": "text",
  "paymentReference": "text"
}

Request created successfully

The invoiceCurrencyand paymentCurrency strings must each be the id of a token listed in the Request Network Token List

Get request status

Get the status of a payment request

get

/v1/request/{paymentReference}

Path parameters

paymentReferencestringrequired

Header parameters

x-api-keystringrequired

API key for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.request.network/v1/request/{paymentReference}' \
  --header 'x-api-key: text'

200

401

404

429

200

{
  "hasBeenPaid": true,
  "paymentReference": "text",
  "requestId": "text",
  "isListening": true,
  "txHash": "text"
}

Request status retrieved successfully

Get payment calldata

Get the calldata needed to pay a request

get

/v1/request/{paymentReference}/pay

Path parameters

paymentReferencestringrequired

Header parameters

x-api-keystringrequired

API key for authentication

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.request.network/v1/request/{paymentReference}/pay' \
  --header 'x-api-key: text'

200

401

404

429

200

{
  "transactions": [
    "text"
  ],
  "metadata": {
    "stepsRequired": 1,
    "needsApproval": true,
    "approvalTransactionIndex": 1
  }
}

Payment calldata retrieved successfully

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: