List Payments

GET https://paylinks.uqualify.co.uk/api/v1/payments

The List Payments endpoint allows you to retrieve a list of all payment transactions associated with your organization. It is a valuable tool for tracking and reviewing your organization’s payment history, ensuring that you have an overview of all financial activities within the Uqualify platform.

info

Use pagination parameters to efficiently navigate through a large volume of payments.

Query Parameters

Parameter	Type	Description
after	string	Retrieve payments after this timestamp.
before	string	Retrieve payments before this timestamp.
limit	integer	The maximum number of payments to retrieve (default=100, maximum=100).
page	integer	The page number of results to retrieve (≥ 1).
since	string	Retrieve payments since this timestamp.
sort	string	Sort order for payments (asc=ascending, desc=descending).
until	string	Retrieve payments until this timestamp.

Example Request

curl --request GET \
     --url https://paylinks.uqualify.co.uk/api/v1/payments \
     --header 'X-API-KEY: API-KEY' \
     --header 'accept: application/json'

Responses

Field	Type	Description
data	object	The data object containing the payments.
data.items	array of objects	A list of payment objects.
data.items.amount	string	The amount associated with the payment.
data.items.created_at	string	The timestamp indicating when the payment was created.
data.items.crypto_transaction	object	The crypto transaction details.
data.items.crypto_transaction.currency	string	The currency of the payment.
data.items.customer	object	The customer details.
data.items.customer.customer_id	string	The ID of the customer associated with the payment.
data.items.id	string	The unique identifier of the payment.
data.items.invoice_id	string	The ID of the invoice associated with the payment.
data.items.next_action	string	The next action related to the payment.
data.items.org_id	string	The ID of the organization associated with the payment.
data.items.parent_id	string	The ID of the parent payment if this payment is part of a larger transaction.
data.items.payment_link	object	The payment link details.
data.items.payment_link.payment_method	integer	The payment method: 1 = Unknown, 2 = Merchantcontract, 3 = Proxywallet, 4 = Unblock, 5 = Card, 6 = Googlepay, 7 = Applepay, 8 = Paypal, 9 = Directdebit, 10 = Ramp, 11 = Rampcryptosettlement
data.items.properties	object	Additional properties associated with the payment.
data.items.scheduled_time	integer	The scheduled time for the payment.
data.items.source	integer	The source of this billing information: 1 = Lago, 2 = Uqualify, 3 = Stripe, 4 = Chargebee
data.items.status	integer	The current status of the payment: 1 = Unknown, 2 = Requirespaymentmethod, 3 = Requiresconfirmation, 4 = Requiresaction, 5 = Processing, 6 = Succeeded, 7 = Canceled, 8 = Failed
data.items.updated_at	string	The timestamp indicating when the payment was last updated.
data.items.v1	array of integers	An array of version integers.
data.items.last_update	string	The timestamp indicating the last update time.
data.next	integer	The number of the next page of results.
data.total	integer	The total number of items in the response.
error	boolean	Indicates if there was an error.

