|
|
| Line 52: |
Line 52: |
| | IsSuccessful || bool || Indicates whether the payment was successful | | | IsSuccessful || bool || Indicates whether the payment was successful |
| |- | | |- |
| |}
| |
|
| |
| == Output properties ==
| |
|
| |
| {{api_output_table_header}}
| |
| |-
| |
| | PaymentId || Guid || The identifier of the newly initialized payment, generated by the Barion system.
| |
|
| |
| |-
| |
|
| |
| | PaymentRequestId || string || The payment identifier supplied by the API caller in the request.
| |
|
| |
| |-
| |
|
| |
| | Status || [[PaymentStatus]]|| The status of the payment in the Barion system.
| |
|
| |
| |-
| |
|
| |
| | QRUrl || string || URL for a QR code representing the payment. This is useful in physical real life situations where the payer uses a mobile device.
| |
|
| |
| |-
| |
|
| |
| | RecurrenceResult || RecurrenceResult || Indicates the result of an authorized payment scenario. The result depends on the values of the '''InitiateRecurrence''' and '''RecurrenceId''' properties supplied in the request.
| |
|
| |
| * If '''InitiateRecurrence''' was <code>true</code>, and a new authorized payment was successfully created, this will be <code>None</code> (because no actual token charge took place yet)
| |
|
| |
| * If '''InitiateRecurrence''' was <code>false</code>, but a previously authorized payment identifier was supplied in '''RecurrenceId''', the system will try to charge the funding source associated with the authorized payment. If this charge is successful, the result is <code>Successful</code>. If the system could not charge the funding srouce, the result is <code>Failed</code>. If the given identifier is invalid or does not exist, the result is <code>NotFound</code>.
| |
|
| |
| |-
| |
|
| |
| | Transactions || [[ProcessedTransaction]][] || An array containing all transactions associated with the payment. If the Barion system deducts fees from the shop after payments, this also contains these additional fee transactions beside the payment transactions that were sent in the request.
| |
|
| |
| |-
| |
|
| |
| | GatewayUrl || string || The URL of the Barion Smart Gateway (including the payment identifier), where the API caller should redirect the payer.
| |
|
| |
| |-
| |
|
| |
| | CallbackUrl || string || The URL (including the payment identifier) where the Barion system will send a request to whenever there is a change in the state of the payment. If an explicit URL was not supplied, this will be the callback URL associated with the shop that started the payment.
| |
|
| |
| |-
| |
|
| |
| | RedirectUrl || string|| The URL (including the payment identifier) where the payer gets redirected to after the payment is completed or cancelled. If an explicit URL was not supplied, this will be the redirect URL associated with the shop that started the payment.
| |
| |} | | |} |
Revision as of 11:22, 30 May 2022
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 |
- Required
- Maximum length: 256 characters
|
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.
|
| IsSuccessful |
bool |
Indicates whether the payment was successful
|