The Direct Debit PayIn object
Description
The Direct Debit PayIn object represents a pay-in via an available direct debit scheme: SDD or Bacs, as determined by the user’s bank account country. Once the bank account is registered as a Recipient, a Mandate object can be created against it. Once the Mandate is confirmed by the user and submitted by Mangopay to their bank, the pay-in can be requested. Read more about direct debit →
Attributes
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.
Default value: The unique identifier of the owner of the credited wallet.
The unique identifier of the user whose wallet is credited.
Information about the Owner beneficiaries targeted by the pay-in and its subsequent transfers, who must all be KYC/KYB verified when the pay-in request is made (read more).
If the FlowDescriptor.Beneficiaries is sent in the API request, then:
- The transaction’s
CreditedWalletIdholder is disregarded in KYC/KYB checks. - ALL
UserIdvalues in the array must be one of:OWNERwhoseKYCLevelisREGULARPLATFORM
The pay-in Status becomes FAILED with ResultCode 002951 if at least one FlowDescriptor.Beneficiaries.UserId is:
PAYEROWNERwhoseKYCLevelisLIGHT
If the FlowDescriptor.Beneficiaries is not sent in the API request, then the CreditedWalletId holder is subject to KYC/KYB checks. This property is optional for backwards compatibility but is recommended for all pay-in flows, even when the CreditedWalletId holder is a PAYER or the same value as one of the FlowDescriptor.Beneficiaries.
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 direct debit 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 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).
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
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.
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.