Sign in

v1

latestOpenAPI 3.0.02026-07-243678114.1 KB
Payments

Get Payment by ID

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.

get/v1/payments/{paymentId}

Path parameters

paymentIdstring required

Unique identifier of a payment in the system.

Response

OK

errorboolean

Example response

{
  "data": {
    "amount": "100.00",
    "created_at": "2023-01-01T12:00:00Z",
    "crypto_transaction": {
      "chain_id": 1,
      "created_at": "2023-01-01T12:00:00Z",
      "sequence": "123456789",
      "transaction_hash": "0x0123456789abcdef0123456789abcdef0123456789abcdef0123456789abcdef",
      "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",
      "name": "John Doe",
      "org_id": "org123",
      "reference": "REF-123456",
      "updated_at": "2023-01-02T09:00:00Z"
    },
    "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",
      "source": "BoomFi",
      "enabled": true,
      "deleted_at": "2023-12-04T13:25:48.499Z",
      "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
      "created_at": "2023-12-04T13:25:48.496Z",
      "updated_at": "2023-12-04T13:25:48.499Z",
      "expires_at": "2026-12-31T23:59:59Z",
      "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",
        "recurring_interval": "Unknown",
        "recurring_interval_count": 1,
        "recurring_usage_type": "Unknown",
        "enabled": true,
        "v1": "eyJwbGFucyI6IHsiaWQiOiAiYWE1ZmI5MjQtMmMzZi00NzcwLTkyZDEtMjFjYmY3ODc3ODc2IiwgIm5hbWUiOiAidGVzdCBwYXlsaW5rIDEyIDA0IiwgInN0YXR1cyI6ICJhY3RpdmUiLCAiaW50ZXJ2YWwiOiBudWxsLCAicmVmZXJlbmNlIjogIiIsICJhbW91bnRfd2VpIjogIjEwMCIsICJjcmVhdGVkX2F0IjogIjIwMjMtMTI...",
        "created_by": "2TzGhPCAfFWLPBjtc6h52Aao2S6",
        "created_at": "2023-12-04T13:25:47.656Z",
        "updated_at": "2023-12-04T13:25:48.491Z",
        "metadata": {}
      }
    },
    "scheduled_time": 1643712000
  }
}