Direct debits
Create a Direct Debit PayIn
POST
Body parameters
The unique identifier of the user at the source of the transaction.
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
The unique identifier of the credited wallet.
Information about the debited funds.
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
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.
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.
The unique identifier of the mandate.
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.
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
200
Max length: 128 characters (see data formats for details)The unique identifier of the object.
The date and time at which the object was created.
The unique identifier of the user at the source of the transaction.
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
Returned values:
CREATED, SUCCEEDED, FAILEDThe status of the transaction.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.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.
Returned values:
PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.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.
The unique identifier of the credited wallet.
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.Information about the credited funds (
CreditedFunds = DebitedFunds - Fees).Information about the debited funds.
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
Returned values:
CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.Returned values:
WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.Max. length: 255 charactersCustom data that you can add to this object.
The unique identifier of the mandate.
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.
200 - Failed due to invalid mandate status
200 - Failed due to invalid mandate status
Max length: 128 characters (see data formats for details)The unique identifier of the object.
The date and time at which the object was created.
The unique identifier of the user at the source of the transaction.
Default value: The unique identifier of the owner of the credited wallet.The unique identifier of the user whose wallet is credited.
Returned values:
CREATED, SUCCEEDED, FAILEDThe status of the transaction.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.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.
Returned values:
PAYIN, TRANSFER, CONVERSION, PAYOUTThe type of the transaction.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.
The unique identifier of the credited wallet.
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.Information about the credited funds (
CreditedFunds = DebitedFunds - Fees).Information about the debited funds.
Information about the fees taken by the platform for this transaction (and hence transferred to the Fees Wallet).
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
The explanation of the result code.
Returned values:
CARD, DIRECT_DEBIT, PREAUTHORIZED, BANK_WIREThe type of pay-in.Returned values:
WEB, DIRECT, EXTERNAL_INSTRUCTIONThe type of execution for the pay-in.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.
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.
The unique identifier of the mandate.
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.
400 - Payment method not activated
400 - Payment method not activated