GET
/
api
/
v1
/
payments
List Payments
curl --request GET \
  --url https://app.flowglad.com/api/v1/payments \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "id": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "createdByCommit": "<string>",
      "updatedByCommit": "<string>",
      "invoiceId": "<string>",
      "amount": "<any>",
      "paymentMethod": "card",
      "currency": "USD",
      "status": "canceled",
      "chargeDate": "<string>",
      "settlementDate": "<string>",
      "description": "<string>",
      "receiptNumber": "<string>",
      "receiptURL": "<string>",
      "customerId": "<string>",
      "purchaseId": "<string>",
      "subscriptionId": "<string>",
      "paymentMethodId": "<string>",
      "billingPeriodId": "<string>",
      "taxAmount": -1,
      "subtotal": -1,
      "taxType": "amusement_tax",
      "taxCountry": "AF",
      "taxState": "<string>",
      "taxRatePercentage": "<string>",
      "applicationFee": -1,
      "refunded": true,
      "refundedAmount": -1,
      "refundedAt": "<string>",
      "failureMessage": "<string>",
      "failureCode": "<string>"
    }
  ],
  "currentCursor": "<string>",
  "nextCursor": "<string>",
  "hasMore": true,
  "total": 123
}

Authorizations

Authorization
string
header
required

Query Parameters

cursor
string
limit
string

Response

Successful response

data
object[]
required
hasMore
boolean
required
total
number
required
currentCursor
string
nextCursor
string