Create a Google Pay PayIn

POST

/v2.01/:ClientId/payins/payment-methods/googlepay

POST

/v2.01/:ClientId/payins/payment-methods/googlepay

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payins/payment-methods/googlepay \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "AuthorId": "6697855",
>     "CreditedWalletId": "6697856",
>     "FlowDescriptor": {
>       "Beneficiaries": [
>         {
>           "UserId": "user_m_02APAYTWSDYXHXN1FRTKX9WMA2"
>         }
>       ]
>     },
>     "DebitedFunds": {
>       "Currency": "EUR",
>       "Amount": 1000
>     },
>     "Fees": {
>       "Currency": "EUR",
>       "Amount": 0
>     },
>     "StatementDescriptor": "Statement",
>     "Tag": "Google Pay PayIn",
>     "IpAddress": "159.180.248.187",
>     "SecureModeReturnURL": "http://example.com",
>     "SecureMode": "DEFAULT",
>     "ReturnURL": "http://example.com",
>     "BrowserInfo": {
>       "AcceptHeader": "application/json,text/javascript,*/*;q=0.01<",
>       "JavaEnabled": true,
>       "Language": "fr",
>       "ColorDepth": 32,
>       "ScreenHeight": 667,
>       "ScreenWidth": 375,
>       "TimeZoneOffset": "-120",
>       "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
>       "JavascriptEnabled": true
>     },
>     "PaymentData": "{\"signature\":\"MEUCIQDc49/Bw1lTk8ok2fUe4UT2q955C01N2av40WJ28pMt0QIgBxiXHZbccHuqEQHyNJJw8SM337fxd8A3kJFqhsf4pHo\\u003d\",\"intermediateSigningKey\":{\"signedKey\":\"{\\\"keyValue\\\":\\\"MFkwEwYHKoZIzj0CAQYIKoZIzj0DAQcDQgAE8bX5bzBELcoJ1pPhEHtTIhpZQsRgVIMtRf9R5yRyC9c9WH8bvgxIx40qH4aQ+btVM/rwKuDE8cs+dERH2gjUjw\\\\u003d\\\\u003d\\\",\\\"keyExpiration\\\":\\\"1688804022772\\\"}\",\"signatures\":[\"MEUCIF2OifAlN5PG+isU+xxX8/OU5MTk81hBulSmp9bu8caDAiEAkdRqb8uo4CUx4kMiA317A1b+5BxRUc/8+QMyc9Ikjfg\\u003d\"]},\"protocolVersion\":\"ECv2\",\"signedMessage\":\"{\\\"encryptedMessage\\\":\\\"tsTuUpytOkm8ENo1PpyzsHk6jxGDus/sSNQwqZeoPNw/NMQX2LJxJ6OTS4Yt+iNM7v4iuFC0eUWiy58xCQHKANeO/y66GJWMaDjPW2FBqBksb1WHXxP5KmgglACSqXtOMmjuYxVT6MeO4EfdsT4vGHRP0adP+Lkfj1tfjM1K0HyRWbLcwU9YXU0j83wV3PW28oxdFY5F4DC+Bhk7J5bZhIf5jymRXy3sR0kDoE/Qi4fUIdvgoHzi6MvppxCaEgwCygvfxu+vddP/7dshnL9+OFaDpoAp6is8I4UYbscNHkLosfBPwyUtndLMkDfNKUJ3yus92KSfbcK0iif3kXSMmV6ZrN873S7f27bsCsHhAlywOFpACorBNO8FzX/ediCsSi+n5kWOxe9oewGOeME2RNTsoy8an23be8yTek3YKajIhJRFW/9OtVnNmKOqwgw0F8nPFTjuSVPZbkinYS46Tr+KjOcr5aznEElkmk6OWgX1xSVkHZPpoW8XZdhB6Vs/5eWP6URncDZYN2EWtpWuz1+CAVKEjD95gcQGvzhmlPB0duiV76psDik8ojf2B6QfPJxV\\\",\\\"ephemeralPublicKey\\\":\\\"BJ0QIVwltj1vH2NAmYgUYBRrNymcOtTTP3QJnSc+enFGigIhNS87PZyA0PZ4iT/tifOqBj6barpJMwSQeO3nbJ0\\\\u003d\\\",\\\"tag\\\":\\\"R0iTOk4bogyVkf0STTvdiFq4kebJS7GN5/zxoBuCNNs\\\\u003d\\\"}\"}",
>     "Billing": {
>       "FirstName": "Arthur",
>       "LastName": "Doe",
>       "Address": {
>         "AddressLine1": "The Oasis",
>         "AddressLine2": "Rue des Plantes",
>         "City": "Paris",
>         "Region": "Ile de France",
>         "PostalCode": "75001",
>         "Country": "FR"
>       }
>     },
>     "Shipping": {
>       "FirstName": "John",
>       "LastName": "Doe",
>       "Address": {
>         "AddressLine1": "The Oasis",
>         "AddressLine2": "Rue des Plantes",
>         "City": "Paris",
>         "Region": "Ile de France",
>         "PostalCode": "2345",
>         "Country": "FR"
>       }
>     }
>   }
> }'

