Aura Logo
AuraAPI Docs
OpenapiV1Payments

Record payment

Record a payment from any source (Stripe, FanBasis, WOP, manual, etc.)

Use Cases:

  • Record payments from external payment processors
  • Manual payment entry for offline transactions
  • Sync payments from partner platforms

Required fields:

  • lead_id - Associated lead UUID
  • amount - Amount in cents (integer)
  • payment_date - ISO 8601 date
  • status - Payment status
  • source - Payment source identifier
POST
/v1/payments
amountnumber

Payment amount in DOLLARS, with up to two decimal places (e.g. 5000.00 for five thousand dollars). This is the same unit GET /v1/payments returns and the same unit the /v1/analytics/* revenue figures aggregate — money is dollars everywhere in this API.

Range0 <= value
call_id?string

Call ID this payment is linked to

currency?string

ISO 4217 currency code

Default"USD"
Length3 <= length <= 3
external_id?string

External payment/transaction ID

lead_idstring

Lead ID this payment is from

payment_datestring

ISO 8601 payment date

Formatdate-time
product_id?string

Product ID this payment is for

sourcestring

Payment source (e.g., "stripe", "fanbasis", "wop", "manual")

statusstring

Payment status

Value in"pending" | "succeeded" | "failed" | "refunded"

Response Body

application/json

application/json

application/json

curl -X POST "https://api.aura-app.ai/v1/payments" \  -H "Content-Type: application/json" \  -d '{    "amount": 5000,    "lead_id": "550e8400-e29b-41d4-a716-446655440000",    "payment_date": "2026-01-17T08:00:00Z",    "source": "manual",    "status": "succeeded"  }'
{
  "data": {
    "amount": 5000,
    "call_id": "string",
    "created_at": "2019-08-24T14:15:22Z",
    "currency": "usd",
    "customer_email": "string",
    "customer_name": "string",
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "lead_id": "string",
    "match_candidates": [
      {
        "confidence": 0.7,
        "email": "string",
        "lead_id": "string",
        "name": "string",
        "reason": "email_exact",
        "property1": null,
        "property2": null
      }
    ],
    "match_confidence": 0,
    "matched_by": "string",
    "matched_product_id": "string",
    "organization_id": "string",
    "payment_date": "2019-08-24T14:15:22Z",
    "provider": "stripe",
    "provider_payment_id": "pi_xxxxx",
    "refund_reason": "string",
    "refund_status": "string",
    "refunded_amount": 0,
    "refunded_at": "2019-08-24T14:15:22Z",
    "status": "succeeded",
    "stripe_charge_id": "string",
    "stripe_customer_id": "string",
    "stripe_product_id": "string",
    "stripe_refund_id": "string",
    "stripe_subscription_id": "string",
    "verification_status": "confirmed",
    "verified_at": "2019-08-24T14:15:22Z"
  },
  "success": true
}
{
  "code": "NOT_FOUND",
  "error": "Lead not found",
  "requestId": "req_abc123",
  "success": false
}
{
  "code": "NOT_FOUND",
  "error": "Lead not found",
  "requestId": "req_abc123",
  "success": false
}