Warning – Giropay no longer available after June 30, 2024Giropay’s operator Paydirekt has decided to cease the payment method’s services at the end of June, without providing a direct alternative. This decision by Paydirekt impacts the entire industry and is beyond our control.Effective July 1, 2024: 
  • Pay-ins will fail with the 101101 error
  • Refunds will be possible for one year 
This change affects both the new integration and this legacy one.Our team is ready to assist you with your integration of alternatives like Klarna, PayPal, or virtual IBANs for the German market. Please reach out via the Dashboard
Caution – Sofort no longer available after June 1, 2024These endpoints are the legacy integration of Sofort with Mangopay (DirectDebitType is SOFORT).As of June 1, 2024, the Sofort payment method was no longer available with Mangopay. Klarna acquired deprecated the Sofort brand and technical solution.Platforms looking for Sofort are invited to integrate Klarna.

Attributes

DirectDebitType
string
Allowed values: GIROPAY, SOFORTThe type of direct debit.
Id
string
The unique identifier of the object.
Tag
string
Max. length: 255 charactersCustom data that you can add to this object.
For transactions (pay-in, transfer, payout), you can use this parameter to identify corresponding information regarding the user, transaction, or payment methods on your platform.
CreationDate
Unix timestamp
The date and time at which the object was created.
ResultCode
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
ResultMessage
string
The explanation of the result code.
AuthorId
string
The unique identifier of the user at the source of the transaction.
CreditedUserId
string
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
DebitedFunds
object
Information about the debited funds.
CreditedFunds
object
Information about the credited funds (CreditedFunds = DebitedFunds - Fees).
Fees
object
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
Status
string
Returned values: CREATED, SUCCEEDED, FAILEDThe status of the transaction.
ExecutionDate
Unix timestamp
The date and time at which the status changed to SUCCEEDED, indicating that the transaction occurred. The statuses CREATED and FAILED return an ExecutionDate of null.
Type
string
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.
Nature
string
Returned values: REGULAR, REPUDIATION, REFUND, SETTLEMENTThe 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.
CreditedWalletId
string
The unique identifier of the credited wallet.
DebitedWalletId
string
The unique identifier of the debited wallet.In the case of a pay-in, this value is always null since there is no debited wallet.
PaymentType
string
Returned values: CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
RedirectURL
string
The URL to which to redirect the user to complete the payment.Caution: This variable URL is specific to each payment. You must rely on the returned URL in full (host, path, and queries) and not hardcode any part of it.
ReturnURL
string
Max. length: 220 charactersThe URL to which the user is returned after the payment, whether the transaction is successful or not.
TemplateURLOptions
object
deprecated
Caution: This customization feature is deprecated and must no longer be used.The URL of the SSL page of your customized payment page.
TemplateURL
string
deprecated
Caution: This customization feature is deprecated and must no longer be used. You must redirect on the RedirectURL instead.The customized URL to which to redirect the user to complete the payment.
Culture
string
The language in which the payment page is to be displayed.
ProfilingAttemptReference
string
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.