Request a payment

Request the payment

Create the request with POST /payment-requests. Address the payer by email, phone, party id, agent id, or handle, the same set you use for a payment counterparty.

import uuid
from naturalpay import Natural

agent_client = Natural(
    x_agent_id="agt_019cd17a4f2e7b9c8d6e5f4a3b2c1d0e",
    x_instance_id=str(uuid.uuid4()),
)

request = agent_client.payment_requests.create(
    amount=2500,
    currency="USD",
    description="Invoice 7",
    payer_name="Natural Client",
    payer={"type": "email", "value": "client@example.com"},
    idempotency_key=str(uuid.uuid4()),
)

import Natural from "@naturalpay/sdk";

const client = new Natural();
const request = await client.paymentRequests.create(
  {
    amount: 2500,
    currency: "USD",
    description: "Invoice 7",
    payerName: "Natural Client",
    payer: { type: "email", value: "client@example.com" },
    idempotencyKey: crypto.randomUUID(),
  },
  {
    xAgentId: "agt_019cd17a4f2e7b9c8d6e5f4a3b2c1d0e",
    xInstanceId: crypto.randomUUID(),
  },
);

natural payment-requests create \
  --amount 2500 \
  --currency USD \
  --description "Invoice 7" \
  --payer-name "Natural Client" \
  --params '{"payer": {"type": "email", "value": "client@example.com"}}' \
  --x-agent-id agt_019cd17a4f2e7b9c8d6e5f4a3b2c1d0e \
  --x-instance-id "$(uuidgen)" \
  --idempotency-key "$(uuidgen)"

Using my Procurement Agent, request $25 from client@example.com for Invoice 7.

curl -X POST https://api.natural.com/payment-requests \
  -H "Authorization: Bearer $NATURAL_API_KEY" \
  -H "X-Agent-ID: agt_019cd17a4f2e7b9c8d6e5f4a3b2c1d0e" \
  -H "X-Instance-ID: $(uuidgen)" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "data": {
      "attributes": {
        "amount": 2500,
        "currency": "USD",
        "description": "Invoice 7",
        "payerName": "Natural Client",
        "payer": { "type": "email", "value": "client@example.com" }
      }
    }
  }'

The response carries the request id (prq_*) and the paymentLinkUrl. Natural delivers the payment request over email or phone number.

Track it

Check status any time with GET /payment-requests/{paymentRequestId}. A request stays OPEN until the payer settles it.

request = client.payment_requests.get(request.data.id)

const status = await client.paymentRequests.get({
  paymentRequestId: request.data.id,
});

natural payment-requests get --payment-request-id prq_550e8400e29b41d4a716446655440000

What's the status of that payment request?

curl https://api.natural.com/payment-requests/prq_550e8400e29b41d4a716446655440000 \
  -H "Authorization: Bearer $NATURAL_API_KEY"

Cancel it

Cancel an open request with POST /payment-requests/{paymentRequestId}/cancel to void its payment link and move it to CANCELED. Once a payer fulfills one, it’s money movement and settles normally.

import uuid

canceled = client.payment_requests.cancel(
    request.data.id,
    idempotency_key=str(uuid.uuid4()),
)

const canceled = await client.paymentRequests.cancel({
  paymentRequestId: request.data.id,
  idempotencyKey: crypto.randomUUID(),
});

natural payment-requests cancel \
  --payment-request-id prq_550e8400e29b41d4a716446655440000 \
  --idempotency-key "$(uuidgen)"

curl -X POST https://api.natural.com/payment-requests/prq_550e8400e29b41d4a716446655440000/cancel \
  -H "Authorization: Bearer $NATURAL_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

Overview

Common use cases

Products

Guides

Request the payment

Track it

Cancel it

​Request the payment

​Track it

​Cancel it

Request the payment

Track it

Cancel it