View a PayIn

GET

/v2.01/:ClientId/payins/:PayInId

GET

/v2.01/:ClientId/payins/:PayInId

$ curl https://api.sandbox.mangopay.com/v2.01/{ClientId}/payins/{PayInId} \
>      -H "Authorization: Bearer <token>"

1 {
2   "Id": "wt_370e1720-3591-42d1-9393-d1382d6e74ac",
3   "Tag": "Created using Mangopay API Postman Collection",
4   "CreationDate": 1771580095,
5   "AuthorId": "user_m_01KHRMAQT1ZPVBWK2KYM6S0N7M",
6   "DebitedFunds": {
7     "Currency": "EUR",
8     "Amount": 10000
9   },
10   "CreditedFunds": {
11     "Currency": "EUR",
12     "Amount": 9900
13   },
14   "Fees": {
15     "Currency": "EUR",
16     "Amount": 100
17   },
18   "Status": "CREATED",
19   "ResultCode": null,
20   "ResultMessage": null,
21   "ExecutionDate": null,
22   "Type": "PAYIN",
23   "Nature": "REGULAR",
24   "CreditedWalletId": "wlt_m_01KH8RY6BKXD2ZT7F76XH2TS7Z",
25   "CreditedUserId": "user_m_01KHRMAQT1ZPVBWK2KYM6S0N7M",
26   "PaymentType": "CARD",
27   "ExecutionType": "DIRECT",
28   "StatementDescriptor": "Example123",
29   "Billing": {
30     "FirstName": "Alex",
31     "LastName": "Smith",
32     "Address": {
33       "AddressLine1": "6 rue de la Cité",
34       "AddressLine2": "Appartement 3",
35       "City": "Paris",
36       "Region": "Ile-de-France",
37       "PostalCode": "75001",
38       "Country": "FR"
39     }
40   },
41   "Shipping": {
42     "FirstName": "Alex",
43     "LastName": "Smith",
44     "Address": {
45       "AddressLine1": "6 rue de la Cité",
46       "AddressLine2": "Appartement 3",
47       "City": "Paris",
48       "Region": "Ile-de-France",
49       "PostalCode": "75001",
50       "Country": "FR"
51     }
52   },
53   "SecureMode": "DEFAULT",
54   "SecureModeNeeded": true,
55   "SecureModeReturnURL": "http://example.com?transactionId=wt_370e1720-3591-42d1-9393-d1382d6e74ac",
56   "SecureModeRedirectURL": "https://api.sandbox.whenthen.co/payment-gateway/whenthen/threeDS/54b0c206-0a67-43d4-ace6-14a25697cf85/challenge?id=370e1720-3591-42d1-9393-d1382d6e74ac&url=aHR0cHM6Ly9hcGkuc2FuZGJveC53aGVudGhlbi5jby9wYXltZW50cy8zRFNlY3VyZS81NGIwYzIwNi0wYTY3LTQzZDQtYWNlNi0xNGEyNTY5N2NmODUvNjI3ZTIxZjAtOTFhNy00MDAxLWFmODEtNzc3ODMxMzMxMTQ5&amount=MTAwMDA&currency=RVVS",
57   "SecurityInfo": {
58     "AVSResult": "NO_CHECK"
59   },
60   "BrowserInfo": {
61     "AcceptHeader": "text/html, application/xhtml+xml, application/xml;q=0.9, /;q=0.8",
62     "JavaEnabled": true,
63     "Language": "en",
64     "ColorDepth": 4,
65     "ScreenHeight": 1800,
66     "ScreenWidth": 400,
67     "TimeZoneOffset": 60,
68     "UserAgent": "Mozilla/5.0 (iPhone; CPU iPhone OS 13_6_1 like Mac OS X) AppleWebKit/605.1.15 (KHTML, like Gecko) Mobile/15E148",
69     "JavascriptEnabled": true
70   },
71   "IpAddress": "e57a:b6cb:6f5d:ac78:045d:58ca:4c39:0732",
72   "CardId": "card_wt_npZtQgxDEFdtXZvJ",
73   "CardInfo": {
74     "BIN": "497010",
75     "IssuingBank": "LA BANQUE POSTALE",
76     "IssuerCountryCode": "MA",
77     "Type": "CREDIT",
78     "SubType": null,
79     "Brand": "VISA"
80   },
81   "Requested3DSVersion": null,
82   "Applied3DSVersion": null,
83   "RecurringPayinRegistrationId": null,
84   "PreferredCardNetwork": null,
85   "Culture": "EN",
86   "DebitedWalletId": null,
87   "PaymentCategory": "ECommerce",
88   "AuthenticationResult": {
89     "AuthenticationType": "CHALLENGE"
90   }
91 }

Note – Pay-in data retained for 13 months

An API call to retrieve a pay-in whose CreationDate is older than 13 months may return 404 Not Found.

For more information, see the Data availability periods article.

