بدء حركة الأموال بين الجهة المسؤولة عن معالجة المعاملات وحساب العميل إنّ إضافة requestId في العنوان وpaymentIntegratorAccountId هي مفتاح تحديد الهوية وتحدّد هذه المعاملة بشكل فريد. تعمل جميع التغييرات في هذه المعاملة على تعبئة قيمة requestId في الحقل disburseFundsRequestId.
إذا واجهت نقطة النهاية خطأً أثناء معالجة الطلب، يجب أن يكون نص الاستجابة من نقطة النهاية هذه من النوع .ErrorResponse
إليك مثال على الطلب:
{
"requestHeader": {
"protocolVersion": {
"major": 1,
"minor": 0,
"revision": 0
},
"requestId": "liUrreQY233839dfFFb24gaQM",
"requestTimestamp": "1502220434778"
},
"paymentIntegratorAccountId": "InvisiCashUSA_USD",
"upiDetails": {
"vpa": "foo@icici"
},
"transactionDescription": "Google - Music",
"currencyCode": "INR",
"amount": "208000000"
}
يبدو الرد كمثال:
{
"responseHeader": {
"responseTimestamp": "1481900013178"
},
"paymentIntegratorTransactionId": "aW50ZWdyYXRvciB0cmFuc2FjdGlvbiBpZA",
"disburseFundsResult": {
"disburseFundsResultCode": "SUCCESS"
}
}
طلب HTTP
POST https://www.integratorhost.example.com/v1/disburseFunds
نص الطلب
يحتوي نص الطلب على بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{ "requestHeader": { object ( |
| الحقول | |
|---|---|
requestHeader |
مطلوب: عنوان مشترك لجميع الطلبات. |
paymentIntegratorAccountId |
مطلوبة: تشير إلى معرّف حساب شركة تكامل الدفعات الذي يحدّد القيود التعاقدية المتعلّقة بهذه المعاملة. |
transactionDescription |
مطلوب: هذا هو وصف المعاملة التي يمكن إدراجها في كشف العميل. مترجَمة إلى لغة userLocale المتوفّرة في |
currencyCode |
مطلوب: رمز العملة المكوَّن من 3 أحرف وفقًا لمعيار ISO 4217 |
amount |
مطلوب: مبلغ الشراء، بالدولار المصغر لوحدة العملة. |
حقل الاتحاد يمكن أن يكون |
|
upiDetails |
اختياري: تفاصيل الدفع الخاصة بأدوات UPI. |
نص الاستجابة
عنصر الاستجابة لطريقة توزيع الأموال.
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
| تمثيل JSON |
|---|
{ "responseHeader": { object ( |
| الحقول | |
|---|---|
responseHeader |
مطلوب: عنوان مشترك لجميع الردود. |
paymentIntegratorTransactionId |
مطلوب: هذا المعرّف خاص بالشركة المدمَجة ويتمّ إنشاؤه بواسطة الشركة المدمَجة. هو المعرّف الذي تعرف شركة الدمج هذه المعاملة من خلاله. ولتسهيل الأمر، يتم تضمين هذا المعرّف في تفاصيل الحوالة المالية. |
disburseFundsResult |
مطلوب: نتيجة المكالمة المتعلقة بتوزيع الدفعات. |
UpiDetails
تفاصيل حول حساب UPI الذي سيتم تسديد الدفعات إليه
| تمثيل JSON |
|---|
{ "vpa": string } |
| الحقول | |
|---|---|
vpa |
مطلوب: عنوان الدفع الافتراضي (VPA) للمستخدم المستخدَم لنقل الأموال باستخدام بروتوكول UPI. على سبيل المثال foo@icici. |
DisburseFundsResult
معلومات حول النتيجة النهائية للمدفوعات
| تمثيل JSON |
|---|
{ "disburseFundsResultCode": enum ( |
| الحقول | |
|---|---|
disburseFundsResultCode |
مطلوبة: رمز نتيجة هذه الدفعة |
rawResult |
OPTIONAL: النتيجة الأولية لهذه الدفعة. تُستخدَم هذه السمة للمساعدة في إعلام محرّك بحث Google بشأن المخاطر والتحليلات. في حالات ربط الرموز البرمجية والرفض، يتم فقدان البيانات أحيانًا. يمكن أن تختار شركة الدمج منح Google رمزًا أوليًا. على سبيل المثال، يمكن لبوابة بطاقة الائتمان (شركة الدمج) استخدام هذا الحقل لإبلاغ Google برمز الرفض الذي تم استلامه من شبكة VISA. في هذه الحالة، ستكون القيمة هذه القيمة مطلوبة إذا لم تكن قيمة السمة |
حقل الاتحاد يمكن أن يكون |
|
transactionMaxLimit |
اختياري: إذا كانت قيمة هذا المقدار هو ميكرو من نفس |
transactionMinLimit |
اختياري: إذا كانت قيمة هذا المقدار هو ميكرو من نفس |
DisburseFundsResultCode
رموز النتائج الخاصة بمكالمة لتسديد الدفعات
| عمليات التعداد | |
|---|---|
UNKNOWN_RESULT |
لا تضبط هذه القيمة التلقائية على الإطلاق. |
SUCCESS |
تم تسديد الدفعة بنجاح. |
DISBURSEMENT_UNDER_TRANSACTION_LIMIT |
لا يستوفي مبلغ الإنفاق المطلوب الحد الأدنى لمبلغ كل معاملة الذي تحدّده شركة الدمج. في حال استخدام هذا الرمز، يُرجى ملء الحقل transactionMinLimit بالحدّ الأدنى لمبلغ المعاملة لأغراض مراسلة المستخدمين. |
DISBURSEMENT_EXCEEDS_TRANSACTION_LIMIT |
يتجاوز مبلغ الإنفاق المطلوب الحدّ الأقصى المسموح به لكل معاملة والذي حدّدته جهة الدمج. في حال استخدام هذا الرمز، عليك ملء الحقل transactionMaxLimit بحدّ المعاملات لأغراض مراسلة المستخدمين. |
ACCOUNT_CLOSED |
تم إغلاق حساب المستخدم لدى شركة الدمج. ستؤدي هذه القيمة المعروضة إلى إغلاق وسيلة المستخدم مع Google. سيضطر المستخدم إلى إضافة أداة جديدة. |
ACCOUNT_CLOSED_ACCOUNT_TAKEN_OVER |
تم إغلاق حساب المستخدم لدى جهة الدمج، ويُشتبه في الاستيلاء على الحساب. ستؤدي هذه القيمة المعروضة إلى إغلاق وسيلة المستخدم مع Google. سيضطر المستخدم إلى إضافة أداة جديدة. |
ACCOUNT_CLOSED_FRAUD |
تم إغلاق حساب المستخدم التابع لجهة الدمج بسبب عملية احتيال. ستؤدي هذه القيمة المعروضة إلى إغلاق وسيلة المستخدم مع Google. سيضطر المستخدم إلى إضافة أداة جديدة. |
ACCOUNT_ON_HOLD |
حساب المستخدم معلق. |
RawResult
كائن النتيجة الأولي.
| تمثيل JSON |
|---|
{ "scope": string, "rawCode": string } |
| الحقول | |
|---|---|
scope |
OPTIONAL: يمكن أن يكون نطاق RAWCode فارغًا. |
rawCode |
مطلوب: الرمز الأولي من شركة الدمج أو الأنظمة الفرعية المضمّنة فيه. |