Payment Webhook Payload

payment.status is the status of this one payment. It doesn’t tell you whether the invoice is paid: one payment can cover part of an invoice, and credits and adjustments settle invoices without a card or bank payment. For the invoice’s own status, read payment.invoice.status, described in Invoice statuses.

Payment statuses

Status	Meaning
PROCESSING	The payment has been submitted and hasn’t settled yet.
SUCCESS	The payment succeeded.
FAILED	The payment failed. error says why.
REFUND_INITIATED	A refund of this payment has started.
PARTIALLY_REFUNDED	Part of this payment has been refunded.
REFUNDED	All of this payment has been refunded.

payment_method tells you how the payment was made: CREDIT_CARD, ACH, WIRE, CHECK, CREDIT (credits applied to the invoice) or ADJUSTMENT (an adjustment recorded against the invoice). Credits and adjustments are recorded as payments, so they count towards the invoice’s paid_amount.

Example

JSON

{
  "payment": {
    "error": null,
    "id": "a94bb985-7bc3-43de-aa79-ec1c9fa7abaf",
    "invoice": {
      "due_at": "2023-01-28T02:43:21.879153Z",
      "due_days": 30,
      "ends_at": "2023-01-28T23:59:59.999999Z",
      "id": "794d16df-03cc-4d6d-a4b7-7884b8b06897",
      "invoice_number": "794d16df-0",
      "is_partial_agreement": false,
      "num_days": 0,
      "order": {
        "agreement_number": 1,
        "billing_schedule": "annually",
        "buyer": {
          "address": {
            "city": "Address City",
            "country": "Address Country",
            "id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
            "line_1": "123 Address Line 1",
            "line_2": "Address Line 2 ",
            "region": "Address Region",
            "zip": "00000"
          },
          "external_id": null,
          "id": "77fc9165-7eb4-4ded-9480-437864dcba64",
          "name": "Example Co."
        },
        "chain_id": "aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa",
        "closed_at": "2022-12-28T02:48:21.879153Z",
        "created_at": "2022-12-28T02:43:21.879153Z",
        "current_order_skus": [
          {
            "quantity": 1,
            "sku": {
              "code": "OrderBrickCode",
              "id": "ffffffff-ffff-ffff-ffff-ffffffffffff",
              "name": "OrderBrick"
            }
          }
        ],
        "ends_at": "2023-12-28T23:59:59.999+00:00",
        "grand_total": 100,
        "id": "39e4611c-481e-4cb8-bc2d-a33b14208dab",
        "metadata": {},
        "order_type": "standard",
        "primary_user": {
          "company": {
            "address": {
              "city": "Address City",
              "country": "Address Country",
              "id": "cccccccc-cccc-cccc-cccc-cccccccccccc",
              "line_1": "123 Address Line 1",
              "line_2": "Address Line 2 ",
              "region": "Address Region",
              "zip": "00000"
            },
            "external_id": null,
            "id": "77fc9165-7eb4-4ded-9480-437864dcba64",
            "name": "Example Co."
          },
          "email": "[e-mail]",
          "first_name": "BuyerFirstName",
          "last_name": "BuyerLastName"
        },
        "stage": "closed",
        "starts_at": "2022-12-29T00:00:00.000+00:00",
        "updated_at": "2023-12-28T02:43:20.879444Z"
      },
      "paid_amount": 0,
      "paid_at": null,
      "remaining_amount": 8.333333333333334,
      "starts_at": "2022-12-29T00:00:00Z",
      "status": "OUTSTANDING"
    },
    "paid_amount": 8,
    "paid_at": null,
    "payment_method": "CREDIT_CARD",
    "status": "FAILED"
  }
}