v2
latestOpenAPI 3.1.02026-07-262279731.3 MBCreate a Direct Debit PayIn
Create a Direct Debit PayIn
Path parameters
Platform's API account identifier, associated with the API key.
Headers
Bearer authentication of the form Bearer <token>, where token is your auth token.
If your platform is using a proxy to take SCA-triggering action on behalf of users, you also need to integrate mTLS authentication and use the api-mtls base URL.
Request body
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.
Max. length: 255 characters
Custom data that you can add to this object.
The unique identifier of the mandate.
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 <a href="/bank-statements">Customizing bank statement references</a> 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 <a href="/guides/fraud-prevention">fraud prevention</a> 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 <a href="https://hub.mangopay.com/" target="_blank">via the Dashboard</a> for more information.
Response
Success
Max length: 128 characters (see data formats for details)
The unique identifier of the object.
Unix timestamp (UTC) of the date and time 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, FAILED
The status of the transaction.
Unix timestamp (UTC) of the date and time 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 <a href="/guides/payment-methods/banking/direct-debit">direct debit</a> guide.
Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT
The type of the transaction.
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.
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.
The code indicating the result of the operation. This information is mostly used to <a href="/errors/codes">handle errors</a> or for filtering purposes.
The explanation of the result code.
Returned values: DIRECT_DEBIT
The payment type of the pay-in.
Returned values: DIRECT
The execution type of the pay-in.
Max. length: 255 characters
Custom data that you can add to this object.
The unique identifier of the mandate.
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 <a href="/bank-statements">Customizing bank statement references</a> 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.