Create a Recurring Google Pay PayIn (CIT or MIT)

POST

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

POST

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

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payins/payment-methods/googlepay/recurring \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "DebitedFunds": {
>       "Currency": "EUR",
>       "Amount": 4567
>     },
>     "Fees": {
>       "Currency": "EUR",
>       "Amount": 1234
>     },
>     "SecureModeReturnURL": "https://example.com",
>     "IpAddress": "159.180.248.187",
>     "BrowserInfo": {
>       "AcceptHeader": "application/json,text/javascript,*/*;q=0.01",
>       "JavaEnabled": true,
>       "Language": "fr-FR",
>       "ColorDepth": 30,
>       "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
>     },
>     "RecurringPayinRegistrationId": "recpayinreg_wt_b2fecce5-f893-47dc-97be-c57cb6374492"
>   }
> }'

200Google Pay CIT

1 {
2   "Id": "wt_e294dc77-9689-449e-a04b-7b25c8e27a1e",
3   "Tag": null,
4   "CreationDate": 1774964623,
5   "AuthorId": "user_m_01KN1H4ENA23ATBA54ZWN21VKD",
6   "DebitedFunds": {
7     "Currency": "EUR",
8     "Amount": 4567
9   },
10   "CreditedFunds": {
11     "Currency": "EUR",
12     "Amount": 3333
13   },
14   "Fees": {
15     "Currency": "EUR",
16     "Amount": 1234
17   },
18   "Status": "SUCCEEDED",
19   "ResultCode": "000000",
20   "ResultMessage": "Success",
21   "ExecutionDate": 1774964623,
22   "Type": "PAYIN",
23   "Nature": "REGULAR",
24   "CreditedWalletId": "wlt_m_01JERJF53QMJE1HHRV7GGDACGM",
25   "PaymentType": "GOOGLE_PAY",
26   "ExecutionType": "DIRECT",
27   "StatementDescriptor": null,
28   "SecureModeNeeded": false,
29   "BrowserInfo": {
30     "AcceptHeader": "application/json,text/javascript,*/*;q=0.01",
31     "JavaEnabled": true,
32     "Language": "fr-FR",
33     "ColorDepth": 30,
34     "ScreenHeight": 667,
35     "ScreenWidth": 375,
36     "TimeZoneOffset": -120,
37     "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
38     "JavascriptEnabled": true
39   },
40   "IpAddress": "159.180.248.187",
41   "CardInfo": {
42     "BIN": "55555",
43     "IssuingBank": "STATE BANK OF NORWAY",
44     "IssuerCountryCode": "IN",
45     "Type": "CREDIT",
46     "SubType": "CLASSIC",
47     "Brand": "VISA"
48   },
49   "AuthenticationResult": {
50     "AuthenticationType": "FRICTIONLESS"
51   },
52   "RecurringPayinRegistrationId": "recpayinreg_wt_b2fecce5-f893-47dc-97be-c57cb6374492",
53   "CreditedUserId": "user_m_01JERJEJAYP6NETHYZ3W9VKET4",
54   "FlowDescriptor": {
55     "FlowId": "flow_wt_97448e0a-5bc6-4b83-ac29-cdfcadf60a08",
56     "Beneficiaries": null
57   },
58   "SecureMode": "DEFAULT",
59   "SecureModeReturnURL": "https://example.com/?transactionId=wt_e294dc77-9689-449e-a04b-7b25c8e27a1e",
60   "SecureModeRedirectURL": null,
61   "SecurityInfo": null
62 }

Request a recurring Google Pay pay-in based on a RecurringPayinRegistrationId with PaymentType GOOGLE_PAY, obtained from POST Create a Recurring PayIn Registration.

There are two possible paylods:

CIT – Customer-initiated transaction when the user is on session, which may require them to authenticate on the SecureModeRedirectURL returned (unless authentication was handled by Google Pay).
MIT – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication, unless and until re-authentication is required.

Read more about Google Pay recurring payments →

Request a recurring Google Pay pay-in based on a `RecurringPayinRegistrationId` with `PaymentType` `GOOGLE_PAY`, obtained from [POST Create a Recurring PayIn Registration](/api-reference/recurring-payin-registrations/create-recurring-payin-registration). There are two possible paylods: - **CIT** – Customer-initiated transaction when the user is on session, which may require them to authenticate on the `SecureModeRedirectURL` returned (unless authentication was handled by Google Pay). - **MIT** – Subsequent merchant-initiated transactions in the absence of the user, based on the initial successful authentication, unless and until re-authentication is required. Read more about [Google Pay recurring payments](/guides/payment-methods/google-pay#recurring-payments) **→**

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.

Google Pay CITobjectRequired

Request body for a Google Pay customer-initiated transaction (CIT).

Google Pay MITobjectRequired

Request body for a Google Pay merchant-initiated transaction (MIT).

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.

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

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.

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

RecurringPayinRegistrationIdstring

The unique identifier of the recurring pay-in registration.