Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.pawpayments.com/llms.txt

Use this file to discover all available pages before exploring further.

Failures return HTTP 4xx/5xx with a JSON body:
{
  "ok": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Validation failed",
    "details": [
      { "field": "amount", "message": "Input should be greater than 0" }
    ]
  }
}
Always branch on error.code rather than the human message — codes are stable, messages may change.

Common codes

HTTPcodeMeaning
400INVALID_IDThe path id is not a valid ObjectId / UUID.
400INVOICE_REJECTEDBusiness rule violation while creating an invoice.
400MISSING_HEADER / INVALID_HEADERRequired header missing or malformed (e.g. x-uniq-id).
401UNAUTHORIZEDMissing or invalid x-api-key.
403PAYOUTS_DISABLEDIP not whitelisted for payouts.
404NOT_FOUNDThe requested resource is invisible to this merchant.
409DUPLICATESame x-uniq-id already used.
422VALIDATION_ERRORBody did not match the schema. details lists the failing fields.