Skip to content

💳 Payments

Handle incoming and outgoing payments.

Operations

List payments

Request

Retrieve payment records with transaction details and security compliance

This endpoint provides secure payment data access with:

  • PCI-compliant payment information (masked card data)
  • Payment method categorization and tracking
  • Integration with AR transactions for complete context
  • Payment processor integration (PayPal, Stripe, etc.)
  • Date-based filtering for reconciliation periods
  • Client relationship data for payment attribution

Security & Compliance:

  • PCI DSS compliant data handling (last 4 digits only)
  • Secure payment processor ID tracking
  • Payment confirmation date logging
  • Audit trail for payment processing

Payment Method Support:

  • Credit/debit card payments with masked PAN
  • ACH/bank transfer processing
  • Check and wire transfer tracking
  • Digital wallet integration (PayPal, Apple Pay, etc.)

Reconciliation Features:

  • Payment-to-invoice matching via AR transactions
  • Payment confirmation status tracking
  • Processor reference ID management
  • Multi-currency payment support

Business Applications:

  • Payment reconciliation and matching
  • Revenue recognition and cash flow analysis
  • Client payment history and patterns
  • Payment method performance analysis
  • Compliance reporting and audit trails

Real Example:

curl --location 'https://{{host}}/v1/payments' \
--header 'Authorization: bearer {{token}} \
--header 'Content-Type: application/json' \
--data '{
  "pageSize": 25,
  "page": 0
}'
Security
BearerAuth
Bodyapplication/json
pageSizeinteger, [ 1 .. 1000 ]

Maximum number of payment records to return

Default:25
Example:25
pageinteger, >= 0

Page number for pagination (0-based)

Default:0
Example:0
clientIdinteger

Filter payments by specific client ID

Example:789
paymentMethodstring

Filter by payment method type

Enum:"CREDIT_CARD""DEBIT_CARD""ACH""BANK_TRANSFER""CHECK""WIRE""PAYPAL""APPLE_PAY""GOOGLE_PAY"
Example:"CREDIT_CARD"
startDatestring, (date-time)

Start date for payment date range filter

Example:"2024-01-01T00:00:00"
endDatestring, (date-time)

End date for payment date range filter

Example:"2024-12-31T23:59:59"
statusstring

Filter by payment status

Enum:"PENDING""CONFIRMED""FAILED""CANCELLED""REFUNDED"
Example:"CONFIRMED"
sortOrderstring

Sort order for payment date

Default:"desc"
Enum:"asc""desc"
Example:"desc"
curl -i -X POST \
  https://api.doc.aiwyn.ai/_mock/bundle/gql/v1/payments \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "pageSize": 25,
    "page": 0
  }'

Responses

Successfully retrieved payment records

Bodyapplication/json
deid_paymentArray of objects
deid_payment_aggregateobject
Response
{
  "deid_payment": [
    { … },
    { … },
    { … }
  ],
  "deid_payment_aggregate": {
    "aggregate": { … }
  }
}