این مرجع، گزینههای شیء پاسخ API گوگل پی را برای استفاده در برنامه شما شرح میدهد. اشیاء پاسخ، اشیایی هستند که توسط متدهای کلاینت API گوگل پی بازگردانده میشوند.
دادههای پرداخت
این یک شیء پاسخ است که پس از تأیید پرداخت توسط پرداختکننده، توسط گوگل بازگردانده میشود.
| ملک | نوع | همیشه وجود دارد | توضیحات |
|---|---|---|---|
apiVersion | شماره | بله | نسخه اصلی API. مقدار موجود در پاسخ با مقدار ارائه شده در مطابقت دارد PaymentDataRequest . |
apiVersionMinor | شماره | بله | نسخه فرعی API. مقدار موجود در پاسخ با مقدار ارائه شده در مطابقت دارد PaymentDataRequest . |
paymentMethodData | دادههای روش پرداخت | بله | اطلاعات مربوط به روش پرداخت انتخاب شده. |
email | رشته | خیر | آدرس ایمیل، اگر emailRequired در قسمت مربوطه روی true تنظیم شده باشد درخواست دادههای پرداخت .اگر درخواست دیگری این ویژگی را روی true تنظیم کرده باشد، هیچ تاثیری نخواهد داشت. |
shippingAddress | آدرس | خیر | آدرس ارسال، اگر shippingAddressRequired در آن روی true تنظیم شده باشد درخواست دادههای پرداخت . |
مثال
این پاسخ نمونه برای API گوگل پی نسخه ۲.۰، یک روش پرداخت CARD انتخاب شده در برگه پرداخت گوگل پی را نشان میدهد. یک توکن روش پرداخت برای درگاه example ایجاد شده است.
{ "apiVersion": 2, "apiVersionMinor": 0, "paymentMethodData": { "type": "CARD", "description": "Visa •••• 1234", "info": { "cardNetwork": "VISA", "cardDetails": "1234", "cardFundingSource": "CREDIT" }, "tokenizationData": { "type": "PAYMENT_GATEWAY", "token": "examplePaymentMethodToken" } } }
دادههای روش پرداخت
این شیء دادههایی را برای روش پرداخت انتخاب شده ارائه میدهد.
| ملک | نوع | همیشه وجود دارد | توضیحات |
|---|---|---|---|
type | رشته | بله | PaymentMethod type انتخاب شده در برگه پرداخت Google Pay. |
description | رشته | بله | پیام رو به کاربر برای توصیف روش پرداختی که این تراکنش را تأمین مالی میکند. |
info | شیء | بله | مقدار این ویژگی به type روش پرداخت برگردانده شده بستگی دارد. برای CARD ، به CardInfo مراجعه کنید. |
tokenizationData | روش پرداختتوکنسازیدادهها | خیر | دادههای توکنسازی پرداخت برای روش پرداخت انتخابشده. |
مثال
این پاسخ نمونه نشان میدهد که چگونه یک روش پرداخت CARD که در برگه پرداخت Google Pay انتخاب شده است، یک توکن روش پرداخت برای درگاه example تولید میکند.
{ "type": "CARD", "description": "Visa •••• 1234", "info": { "cardNetwork": "VISA", "cardDetails": "1234" }, "tokenizationData": { "type": "PAYMENT_GATEWAY", "token": "examplePaymentMethodToken" } }
کارت اینفو
این شیء اطلاعاتی در مورد کارت پرداخت انتخاب شده ارائه میدهد.
| ملک | نوع | همیشه وجود دارد | توضیحات |
|---|---|---|---|
cardDetails | رشته | بله | جزئیات مربوط به کارت. این مقدار معمولاً چهار رقم آخر شماره حساب پرداخت انتخاب شده است. |
assuranceDetails | جزئیات تضمینمشخصات | بله | این شیء اطلاعاتی در مورد اعتبارسنجی انجام شده روی دادههای پرداخت برگشتی ارائه میدهد، در صورتی که assuranceDetailsRequired در ... روی true تنظیم شده باشد. پارامترهای کارت . |
cardNetwork | رشته | بله | شبکه کارت پرداخت مربوط به پرداخت انتخاب شده. مقادیر برگشتی با فرمت این مقدار شبکه کارت نباید به خریدار نمایش داده شود. این مقدار زمانی استفاده میشود که جزئیات کارت خریدار مورد نیاز باشد. برای مثال، اگر پشتیبانی مشتری به این مقدار برای شناسایی کارتی که خریدار برای تراکنش خود استفاده کرده است نیاز داشته باشد. برای توضیحات قابل مشاهده توسط کاربر، به جای آن از ویژگی |
billingAddress | آدرس | خیر | آدرس صورتحساب مرتبط با روش پرداخت ارائه شده، در صورتی که billingAddressRequired روی true تنظیم شده باشد. پارامترهای کارت . |
cardFundingSource | رشته | بله | منبع تأمین مالی کارت برای روش پرداخت انتخاب شده.
|
مثال
این مثال یک کارت در شبکه ویزا را نشان میدهد.
{ "cardNetwork": "VISA", "cardDetails": "1234", "cardFundingSource": "CREDIT", "assuranceDetails": { "cardHolderAuthenticated": false, "accountVerified": true } }
جزئیات تضمینمشخصات
این شیء اطلاعاتی در مورد اعتبارسنجی انجام شده روی اعتبارنامههای پرداخت برگشتی ارائه میدهد تا بتوان بررسیهای ریسک ابزار مناسب را اعمال کرد.
| نام | نوع | توضیحات |
|---|---|---|
accountVerified | بولی | اگر true ، نشان میدهد که اعتبارسنجی مالکیت Cardholder روی اعتبارنامه پرداخت برگشتی انجام شده است. |
cardHolderAuthenticated | بولی | اگر اگر |
شما میتوانید شیء پاسخ را دریافت و پردازش کنید، حتی اگر از فیلد assuranceDetails استفاده نکنید. برای دریافت این شیء، assuranceDetailsRequired: true در شیء Request قرار دهید. پارامترهای کارت .
روش پرداختتوکنسازیدادهها
این شیء، دادههای توکنسازی را برای روش پرداخت فراهم میکند.
| ملک | نوع | همیشه وجود دارد | توضیحات |
|---|---|---|---|
type | رشته | بله | نوع توکنسازی که قرار است برای روش پرداخت انتخابشده اعمال شود. این مقدار با type تنظیمشده در مطابقت دارد. PaymentMethodTokenizationSpecification . |
token | رشته | خیر | توکن روش پرداخت تولید شده.
|
مثال
این نمونهای از یک پاسخ توکنسازی شده است که برای دروازه example آماده شده است.
{ "type": "PAYMENT_GATEWAY", "token": "examplePaymentMethodToken" }
آدرس
این شیء اطلاعاتی در مورد آدرس پستی درخواستی ارائه میدهد. همه ویژگیها رشته هستند.
آدرسها میتوانند در قالبهای MIN ، FULL و FULL-ISO3166 بازگردانده شوند. ویژگیهای مربوط به هر قالب را میتوانید در جدول زیر مشاهده کنید.
| ملک | قالب آدرس | توضیحات |
|---|---|---|
name | MIN ، FULL ، FULL-ISO3166 | نام کامل مخاطب. |
postalCode | MIN ، FULL ، FULL-ISO3166 | کد پستی یا پستی. |
countryCode | MIN ، FULL ، FULL-ISO3166 | کد کشور ISO 3166-1 alpha-2. |
phoneNumber | MIN ، FULL ، FULL-ISO3166 | یک شماره تلفن، اگر phoneNumberRequired در آن روی true تنظیم شده باشد درخواست دادههای پرداخت . |
address1 | FULL ، FULL-ISO3166 | خط اول آدرس. |
address2 | FULL ، FULL-ISO3166 | خط دوم آدرس. |
address3 | FULL ، FULL-ISO3166 | خط سوم آدرس. |
locality | FULL ، FULL-ISO3166 | شهر، شهرستان، محله یا حومه شهر. |
administrativeArea | FULL ، FULL-ISO3166 | یک زیرمجموعه کشوری، مانند ایالت یا استان. |
sortingCode | FULL ، FULL-ISO3166 | کد مرتب سازی. |
iso3166AdministrativeArea | FULL-ISO3166 | کد منطقه اداری ISO 3166-2 مربوط به administrativeArea. |
مثال
این یک نمونه آدرس با فرمت FULL-ISO3166 در ایالات متحده با چندین خط داده آدرس خیابان است.
{ "name": "John Doe", "address1": "c/o Google LLC", "address2": "1600 Amphitheatre Pkwy", "address3": "Building 40", "locality": "Mountain View", "administrativeArea": "CA", "countryCode": "US", "postalCode": "94043", "sortingCode": "" "iso3166AdministrativeArea": "US-CA" }