{
  "data": {
    "items": [
      {
        "amount": "100.00",
        "created_at": "2023-01-01T12:00:00Z",
        "crypto_transaction": {
          "chain_id": 1,
          "created_at": "2023-01-01T12:00:00Z",
          "id": 0,
          "payment_id": {
            "string": "string",
            "valid": true
          },
          "raw": [
            0
          ],
          "sequence": "123456789",
          "source": 1,
          "status": 1,
          "transaction_hash": "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
          "type": 1,
          "updated_at": "2023-01-01T12:30:00Z"
        },
        "currency": "USD",
        "customer": {
          "created_at": "2023-01-01T12:00:00Z",
          "deleted_at": "2023-01-05T10:00:00Z",
          "email": "customer@example.com",
          "id": "customer123",
          "metadata": {},
          "name": "John Doe",
          "org_id": "org123",
          "phone": 1234567890,
          "properties": {},
          "reference": "REF-123456",
          "updated_at": "2023-01-02T09:00:00Z",
          "wallet_address": 4.059726770363619e+44
        },
        "customer_id": "customer123",
        "id": "payment123",
        "invoice_id": "invoice123",
        "next_action": "verify_payment",
        "org_id": "org123",
        "parent_id": "parent_payment123",
        "payment_link": {
          "id": "2Z4zsnmp37AF3WKM6N2j4wmeakr",
          "plan_id": "2Z4zspFMhs2pMYjcR3l6JpJaWdA",
          "invoice_id": "",
          "source": "BoomFi",
          "customer_ident_collection": false,
          "shipping_address_collection": false,
          "tax_ident_collection": false,
          "enabled": true,
          "deleted_at": "2023-12-04T13:25:48.499Z",
          "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
          "updated_by": "",
          "created_at": "2023-12-04T13:25:48.496Z",
          "updated_at": "2023-12-04T13:25:48.499Z",
          "metadata": {},
          "properties": {
            "short_code": "AANj9Dm7Zl"
          },
          "plan": {
            "id": "2Z4zspFMhs2pMYjcR3l6JpJaWdA",
            "org_id": "2Tpmnmh6GHJXumKN1oBy2u56Ima",
            "source": "Lago",
            "name": "test paylink 12 04",
            "type": "OneTime",
            "billing_scheme": "FlatFee",
            "price": "1",
            "currency": "USD",
            "available_quantity": 0,
            "trial_period": "",
            "recurring_interval": "Unknown",
            "recurring_interval_count": 1,
            "recurring_usage_type": "Unknown",
            "reference": "",
            "enabled": true,
            "v1": "eyJwbGFucyI6IHsiaWQiOiAiYWE1ZmI5MjQtMmMzZi00NzcwLTkyZDEtMjFjYmY3ODc3ODc2IiwgIm5hbWUiOiAidGVzdCBwYXlsaW5rIDEyIDA0IiwgInN0YXR1cyI6ICJhY3RpdmUiLCAiaW50ZXJ2YWwiOiBudWxsLCAicmVmZXJlbmNlIjogIiIsICJhbW91bnRfd2VpIjogIjEwMCIsICJjcmVhdGVkX2F0IjogIjIwMjMtMTI...",
            "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
            "created_at": "2023-12-04T13:25:47.656Z",
            "updated_at": "2023-12-04T13:25:48.491Z",
            "deleted_at": null,
            "metadata": {}
          }
        },
        "payment_method": 1,
        "properties": {},
        "scheduled_time": 1643712000,
        "source": 1,
        "status": 1,
        "updated_at": "string",
        "v1": [
          0
        ]
      }
    ],
    "last_update": "2021-01-01T00:00:00Z",
    "next": 10,
    "total": 10
  },
  "error": true
}

Field	Type	Description	Example
error	object	The error returned by the server.
error.code	integer	The error code returned by the server.	400
error.errors	array of objects	A list of detailed error objects.
error.errors.domain	string	The domain associated with the error.	orders
error.errors.reason	string	The reason for the error.	InsufficientQuantity
error.message	string	A descriptive message explaining the error.	Insufficient quantity

{
  "error": {
    "code": 400,
    "errors": [
      {
        "domain": "orders",
        "reason": "InsufficientQuantity"
      }
    ],
    "message": "Insufficient quantity"
  }
}

Field	Type	Description	Example
error	object	The error returned by the server.
error.code	integer	The error code returned by the server.	500
error.errors	array of objects	A list of detailed error objects.
error.errors.domain	string	The domain associated with the error.	orders
error.errors.reason	string	The reason for the error.	Internal
error.message	string	A descriptive message explaining the error.	Internal server error

{
  "error": {
    "code": 500,
    "errors": [
      {
        "domain": "orders",
        "reason": "Internal"
      }
    ],
    "message": "Internal server error"
  }
}

Query Parameters​

Example Request​

Responses​

Query Parameters

Example Request

Responses