Documentation Index Fetch the complete documentation index at: https://docs.fungies.io/llms.txt
Use this file to discover all available pages before exploring further.
A Payment object represents a single financial transaction - either a one-time purchase or a recurring subscription charge. Payments track the monetary flow, including the amount, fees, tax, and processing status.
Each payment is associated with an Order and optionally with a User and Subscription . Payments contain detailed information about charges, including payment method details and invoice data when applicable.
Endpoints Method Endpoint Description GET/v0/payments/listList and filter payments GET/v0/payments/{paymentId}Retrieve a payment by ID
The Payment object Object type identifier. Always "payment" for Payment objects.
Unique identifier (UUID) for this payment.
Human-readable payment number (e.g., #ABC123DEF456). Used for reference in invoices and support.
Type of payment. Possible values: one_time, subscription_initial, subscription_update, subscription_interval, subscription_extra, claim_free
Current payment status. Possible values: PENDING, PAID, FAILED, UNPAID, CANCELLED, REFUNDED, PARTIALLY_REFUNDED, EXPIRED
Payment amount in the smallest currency unit (e.g., cents for USD). Includes tax but excludes fees. Defaults to 0.
Tax amount in the smallest currency unit. Included in the total value. Defaults to 0.
Processing fee in the smallest currency unit. This is deducted from your payout. Defaults to 0.
Three-letter ISO 4217 currency code (e.g., "USD", "EUR", "GBP").
Number of decimal places for this currency (e.g., 2 for USD, 0 for JPY).
Unix timestamp (milliseconds) when the payment was created.
UUID of the User who made this payment. Expanded User object with basic information about the payer. Unique identifier (UUID) for this user.
UUID of the associated Order . For subscription payments, this links to the initial order. Human-readable order number of the associated order.
Expanded Order object with basic information. Unique identifier (UUID) for this order.
Human-readable order number.
Subscription identifier if this is a subscription-related payment.Expanded Subscription object with status and ID. Show subscription properties
Subscription status: active, past_due, canceled, unpaid, incomplete, incomplete_expired, trialing, paused
Applied Discount object if a discount code or sale was used. Unique identifier (UUID) for this discount.
Discount type: code or sale.
Display name of the discount.
Discount amount (fixed value or percentage).
Whether amount is fixed or percentage.
The coupon code if this is a code-type discount.
Invoice number for completed payments. Only available for PAID, REFUNDED, or PARTIALLY_REFUNDED statuses.
URL to download the invoice PDF. Only available for completed payments with generated invoices.
Array of charge attempts for this payment. Unique identifier (UUID) for this charge.
Charge status: succeeded, pending, failed
Unix timestamp (milliseconds) when the charge was created.
IP address of the customer at time of charge.
Payment method details including type, brand, last4, and card. Payment method type (e.g., card, paypal, bank_transfer, klarna, affirm).
Card brand if payment method is a card (visa, mastercard, amex, discover, diners, jcb, unionpay).
Last 4 digits of the card or account number.
Card-specific payment details. Present when the payment method type is card. Card brand (visa, mastercard, amex, discover, diners, jcb, unionpay).
Last 4 digits of the card number.
Two-letter ISO country code of the card issuer.
Card network (e.g., visa, mastercard).
Digital wallet details, if the card payment was made via a wallet (e.g., Apple Pay, Google Pay). Null when no wallet was used. The type of digital wallet: amex_express_checkout, apple_pay, google_pay, link, masterpass, samsung_pay, or visa_checkout.
The last four digits of the device account number. May differ from the physical card’s last4.
Example response { "status" : "success" , "data" : { "payment" : { "object" : "payment" , "id" : "660e8400-e29b-41d4-a716-446655440001" , "number" : "#PAY123DEF456" , "type" : "one_time" , "status" : "PAID" , "value" : 2999 , "tax" : 500 , "fee" : 87 , "currency" : "USD" , "currencyDecimals" : 2 , "createdAt" : 1705590000000 , "userId" : "123e4567-e89b-12d3-a456-426614174000" , "user" : { "object" : "user" , "id" : "123e4567-e89b-12d3-a456-426614174000" , "username" : "johndoe" }, "orderId" : "550e8400-e29b-41d4-a716-446655440000" , "orderNumber" : "#ABC123DEF456" , "order" : { "object" : "order" , "id" : "550e8400-e29b-41d4-a716-446655440000" , "number" : "#ABC123DEF456" , "status" : "PAID" }, "subscriptionId" : null , "subscription" : null , "discount" : null , "invoiceNumber" : "INV-2024-001234" , "invoiceUrl" : "https://api.fungies.io/invoice/INV-2024-001234" , "charges" : [ { "object" : "charge" , "id" : "770e8400-e29b-41d4-a716-446655440002" , "status" : "succeeded" , "createdAt" : 1705590000000 , "ipAddress" : "192.168.1.100" , "paymentMethod" : { "type" : "card" , "brand" : "visa" , "last4" : "4242" , "card" : { "brand" : "visa" , "last4" : "4242" , "country" : "US" , "network" : "visa" , "wallet" : { "type" : "apple_pay" , "dynamicLast4" : "7279" } } } } ] } } }
Orders Orders associated with payments
Users Customers who made payments
Subscriptions Recurring subscription payments
Discounts Discounts applied to payments