Retrieve any pay-in by its Id. The object returned depends on the endpoint that was used to create it. The difference is indicated by the PaymentType, ExecutionType, and in some cases other properties.

<Note icon="fa-regular fa-circle-info"> **Note – Pay-in data retained for 13 months** An API call to retrieve a pay-in whose `CreationDate` is older than 13 months may return 404 Not Found. For more information, see the <a href="/api-reference/overview/data-availability-periods">Data availability periods</a> article. </Note> Retrieve any pay-in by its `Id`. The object returned depends on the endpoint that was used to create it. The difference is indicated by the `PaymentType`, `ExecutionType`, and in some cases other properties.

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.

PayInIdstringRequired

The unique identifier of the pay-in.

Response

Success

Direct Card PayInobject

A one-time direct card pay-in:

PaymentType – CARD
ExecutionType – DIRECT
Object does not include RecurringPayinRegistrationId

Recurring Card PayInobject

A recurring direct card pay-in:

PaymentType – CARD
ExecutionType – DIRECT
Object includes RecurringPayinRegistrationId

Preauthorized PayInobject

A 7-day preauthorized card pay-in:

PaymentType – PREAUTHORIZED
ExecutionType – DIRECT
Object includes PreauthorizationId

Deposit Preauthorized PayInobject

A 29-day deposit preauthorized pay-in:

PaymentType – PREAUTHORIZED
ExecutionType – DIRECT
Object includes DepositId

The payment method is determined by the Deposit Preauthorization’s PaymentType: CARD_DIRECT or PAPAY.

Web Card PayInobject

A web card pay-in:

PaymentType – CARD
ExecutionType – WEB

Apple Pay PayInobject

A one-time Apple Pay pay-in:

PaymentType – APPLEPAY
ExecutionType – DIRECT
Object does not include RecurringPayinRegistrationId

Recurring Apple Pay PayInobject

A recurring Apple Pay pay-in:

PaymentType – APPLEPAY
ExecutionType – DIRECT
Object includes RecurringPayinRegistrationId

Google Pay PayInobject

A one-time Google Pay pay-in:

PaymentType – GOOGLE_PAY
ExecutionType – DIRECT
Object does not include RecurringPayinRegistrationId

Recurring Google Pay PayInobject

A recurring Google Pay pay-in:

PaymentType – GOOGLE_PAY
ExecutionType – DIRECT
Object includes RecurringPayinRegistrationId

PayPal PayInobject

A one-time PayPal pay-in:

PaymentType – PAYPAL
ExecutionType – WEB
Object does not include RecurringPayinRegistrationId

Recurring PayPal PayInobject

A recurring PayPal pay-in:

PaymentType – PAYPAL
ExecutionType – DIRECT
Object includes RecurringPayinRegistrationId

Bank Wire PayInobject

A direct bank wire pay-in:

PaymentType – BANK_WIRE
ExecutionType – DIRECT

External Instruction Bank Wire PayInobject

A bank wire pay-in to a Virtual Account (or Banking Alias):

PaymentType – BANK_WIRE
ExecutionType – EXTERNAL_INSTRUCTION

Pay by Bank PayInobject

A Pay by Bank pay-in:

PaymentType – PAY_BY_BANK
ExecutionType – WEB

Bancontact PayInobject

A Bancontact pay-in:

PaymentType – BCMC
ExecutionType – WEB

Bizum PayInobject

A Bizum pay-in:

PaymentType – BIZUM
ExecutionType – WEB

BLIK PayInobject

A BLIK pay-in:

PaymentType – BLIK
ExecutionType – WEB

Giropay PayInobject

A Giropay pay-in:

PaymentType – GIROPAY
ExecutionType – WEB

iDEAL PayInobject

An iDEAL pay-in:

PaymentType – IDEAL
ExecutionType – WEB

Klarna PayInobject

A Klarna pay-in:

PaymentType – KLARNA
ExecutionType – WEB

MB WAY PayInobject

An MB WAY pay-in:

PaymentType – MBWAY
ExecutionType – WEB

Multibanco PayInobject

A Multibanco pay-in:

PaymentType – MULTIBANCO
ExecutionType – WEB

Payconiq PayInobject

A Payconiq pay-in:

PaymentType – PAYCONIQ
ExecutionType – WEB

Satispay PayInobject

A Satispay pay-in:

PaymentType – SATISPAY
ExecutionType – WEB

Swish PayInobject

A Swish pay-in:

PaymentType – SWISH
ExecutionType – WEB

TWINT PayInobject

A TWINT pay-in:

PaymentType – TWINT
ExecutionType – WEB

Direct Debit PayInobject

A direct debit pay-in:

PaymentType – DIRECT_DEBIT
ExecutionType – DIRECT

The scheme, SDD or Bacs, is determined by the mandate.

Web Direct Debit PayInobject

A web direct debit pay-in:

PaymentType – DIRECT_DEBIT
ExecutionType – WEB