1 {
2   "Id": "wt_7607f14c-2929-431c-a989-ea4f48352ead",
3   "Tag": "Created using the Mangopay API Postman collection",
4   "CreationDate": 1706097560,
5   "AuthorId": "213407540",
6   "FlowDescriptor": {
7     "FlowId": "flow_wt_97448e0a-5bc6-4b83-ac29-cdfcadf60a08",
8     "Beneficiaries": [
9       {
10         "UserId": "user_m_02APAYTWSDYXHXN1FRTKX9WMA2"
11       }
12     ]
13   },
14   "DebitedFunds": {
15     "Currency": "EUR",
16     "Amount": 100
17   },
18   "CreditedFunds": {
19     "Currency": "EUR",
20     "Amount": 100
21   },
22   "Fees": {
23     "Currency": "EUR",
24     "Amount": 0
25   },
26   "Status": "SUCCEEDED",
27   "ResultCode": "000000",
28   "ResultMessage": "Success",
29   "ExecutionDate": 1706097562,
30   "Type": "PAYIN",
31   "Nature": "REGULAR",
32   "CreditedWalletId": "213407543",
33   "PaymentType": "GOOGLE_PAY",
34   "ExecutionType": "DIRECT",
35   "StatementDescriptor": "Mangopay",
36   "SecureModeNeeded": false,
37   "BrowserInfo": {
38     "AcceptHeader": "application/json,text/javascript,*/*;q=0.01<",
39     "JavaEnabled": true,
40     "Language": "fr",
41     "ColorDepth": 32,
42     "ScreenHeight": 667,
43     "ScreenWidth": 375,
44     "TimeZoneOffset": -120,
45     "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
46     "JavascriptEnabled": true
47   },
48   "IpAddress": "ddcd:543d:1cd4:a9e4:7a29:6cd1:93b6:772d",
49   "CardInfo": {
50     "BIN": "555555",
51     "IssuingBank": "CIAGROUP",
52     "IssuerCountryCode": "BR",
53     "Type": "DEBIT",
54     "SubType": "PREPAID",
55     "Brand": "MASTERCARD"
56   },
57   "AuthenticationResult": {
58     "AuthenticationType": "FRICTIONLESS"
59   },
60   "CreditedUserId": "213407540",
61   "SecureMode": "DEFAULT",
62   "SecureModeReturnURL": "http://example.com",
63   "SecureModeRedirectURL": null,
64   "SecurityInfo": null
65 }

Create a Google Pay PayIn

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.

AuthorIdstringRequired

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

CreditedWalletIdstringRequired

The unique identifier of the credited wallet.

DebitedFundsobjectRequired

Information about the debited funds.

FeesobjectRequired

Information about the fees.

IpAddressstringRequired

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

SecureModeReturnURLstringRequired

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).

BrowserInfoobjectRequired

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

PaymentDatastringRequired

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

FlowDescriptorobjectOptional

Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made (read more).

If the FlowDescriptor.Beneficiaries is sent in the API request, then:

The transaction’s CreditedWalletId holder is disregarded in KYC/KYB checks.
ALL UserId values in the array must be one of:
- OWNER whose KYCLevel is REGULAR
- PLATFORM

The pay-in Status becomes FAILED with ResultCode 002951 if at least one FlowDescriptor.Beneficiaries.UserId is:

PAYER
OWNER whose KYCLevel is LIGHT

If the FlowDescriptor.Beneficiaries is not sent in the API request, then the CreditedWalletId holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the CreditedWalletId holder is a PAYER or the same value as one of the FlowDescriptor.Beneficiaries.

StatementDescriptorstringOptional

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.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

SecureModestringOptional

Allowed values: DEFAULT, FORCE, NO_CHOICE

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.

BillingobjectOptional

Default values: FirstName, LastName, and Address information of the Shipping object if sent, otherwise of the AuthorId (if address values present).

Information about the billing address.

ShippingobjectOptional

Default values: FirstName, LastName, and Address information of the Billing object if sent, otherwise of the AuthorId (if address values present).

Information about the shipping address.

ProfilingAttemptReferencestringOptional

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.

Response

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

AuthorIdstring

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

FlowDescriptorobject

Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made (read more).

If the FlowDescriptor.Beneficiaries is sent in the API request, then:

The transaction’s CreditedWalletId holder is disregarded in KYC/KYB checks.
ALL UserId values in the array must be one of:
- OWNER whose KYCLevel is REGULAR
- PLATFORM

The pay-in Status becomes FAILED with ResultCode 002951 if at least one FlowDescriptor.Beneficiaries.UserId is:

PAYER
OWNER whose KYCLevel is LIGHT

DebitedFundsobject

Information about the debited funds.

CreditedFundsobject

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

Feesobject

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

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ResultCodestring

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

ResultMessagestring

The explanation of the result code.

ExecutionDateinteger

Unix timestamp (UTC) of the date and time the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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.

CreditedWalletIdstring

The unique identifier of the credited wallet.

PaymentTypestring

Returned values: GOOGLE_PAY

The payment type of the pay-in.

ExecutionTypestring

Returned values: DIRECT

The execution type of the pay-in.

StatementDescriptorstring

Max. length: 10 characters; only alphanumeric and spaces

SecureModeNeededboolean

Whether or not the SecureMode was used.

Billingobject

Default values: FirstName, LastName, and Address information of the Shipping object if sent, otherwise of the AuthorId (if address values present).

Information about the billing address.

Shippingobject

Default values: FirstName, LastName, and Address information of the Billing object if sent, otherwise of the AuthorId (if address values present).

Information about the shipping address.

BrowserInfoobject

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

IpAddressstring

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

CardInfoobject

Information about the card used for the transaction. If the information or data is not available, null is returned.

AuthenticationResultobject

Information about the authentication result, based on the request made by Mangopay and the decision of the issuer regarding the type of authentication to be enforced (if applicable).