The Google Pay PayIn object

Description

The Google Pay PayIn object allows platforms to process payments with Google Pay. 

Caution – Prerequisites to using Google Pay

Using Google Pay activation from Mangopay. See How to process an Google Pay payment for more details and contact our teams via the Dashboard.

The platform also needs to integrate with Google Pay. For more information, see the Google Pay documentation.

Attributes

Id

string

The unique identifier of the object.

Tag

string

Max. length: 255 characters

Custom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.

CreationDate

timestamp

The date and time at which the object was created.

AuthorId

string

The unique identifier of the user at the source of the transaction.

DebitedFunds

object

Information about the debited funds.

Show properties

Currency

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the funds.

Amount

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

CreditedFunds

object

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Show properties

Currency

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the funds.

Amount

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Fees

string

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

Show properties

Currency

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the fees.

Amount

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Status

string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCode

string

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessage

string

The explanation of the result code.

ExecutionDate

timestamp

The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Type

string

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Nature

string

Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENT

The nature of the transaction, providing more information about the context in which the transaction occurred:

• REGULAR – Relative to most of the transactions (pay-ins, payouts, and transfers) in a usual workflow.
• REPUDIATION – Automatic withdrawal of funds from the platform’s repudiation wallet as part of the dispute process (when the user has requested a chargeback).
• REFUND – Reimbursement of a transaction to the user (pay-in refund), to a wallet (transfer refund), or of a payout (payout refund, only initiated by Mangopay).
• SETTLEMENT – Transfer made to the repudiation wallet by the platform to settle a lost dispute.

CreditedWalletId

string

The unique identifier of the credited wallet.

PaymentType

string

Returned values: GOOGLE_PAY

The type of pay-in.

ExecutionType

string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The type of execution for the pay-in.

StatementDescriptor

string

Max. length: 10 characters; only alphanumeric and spaces

Custom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.

SecureMode

string

Default value: DEFAULT

The mode applied for the 3DS2 protocol for CB, Visa, and Mastercard. The options are:

• DEFAULT – Requests an exemption to strong customer authentication (SCA), and thus a frictionless payment experience, if allowed by your Mangopay contract and accepted by the issuer.
• FORCE – Requests SCA.
• NO_CHOICE – Leaves the choice to the issuer whether to allow for a frictionless payment experience or to enforce SCA.

SecureModeReturnURL

string

Max. length: 255 characters

The URL to which users are automatically returned after 3DS2 if it is triggered (i.e., if the SecureModeNeeded parameter is set to true).

SecureModeRedirectURL

string

Max. length: 255 characters

The URL to which to redirect the user to proceed to 3DS2 validation.

Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.

SecureModeNeeded

boolean

Whether or not the SecureMode was used.

SecurityInfo

object

Information regarding security and anti-fraud tools.

Show properties

AVSResult

string

The result of the Address Verification System check (only available for UK, US, and Canada).

BrowserInfo

object

Information about the browser used by the end user (author) to perform the payment.

Show properties

AcceptHeader

string

The exact content of the HTTP accept headers as sent to the platform from the end user’s browser.

JavaEnabled

boolean

Whether or not the end user’s browser has the ability to execute Java.

Language

string

Max. length: 6 characters

The browser language, made up of the language code and the country (e.g., “en-US”).

ColorDepth

integer

The value representing the depth of the screen’s color palette for displaying images, in bits per pixel.

ScreenHeight

integer

Max. length: 6 characters

The height of the screen in pixels.

ScreenWidth

integer

Max. length: 6 characters

The width of the screen in pixels.

TimeZoneOffset

integer

The difference in minutes between the browser’s timezone and UTC.

UserAgent

string

Max. length: 255 characters

The exact content of the HTTP User-Agent header.

JavascriptEnabled

boolean

Whether or not the end user’s browser has the ability to execute JavaScript.

IpAddress

string

The IP address of the end user initiating the transaction, in IPV4 or IPV6 format.

PaymentData

string

The data returned by Google Pay containing information about the payment.

Billing

string

Default value: FirstName, LastName, and Address information of the Shipping object if supplied.

Information about the end user billing address. If left empty, the default values will be automatically taken into account.

Show properties

FirstName

string

The first name of the user.

LastName

string

Max. length: 100 characters

The last name of the user.

Address

object

Information about the billing address.

Show child attributes

AddressLine1

string

Max. length: 255 characters

The first line of the address.

AddressLine2

string

Max. length: 255 characters

The second line of the address.

City

string

Max. length: 255 characters

The city of the address.

Region

string

Max. length: 255 characters

Required if the Country is US, CA, or MX.

The region of the address.

PostalCode

string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country

string

Allowed values: Country code in the ISO 3166-1 alpha-2 format.

The country of the address.

Shipping

string

Default values: FirstName, LastName, and Address information of the Billing object (if supplied).

Information about the end user’s shipping address. If left empty, the default values will be automatically taken into account.

Show properties

FirstName

string

The first name of the user.

LastName

string

Max. length: 100 characters

The last name of the user.

Address

object

Information about the shipping address.

Show child attributes

AddressLine1

string

Max. length: 255 characters

The first line of the address.

AddressLine2

string

Max. length: 255 characters

The second line of the address.

City

string

Max. length: 255 characters

The city of the address.

Region

string

Max. length: 255 characters

Required if the Country is US, CA, or MX.

The region of the address.

PostalCode

string

Max. length: 255 characters

The postal code of the address. The postal code can contain the following characters: alphanumeric, dashes, and spaces.

Country

string

Allowed values: Country code in the ISO 3166-1 alpha-2 format.

The country of the address.

ProfilingAttemptReference

string

The unique reference generated for the profiling session, used by the fraud prevention solution to produce recommendations for the transaction using the profiling data.

Note: Parameter not returned by the API. Profiling feature available on request – contact Mangopay via the Dashboard for more information.

Related resources

Guide

Learn more about Google Pay