بدء عملية نقل الأموال بين الجهة المسؤولة عن معالجة المعاملات وحساب العميل. إنّ الجمع بين 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 |
اختياري: النتيجة الأولية لهذه الدفعة يُستخدم للمساعدة في إبلاغ محرك المخاطر في 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 |
اختياري: يمكن أن يكون نطاق الرمز RawCode فارغًا. |
rawCode |
مطلوب: يشير إلى الرمز الأولي من شركة الدمج أو الأنظمة الفرعية داخلها. |