Skip to navigation
All pay-insPay-ins

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

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.

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
OR
Recurring Card PayInobject

A recurring direct card pay-in:

  • PaymentType – CARD
  • ExecutionType – DIRECT
  • Object includes RecurringPayinRegistrationId
OR
Preauthorized PayInobject

A 7-day preauthorized card pay-in:

  • PaymentType – PREAUTHORIZED
  • ExecutionType – DIRECT
  • Object includes PreauthorizationId
OR
Extended Preauthorized PayIn (legacy Deposit Preauthorization)object

A 29-day extended preauthorized pay-in:

  • PaymentType – PREAUTHORIZED
  • ExecutionType – DIRECT
  • Object includes ExtendedPreauthorizationId (and the deprecated DepositId containing the same unique value).

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

OR
Web Card PayInobject

A web card pay-in:

  • PaymentType – CARD
  • ExecutionType – WEB
OR
Apple Pay PayInobject

A one-time Apple Pay pay-in:

  • PaymentType – APPLEPAY
  • ExecutionType – DIRECT
  • Object does not include RecurringPayinRegistrationId
OR
Recurring Apple Pay PayInobject

A recurring Apple Pay pay-in:

  • PaymentType – APPLEPAY
  • ExecutionType – DIRECT
  • Object includes RecurringPayinRegistrationId
OR
Google Pay PayInobject

A one-time Google Pay pay-in:

  • PaymentType – GOOGLE_PAY
  • ExecutionType – DIRECT
  • Object does not include RecurringPayinRegistrationId
OR
Recurring Google Pay PayInobject

A recurring Google Pay pay-in:

  • PaymentType – GOOGLE_PAY
  • ExecutionType – DIRECT
  • Object includes RecurringPayinRegistrationId
OR
PayPal PayInobject

A one-time PayPal pay-in:

  • PaymentType – PAYPAL
  • ExecutionType – WEB
  • Object does not include RecurringPayinRegistrationId
OR
Recurring PayPal PayInobject

A recurring PayPal pay-in:

  • PaymentType – PAYPAL
  • ExecutionType – DIRECT
  • Object includes RecurringPayinRegistrationId
OR
Sandbox-only: Unified Bank Wire PayInobject

A bank wire pay-in, either pre-declared to a Mangopay pooled account or received on a Virtual Account:

  • PaymentType – BANK_WIRE
  • ExecutionType – DIRECT or EXTERNAL_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;

OR
Bank Wire PayInobject

A direct bank wire pay-in:

  • PaymentType – BANK_WIRE
  • ExecutionType – DIRECT
OR
External Instruction Bank Wire PayInobject

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

  • PaymentType – BANK_WIRE
  • ExecutionType – EXTERNAL_INSTRUCTION
OR
Pay by Bank PayInobject

A Pay by Bank pay-in:

  • PaymentType – PAY_BY_BANK
  • ExecutionType – WEB
OR
Bancontact PayInobject

A Bancontact pay-in:

  • PaymentType – BCMC
  • ExecutionType – WEB
OR
Bizum PayInobject

A Bizum pay-in:

  • PaymentType – BIZUM
  • ExecutionType – WEB
OR
BLIK PayInobject

A BLIK pay-in:

  • PaymentType – BLIK
  • ExecutionType – WEB
OR
Giropay PayInobject

A Giropay pay-in:

  • PaymentType – GIROPAY
  • ExecutionType – WEB
OR
iDEAL PayInobject

An iDEAL pay-in:

  • PaymentType – IDEAL
  • ExecutionType – WEB
OR
Klarna PayInobject

A Klarna pay-in:

  • PaymentType – KLARNA
  • ExecutionType – WEB
OR
MB WAY PayInobject

An MB WAY pay-in:

  • PaymentType – MBWAY
  • ExecutionType – WEB
OR
Multibanco PayInobject

A Multibanco pay-in:

  • PaymentType – MULTIBANCO
  • ExecutionType – WEB
OR
Payconiq PayInobject

A Payconiq pay-in:

  • PaymentType – PAYCONIQ
  • ExecutionType – WEB
OR
Satispay PayInobject

A Satispay pay-in:

  • PaymentType – SATISPAY
  • ExecutionType – WEB
OR
Swish PayInobject

A Swish pay-in:

  • PaymentType – SWISH
  • ExecutionType – WEB
OR
TWINT PayInobject

A TWINT pay-in:

  • PaymentType – TWINT
  • ExecutionType – WEB
OR
Direct Debit PayInobject

A direct debit pay-in:

  • PaymentType – DIRECT_DEBIT
  • ExecutionType – DIRECT

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

OR
Web Direct Debit PayInobject

A web direct debit pay-in:

  • PaymentType – DIRECT_DEBIT
  • ExecutionType – WEB