payments.v1

A payment transaction for an order or invoice.

attributes
Type: object
- activity
  Type: object
  
  Payment activity log
- amount
  Type: number
  
  Payment amount
- cancel_url
  Type: string | null
  
  Redirect URL on cancellation
- charge_type
  Type: string
  
  Type of charge
- country_code
  Type: string | null
  
  Country code
- created_at
  Type: string
  
  Creation timestamp
- currency
  Type: string
  
  ISO 4217 currency code
- is_partial_payment
  Type: boolean
  
  Whether this is a partial payment
- is_terminal_payment
  Type: boolean
  
  Whether paid via terminal
- last_error
  Type: string | null
  
  Last error message
- provider_data
  Type: object
  
  Provider-specific data
- refundable_amount
  Type: number
  
  Amount that can be refunded
- secret
  Type: string
  
  Client secret for frontend confirmation
- settled_at
  Type: string | null
  
  Settlement timestamp
- status
  Type: stringenum
  
  Payment status
  
  values
  pending
  processing
  succeeded
  failed
  canceled
- succeeded_at
  Type: string | null
  
  Success timestamp
- success_url
  Type: string | null
  
  Redirect URL on success
id
Type: string
links
Type: object · ResourceLinks

JSON:API self-link object
- self
  Type: stringFormat: uri
meta
Type: object
- next_action
  Type: object
  
  Next action required (e.g., 3D Secure redirect)
- return_url
  Type: string
  
  Return URL after action
relationships
Type: object
- disputes
  Type: object
  
  Payment disputes
- method
  Type: object
  
  Payment method used
- payout
  Type: object
  
  Associated payout
- refunds
  Type: object
  
  Payment refunds
- terminal_reader
  Type: object
  
  Terminal reader used
type
Type: string