Payment-StartPaymentWithGoogleToken-v3: Difference between revisions
Jump to navigation
Jump to search
(Created page with "{{PageTitle|title=Barion API: Start payment with Google Pay™}} {{TableOfContents}} {{api_callmethod |method=POST |uri=/v3/Payment/StartPaymentWithGoogleToken }} The <code...") |
|||
| (5 intermediate revisions by 2 users not shown) | |||
| Line 8: | Line 8: | ||
}} | }} | ||
The <code>/payment/startpaymentwithgoogletoken</code> API endpoint is used to create a new payment in the Barion system and fund it via Google | The <code>/payment/startpaymentwithgoogletoken</code> API endpoint is used to create a new payment in the Barion system and fund it via Google Pay. | ||
Prerequisites before use: | Prerequisites before use: | ||
| Line 22: | Line 22: | ||
This API endpoint is designed to be used in the following scenarios: | This API endpoint is designed to be used in the following scenarios: | ||
* [[Google_Pay|Payment with Google Pay]] | * [[Google_Pay|Payment with Google Pay]] | ||
== Input properties == | |||
The input parameters extend the parameters from the [[Payment-Start-v2]] endpoint. This means that everything from that | |||
{{api_input_table_header}} | |||
|- | |||
|PayerEmailAddress|| string || | |||
* Required | |||
* Maximum length: 256 characters | |||
|| The e-mail address of the Google Pay user. This is provided by Google. | |||
|- | |||
| GooglePayToken || string || | |||
* Required | |||
|| The Google Pay token. The encrypted Google Pay token that contains the card information. | |||
|- | |||
|} | |||
== Output properties == | |||
{{api_output_table_header}} | |||
|- | |||
| PaymentId || Guid || The identifier of the payment, generated by the Barion system. | |||
|- | |||
| PaymentRequestId || string || The payment identifier supplied by the API caller in the request. | |||
|- | |||
| PaymentStatus || [[PaymentStatus]]|| The status of the payment in the Barion system. | |||
|- | |||
| ThreeDSAuthClientData || string || Encrypted authentication data required to perform [https://docs.barion.com/Token_payment_3D_Secure#Off-site_3DS_v2_authentication Off-site 3DS authentication] | |||
|- | |||
| TraceId || string || The 3DSecure TraceId of the process, if applicable | |||
|- | |||
| IsSuccessful || bool || Indicates whether the payment was successful | |||
|- | |||
|} | |||
Latest revision as of 11:02, 20 November 2023
Barion API: Start payment with Google Pay™
| POST | /v3/Payment/StartPaymentWithGoogleToken |
|---|
The /payment/startpaymentwithgoogletoken API endpoint is used to create a new payment in the Barion system and fund it via Google Pay.
Prerequisites before use:
v3 This API endpoint is available in API v3 only.
Use cases
This API endpoint is designed to be used in the following scenarios:
Input properties
The input parameters extend the parameters from the Payment-Start-v2 endpoint. This means that everything from that
| Property name | Property type | Limitations and constraints | Description |
|---|---|---|---|
| PayerEmailAddress | string |
|
The e-mail address of the Google Pay user. This is provided by Google. |
| GooglePayToken | string |
|
The Google Pay token. The encrypted Google Pay token that contains the card information. |
Output properties
| Property name | Property type | Description |
|---|---|---|
| PaymentId | Guid | The identifier of the payment, generated by the Barion system. |
| PaymentRequestId | string | The payment identifier supplied by the API caller in the request. |
| PaymentStatus | PaymentStatus | The status of the payment in the Barion system. |
| ThreeDSAuthClientData | string | Encrypted authentication data required to perform Off-site 3DS authentication |
| TraceId | string | The 3DSecure TraceId of the process, if applicable |
| IsSuccessful | bool | Indicates whether the payment was successful |