Create a Web Direct-Debit PayIn

Warning – Giropay no longer available after June 30, 2024

Giropay’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. 

Body parameters

DirectDebitType

string

required

Allowed values: GIROPAY, SOFORT

The type of direct debit.

Tag

string

Max. length: 255 characters

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

AuthorId

string

required

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

required

Information about the debited funds.

Show properties

Currency

string

required

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the debited funds.

Amount

integer

required

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Fees

object

required

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

Show properties

Currency

string

required

Allowed values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the fees.

Amount

integer

required

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

CreditedWalletId

string

required

The unique identifier of the credited wallet.

ReturnURL

string

required

Max. length: 220 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

TemplateURLOptions

object

The URL of the SSL page of your customized payment page. The page must be in the array format (“PAYLINE”=>“https://…”) and meet all the specifications listed here. Only a template for Payline is currently available. 

Show properties

PaylineV2

string

Required if the TemplateURLOptions is sent.

The URL of the corresponding V2 template with the Payline Javascript Widget.

Culture

string

required

Allowed values: One of the supported languages in the ISO 639-1 format: CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.

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.

Responses

200

DirectDebitType

string

Returned values: GIROPAY, SOFORT

The type of direct debit.

Id

string

The unique identifier of the object.

Tag

string

Max. length: 255 characters

Custom 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

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.

Show properties

Currency

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the debited funds.

Amount

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

CreditedFunds

object

Information about the credited funds (CreditedFunds = DebitedFunds - Fees).

Show properties

Currency

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the credited funds.

Amount

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Fees

object

Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).

Show properties

Currency

string

Returned values: The three-letter ISO 4217 code (EUR, GBP, etc.) of a supported currency (depends on feature, contract, and activation settings).

The currency of the fees.

Amount

integer

An amount of money in the smallest sub-division of the currency (e.g., EUR 12.60 would be represented as 1260 whereas JPY 12 would be represented as just 12).

Status

string

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ExecutionDate

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, PAYOUT

The type of the transaction.

Nature

string

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.

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_WIRE

The type of pay-in.

ExecutionType

string

Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTION

The 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 characters

The URL to which the user is returned after the payment, whether the transaction is successful or not.

TemplateURL

string

The URL used for the payment page template.

Culture

string

Returned values: One of the supported languages in the ISO 639-1 format: CS, DA, DE, EL, EN, ES, FI, FR, HU, IT, NL, NO, PL, PT, SK, SV.

The language in which the payment page is to be displayed.