Skip to main content

Get Payment by ID

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

The Get Payment by ID endpoint allows you to retrieve information about a specific payment transaction using its unique identifier. This endpoint provides comprehensive data on the payment, including its status, method, amount, and currency.

Query Parameters​

ParameterTypeDescriptionRequired
paymentIdstringUnique identifier of a payment in the system.Yes

Example Request​

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

Responses​

FieldTypeDescriptionExample
dataobjectThe data object containing the payment details.
data.amountstringThe amount associated with the payment.
data.created_atstringThe timestamp indicating when the payment was created.
data.crypto_transactionobjectThe crypto transaction details.
data.crypto_transaction.currencystringThe currency of the payment.
data.customerobjectThe customer details.
data.customer.customer_idstringThe ID of the customer associated with the payment.
data.idstringThe unique identifier of the payment.
data.invoice_idstringThe ID of the invoice associated with the payment.
data.next_actionstringThe next action related to the payment.
data.org_idstringThe ID of the organization associated with the payment.
data.parent_idstringThe ID of the parent payment if this payment is part of a larger transaction.
data.payment_linkobjectThe payment link details.
data.payment_link.payment_methodintegerThe 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.propertiesobjectAdditional properties associated with the payment.
data.scheduled_timeintegerThe scheduled time for the payment.
data.sourceintegerThe source of this billing information: 1 = Lago, 2 = Uqualify, 3 = Stripe, 4 = Chargebee
data.statusintegerThe current status of the payment: 1 = Unknown, 2 = Requirespaymentmethod, 3 = Requiresconfirmation, 4 = Requiresaction, 5 = Processing, 6 = Succeeded, 7 = Canceled, 8 = Failed
data.updated_atstringThe timestamp indicating when the payment was last updated.
data.v1array of integersAn array of version integers.
errorbooleanIndicates if there was an error.
{
  "data": {
    "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
    ]
  },
  "error": true
}