View a PayIn
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 – 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.
Note – New unified Bank Wire object in Sandbox
Sandbox returns a new, unified response object for the two BANK_WIRE pay-in variants: to a Mangopay account (DIRECT) and to a Virtual Account EXTERNAL_INSTRUCTION).
This backwards-compatible object harmonizes the shape of the data returned between both objects and will be rolled out to Production at a later date.
Authentication
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.
For all platforms, the public IP address from which the API call originates must be declared in the IP allowlist for the corresponding Client ID, in both Production and Sandbox.
Path parameters
The unique identifier of the pay-in.
Response
A one-time direct card pay-in:
PaymentType–CARDExecutionType–DIRECT- Object does not include
RecurringPayinRegistrationId
A recurring direct card pay-in:
PaymentType–CARDExecutionType–DIRECT- Object includes
RecurringPayinRegistrationId
A web card pay-in:
PaymentType–CARDExecutionType–WEB
A one-time Apple Pay pay-in:
PaymentType–APPLEPAYExecutionType–DIRECT- Object does not include
RecurringPayinRegistrationId
A recurring Apple Pay pay-in:
PaymentType–APPLEPAYExecutionType–DIRECT- Object includes
RecurringPayinRegistrationId
A one-time Google Pay pay-in:
PaymentType–GOOGLE_PAYExecutionType–DIRECT- Object does not include
RecurringPayinRegistrationId
A recurring Google Pay pay-in:
PaymentType–GOOGLE_PAYExecutionType–DIRECT- Object includes
RecurringPayinRegistrationId
A one-time PayPal pay-in:
PaymentType–PAYPALExecutionType–WEB- Object does not include
RecurringPayinRegistrationId
A recurring PayPal pay-in:
PaymentType–PAYPALExecutionType–DIRECT- Object includes
RecurringPayinRegistrationId
A bank wire pay-in, either pre-declared to a Mangopay pooled account or received on a Virtual Account:
PaymentType–BANK_WIREExecutionType–DIRECTorEXTERNAL_INSTRUCTION
Note: This unified object is currently only returned in Sandbox. In Production, the same PaymentType/ExecutionType combinations still return the legacy objects, but the backwards compatible unified object will be rolled out at a later date. Read more &rar;
A direct bank wire pay-in:
PaymentType–BANK_WIREExecutionType–DIRECT
A bank wire pay-in to a Virtual Account (or Banking Alias):
PaymentType–BANK_WIREExecutionType–EXTERNAL_INSTRUCTION
A Pay by Bank pay-in:
PaymentType–PAY_BY_BANKExecutionType–WEB
A Bancontact pay-in:
PaymentType–BCMCExecutionType–WEB
A Bizum pay-in:
PaymentType–BIZUMExecutionType–WEB
A BLIK pay-in:
PaymentType–BLIKExecutionType–WEB
A Giropay pay-in:
PaymentType–GIROPAYExecutionType–WEB
An iDEAL pay-in:
PaymentType–IDEALExecutionType–WEB
A Klarna pay-in:
PaymentType–KLARNAExecutionType–WEB
An MB WAY pay-in:
PaymentType–MBWAYExecutionType–WEB
A Multibanco pay-in:
PaymentType–MULTIBANCOExecutionType–WEB
A Payconiq pay-in:
PaymentType–PAYCONIQExecutionType–WEB
A Satispay pay-in:
PaymentType–SATISPAYExecutionType–WEB
A Swish pay-in:
PaymentType–SWISHExecutionType–WEB
A TWINT pay-in:
PaymentType–TWINTExecutionType–WEB
A direct debit pay-in:
PaymentType–DIRECT_DEBITExecutionType–DIRECT
The scheme, SDD or Bacs, is determined by the mandate.
A web direct debit pay-in:
PaymentType–DIRECT_DEBITExecutionType–WEB