وظائف واجهة برمجة تطبيقات الرصيد

الحصول على الرصيد

الحصول على رصيد حساب Stripe.

نقطة النهاية: https://api.stripe.com/v1/balance

العملية: GET

أمثلة

cURL Example:

curl -X GET `https://api.stripe.com/v1/balance` \
  -u <YOUR_SECRET_KEY>:

الردود

ستعيد الردود الرموز القياسية.

200: موافق

{
  "object": "balance",
  "available": [
    {
      "amount": 0,
      "currency": "usd",
      "source_types": {
        "card": 0
      }
    }
  ],
  "livemode": false,
  "pending": [
    {
      "amount": 0,
      "currency": "usd",
      "source_types": {
        "card": 0
      }
    }
  ],
  "refund_and_dispute_prefunding": {
    "available": [
      {
        "amount": 0,
        "currency": "usd"
      }
    ],
    "pending": [
      {
        "amount": 0,
        "currency": "usd"
      }
    ]
  }
}

استجابات الأخطاء

400: طلب سيء

{
  "error": {
    "message": "إذا قمت بتمرير مصفوفة بمفاتيح صريحة (مثل foo[0]=a&foo[1]=b) بدلاً من مصفوفة (مثل foo[]=a&foo[]=b)، يجب أن تكون المفاتيح رقمية ومتسلسلة بدءًا من 0. لقد مررت المفاتيح `1`، توقعنا أن يكون المفتاح بالقيمة `0`.",
    "param": "expand",
    "request_log_url": "https://dashboard.stripe.com/test/logs/req_kCeAL5FAly5bkh?t=1734734555",
    "type": "invalid_request_error"
  }
}

401: غير مصرح به

{
  "error": {
    "type": "invalid_request_error",
    "message": "مفتاح API غير صالح المقدم: sk_test_********************1234"
  }
}

المعلمات

معلمات الاستعلام

المعلمة	النوع	الوصف
expand[]	مصفوفة من السلاسل	يحدد الحقول التي يجب توسيعها في الاستجابة.

استرداد معاملة رصيد

إرجاع المعاملات التي تكوّن رصيد حساب Stripe (على سبيل المثال، الرسوم والتحويلات والمدفوعات والمبالغ المستردة، وما إلى ذلك). يتم إرجاع المعاملات بترتيب مرتب، مع ظهور أحدث المعاملات أولاً.

نقطة النهاية: https://api.stripe.com/v1/balance_transactions/{id}

العملية: GET

أمثلة

cURL Example:

curl -X GET https://api.stripe.com/v1/balance_transactions/tr_1234567890 \
  -u <YOUR_SECRET_KEY>:

الردود

ستعيد الردود رموزًا قياسية.

200: موافق

{
  "object": "balance_transaction",
  "id": "tr_1234567890",
  "amount": 1000,
  "currency": "usd",
  "description": "Payment for invoice",
  "fee": 59,
  "fee_details": [
    {
      "amount": 59,
      "currency": "usd",
      "description": "Stripe processing fees",
      "type": "stripe_fee"
    }
  ],
  "net": 941,
  "status": "available",
  "type": "charge"
}

400: طلب سيء

{
  "error": {
    "message": "إذا قمت بتمرير مصفوفة بمفاتيح صريحة (مثل foo[0]=a&foo[1]=b) بدلاً من مصفوفة (مثل foo[]=a&foo[]=b)، يجب أن تكون المفاتيح رقمية ومتسلسلة بدءًا من 0. لقد مررت المفاتيح `1`، توقعنا أن يكون المفتاح بالقيمة `0`.",
    "param": "expand",
    "request_log_url": "https://dashboard.stripe.com/test/logs/req_kCeAL5FAly5bkh?t=1734734555",
    "type": "invalid_request_error"
  }
}

401: غير مصرح به

{
  "error": {
    "type": "invalid_request_error",
    "message": "مفتاح API غير صالح المقدم: sk_test_********************1234"
  }
}

المعلمات

معلمات الاستعلام

المعلمة	النوع	الوصف
expand[]	مصفوفة من السلاسل	يحدد الحقول التي يجب توسيعها في الاستجابة.

متغيرات المسار

الاسم	النوع	مطلوب	الوصف
id	سلسلة	مطلوب	معرف متغير المسار