Create a Direct Debit PayIn

POST

/v2.01/:ClientId/payins/directdebit/direct

POST

/v2.01/:ClientId/payins/directdebit/direct

$ curl -X POST https://api.sandbox.mangopay.com/v2.01/ClientId/payins/directdebit/direct \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "body": {
>     "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"
>   }
> }'

1 {
2   "Id": "payin_m_01J9C36G3DYBNZEHVZ5HC7WB5D",
3   "CreationDate": 1728056606,
4   "AuthorId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
5   "CreditedUserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
6   "Status": "CREATED",
7   "ExecutionDate": null,
8   "ChargeDate": null,
9   "Type": "PAYIN",
10   "Nature": "REGULAR",
11   "CreditedWalletId": "wlt_m_01J6EN9X1Q0PGM0CJ9QD197CRG",
12   "DebitedWalletId": null,
13   "CreditedFunds": {
14     "Currency": "EUR",
15     "Amount": 1188
16   },
17   "DebitedFunds": {
18     "Currency": "EUR",
19     "Amount": 1200
20   },
21   "Fees": {
22     "Currency": "EUR",
23     "Amount": 12
24   },
25   "ResultCode": null,
26   "ResultMessage": null,
27   "PaymentType": "DIRECT_DEBIT",
28   "ExecutionType": "DIRECT",
29   "Tag": "Created using Mangopay API Postman Collection",
30   "MandateId": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
31   "StatementDescriptor": "Example123"
32 }

Create a Direct Debit PayIn

Authentication

AuthorizationBearer

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.

Bearer authentication of the form `Bearer <token>`, where token is your auth token. If your platform is using a [proxy](/guides/sca/proxy-management) to take SCA-triggering action on behalf of users, you also need to integrate [mTLS authentication](/guides/sca/platform) and use the `api-mtls` base URL.

Path parameters

ClientIdstringRequired

Platform's API account identifier, associated with the API key.

Request

This endpoint expects an object.

AuthorIdstringRequired

The unique identifier of the user at the source of the transaction.

CreditedWalletIdstringRequired

The unique identifier of the credited wallet.

DebitedFundsobjectRequired

Information about the debited funds.

FeesobjectRequired

Information about the fees.

MandateIdstringRequired

The unique identifier of the mandate.

CreditedUserIdstringOptional

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

TagstringOptional

Max. length: 255 characters

Custom data that you can add to this object.

StatementDescriptorstringOptional

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.

ProfilingAttemptReferencestringOptional

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.

Response

Success

Idstring

Max length: 128 characters (see data formats for details)

The unique identifier of the object.

CreationDateinteger

Unix timestamp (UTC) of the date and time the object was created.

AuthorIdstring

The unique identifier of the user at the source of the transaction.

CreditedUserIdstring

Default value: The unique identifier of the owner of the credited wallet.

The unique identifier of the user whose wallet is credited.

Statusstring

Returned values: CREATED, SUCCEEDED, FAILED

The status of the transaction.

ExecutionDateinteger

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.

ChargeDateinteger

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.

Typestring

Returned values: PAYIN, TRANSFER, CONVERSION, PAYOUT

The type of the transaction.

Naturestring

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.

CreditedWalletIdstring

The unique identifier of the credited wallet.

DebitedWalletIdstring

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.

CreditedFundsobject

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

DebitedFundsobject

Information about the debited funds.

Feesobject

Information about the fees.

ResultCodestring

The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.

ResultMessagestring

The explanation of the result code.

PaymentTypestring

Returned values: DIRECT_DEBIT

The payment type of the pay-in.

ExecutionTypestring

Returned values: DIRECT

The execution type of the pay-in.

Tagstring

Max. length: 255 characters

Custom data that you can add to this object.

MandateIdstring

The unique identifier of the mandate.

StatementDescriptorstring

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.

Errors

400

Bad Request Error