Payments Endpoints

This document covers the payments endpoints: reading the charges for your orders, reading payouts and payout detail, and reading the statements that summarize a payout period. The API is read-only for money movement: buyers pay at checkout, refunds are issued through the returns flow, and payouts are made by the Company on schedule. These endpoints let your accounting systems reconcile every amount.

The Company collects payment for a seller's sale as the seller's limited agent for collection only, as stated in the Selling Terms of Service. The full description of the payment flow is in Payments.

Access through the developer API is issued by the Company and is limited by seller type: manufacturer and supplier accounts receive API access for importing data, under the Developer Agreement and the API Access Tiers. Nothing in this document grants broader access.

Endpoints

Method	Path	Purpose
GET	`/payments`	List charges and refunds for your orders, newest first, paginated
GET	`/payments/{id}`	Read one payment in full
GET	`/payouts`	List payouts made to your account, newest first, paginated
GET	`/payouts/{id}`	Read one payout, with the charges and adjustments it contains
GET	`/statements`	List payout-period statements for your account
GET	`/statements/{id}`	Read one statement: sales, fees, refunds, and net for the period

All paths are relative to the base URL https://www.aapawz.com/api. Collections paginate and filter as specified in Pagination and Filtering (Pagination & Filtering); filter payments by order_id, status, and date range.

The payment object

{
  "id": "pay_55qw19",
  "order_id": "ord_64kx20",
  "order_number": "AAP-2026-104821",
  "type": "charge",
  "status": "succeeded",
  "amount": "60.04",
  "currency": "USD",
  "method": "card",
  "reference": "ch_9f27kd41",
  "created_at": "2026-10-13T19:22:31Z"
}

type is charge or refund. A refund payment carries refund_of naming the charge it reverses, and its amount is stated as a positive value with type refund.
status is pending, succeeded, failed, or refunded for charges, and pending, completed, or failed for refunds. Definitions are in Data Types and Enums.
reference is the payment reference shown in the Seller Center and on statements. Quote it in every payment inquiry to support@aapawz.com; it is the key the Company reconciles by.
Amounts are decimal strings with a currency field (Overview). Never convert amounts through floating-point arithmetic in your own records.

Payouts

A payout is the net amount sent to your account's bank for a payout period: charges that cleared in the period, minus refunds, chargebacks, and the fees stated in your seller agreement.

{
  "id": "po_31zt66",
  "status": "paid",
  "period_start": "2026-10-05",
  "period_end": "2026-10-11",
  "gross": "1842.55",
  "refunds": "49.98",
  "fees": "276.38",
  "adjustments": "0.00",
  "net": "1516.19",
  "currency": "USD",
  "paid_at": "2026-10-14T09:00:00Z",
  "arrival_expected": "2026-10-16"
}

Payout status is scheduled, in_transit, paid, or failed. A failed payout: for example, closed bank details: is retried after you correct your payout details in the Seller Center; contact support@aapawz.com if a payout stays failed. GET /payouts/{id} returns the payout with a lines array: one entry per charge, refund, or adjustment included, each carrying the payment_id or return reference it came from, so your ledger can tie out line by line.

Statements

A statement summarizes one payout period in the form your agreement specifies: gross sales, refunds, fees, adjustments, and net. Statements are final once issued; a correction appears as an adjustment in the next period's statement, never as an edit to an issued statement. Keep statements for your tax records.

How money moves, in order

The buyer pays at checkout, at the prices set under Pricing Endpoints. The order (Orders Endpoints) moves from pending_payment to confirmed when the charge succeeds.
Fulfillment and delivery proceed independently (Fulfillment Endpoints); a delivered order is not a condition of the charge.
A refund issued under Returns Endpoints appears as a refund payment and reduces the payout for the period in which it is issued: which may be a later period than the charge. If refunds exceed the period's charges, the balance carries forward as a negative adjustment.
The payout is made on the schedule in your seller agreement, and the statement closes the period.

Payment state changes also arrive as events: payment.succeeded, payment.failed, payment.refunded, payout.paid (Webhook Event Schemas). Use events to update your systems promptly and the list endpoints to reconcile; if your totals and the statement disagree, the statement governs and support@aapawz.com is the contact.

Rules and errors

The API never accepts card details and never initiates a charge: any request body carrying card numbers is rejected and shall not be sent.
Refunds are issued only through Returns Endpoints, never by editing a payment. A payment record, once written, is not changed in place; corrections are new records.
Writes elsewhere in the API that move money-adjacent state accept an Idempotency-Key header (Idempotency Keys); the payment endpoints themselves are reads.

Status	Code	Cause
404	`not_found`	No payment, payout, or statement with that identifier exists in your account
422	`invalid_filter`	A filter value is malformed, for example a reversed date range

Error bodies follow Error Codes.

Returns Endpoints

Pricing Endpoints