Create a Direct Debit PayIn

Body parameters

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.

CreditedWalletId

string

required

The unique identifier of the credited wallet.

DebitedFunds

object

required

Information about the debited funds.

Fees

object

required

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

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.

MandateId

string

required

The unique identifier of the mandate.

StatementDescriptor

string

Max. length: SEPA: 100 characters, BACS: truncated after 10 characters; only alphanumeric and spaces

Custom description to appear on the user’s bank statement along with the platform name. Different banks may show more or less information. See the Customizing bank statement references article for details.

Note: On BACS Direct Debit pay-ins, the length is truncated at 10 alphanumeric characters or spaces, but the technical limit is 100.

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

string

The unique identifier of the object.

CreationDate

timestamp

The date and time at which the object was created.

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.

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.

ChargeDate

timestamp

The date used to notify the user of the future charge, set at midnight (00:00) on the given day. The user’s account is usually debited the following day. For more information on direct debit processing times, see the direct debit guide.

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.

CreditedFunds

object

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

DebitedFunds

object

Information about the debited funds.

Fees

object

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

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.

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.

Tag

string

Max. length: 255 characters

Custom data that you can add to this object.

MandateId

string

The unique identifier of the mandate.

StatementDescriptor

string

Max. length: 10 characters; only alphanumeric and spaces

string

The unique identifier of the object.

CreationDate

timestamp

The date and time at which the object was created.

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.

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.

ChargeDate

timestamp

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.

CreditedFunds

object

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

DebitedFunds

object

Information about the debited funds.

Fees

object

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

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.

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.

Tag

string

Max. length: 255 characters

MandateId

string

The unique identifier of the mandate.

StatementDescriptor

string

Max. length: SEPA: 100 characters, BACS: truncated after 10 characters; only alphanumeric and spaces

Note: On BACS Direct Debit pay-ins, the length is truncated at 10 alphanumeric characters or spaces, but the technical limit is 100.

{
    "Message":"Error this mean of payment for this asked currency has been disabled",
    "Type":"disabled_mean_of_payment_for_currency",
    "Id":"2c4253ca-dd49-4092-8997-65b20b467b45#1663145348",
    "Date":1663145349.0,
    "errors":{
        "error":"The method payment DIRECT_DEBIT_GOCARDLESS with the ccy EUR is not active for the partner Sandboxtest"
    }
}  

{
    "Message": "One or several required parameters are missing or incorrect. An incorrect resource ID also raises this kind of error.",
    "Type": "param_error",
    "Id": "24e0f9e1-7f37-4a8b-b644-873cabc4ee97",
    "Date": 1695374496.0,
    "errors": {
        "StatementDescriptor": "This field is only available for Mandates with the Scheme 'SEPA'"
    }
}  

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

Create a Direct Debit PayIn

Body parameters

Responses

Overview

User management

User verification

Wallets

Cards

Card pay-ins

Banking pay-ins

APM pay-ins

Transfers

Refunds

Disputes

Payouts

FX conversions

Transactions

Helpers

Platform account

​Body parameters

​Responses

Body parameters

Responses