POST
/
v2.01
/
{ClientId}
/
payins
/
directdebit
/
direct
{
    "AuthorId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
    "CreditedWalletId": "wlt_m_01J6EN9X1Q0PGM0CJ9QD197CRG",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1200
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 12
    },
    "Tag": "Created using the Mangopay API Postman collection",
    "MandateId": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
    "StatementDescriptor": "Example123"
}  

{
    "Id": "payin_m_01J9C36G3DYBNZEHVZ5HC7WB5D",
    "CreationDate": 1728056606,
    "AuthorId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
    "CreditedUserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
    "Status":"CREATED",
    "ExecutionDate": null,
    "ChargeDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01J6EN9X1Q0PGM0CJ9QD197CRG",
    "DebitedWalletId": null,
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1188
    },
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1200
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 12
    },
    "ResultCode": null,
    "ResultMessage": null,
    "PaymentType": "DIRECT_DEBIT",
    "ExecutionType": "DIRECT",
    "Tag": "Created using Mangopay API Postman Collection",
    "MandateId": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
    "StatementDescriptor": "Example123"
}

​
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 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.
​
MandateId
string
required
The unique identifier of the mandate.
​
StatementDescriptor
string
Max. length: SEPA: 100 characters, BACS: truncated after 10 characters; only alphanumeric and spacesCustom 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

​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
CreationDate
Unix 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, 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.
​
ChargeDate
Unix 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, but it depends on their bank. For more information on direct debit processing times, see the direct debit guide.
​
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.
​
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_WIREThe type of pay-in.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
Tag
string
Max. length: 255 charactersCustom 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 spacesCustom 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.
​
Id
string
Max length: 128 characters (see data formats for details)The unique identifier of the object.
​
CreationDate
Unix 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, 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.
​
ChargeDate
Unix 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, but it depends on their bank. For more information on direct debit processing times, see the direct debit guide.
​
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.
​
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_WIREThe type of pay-in.
​
ExecutionType
string
Returned values: WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.
​
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.
​
MandateId
string
The unique identifier of the mandate.
​
StatementDescriptor
string
Max. length: SEPA: 100 characters, BACS: truncated after 10 characters; only alphanumeric and spacesCustom 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.
{
    "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"
    }
}  

{
    "Id": "payin_m_01J9C36G3DYBNZEHVZ5HC7WB5D",
    "CreationDate": 1728056606,
    "AuthorId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
    "CreditedUserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
    "Status":"CREATED",
    "ExecutionDate": null,
    "ChargeDate": null,
    "Type": "PAYIN",
    "Nature": "REGULAR",
    "CreditedWalletId": "wlt_m_01J6EN9X1Q0PGM0CJ9QD197CRG",
    "DebitedWalletId": null,
    "CreditedFunds": {
        "Currency": "EUR",
        "Amount": 1188
    },
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1200
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 12
    },
    "ResultCode": null,
    "ResultMessage": null,
    "PaymentType": "DIRECT_DEBIT",
    "ExecutionType": "DIRECT",
    "Tag": "Created using Mangopay API Postman Collection",
    "MandateId": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
    "StatementDescriptor": "Example123"
}

{
    "AuthorId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
    "CreditedWalletId": "wlt_m_01J6EN9X1Q0PGM0CJ9QD197CRG",
    "DebitedFunds": {
        "Currency": "EUR",
        "Amount": 1200
    },
    "Fees": {
        "Currency": "EUR",
        "Amount": 12
    },
    "Tag": "Created using the Mangopay API Postman collection",
    "MandateId": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
    "StatementDescriptor": "Example123"
}