Direct debits
List Mandates for a User
Overview
User management
- Users
- User regulatory status
- User e-money
User verification
- User data format
- KYC documents
- UBO declarations
Wallets
- User wallets
- Client wallets
Cards
- Card registrations
- Cards
- Metadata
- Card validations
Card pay-ins
- Direct card pay-ins
- Recurring card pay-ins
- Preauthorizations
- Deposit preauthorizations
- Web card pay-ins
Banking pay-ins
APM pay-ins
- Apple Pay
- Bancontact
- BLIK
- Giropay
- Google Pay
- iDEAL
- Klarna
- MB WAY
- Multibanco
- Payconiq
- PayPal
- Satispay
Transfers
- Transfers
Refunds
- Refunds
Disputes
- Disputes
- Dispute documents
- Repudiations
- Dispute settlement
Payouts
- Bank accounts
- Payouts
FX conversions
- Conversion rates
- Quotes
- Conversions
Transactions
- Transactions
Helpers
- API responses
- Country authorizations
- Webhooks
- Events
- Reports
Platform account
- Client
- Dashboard permissions
Direct debits
List Mandates for a User
GET
/
v2.01
/
{ClientId}
/
users
/
{UserId}
/
mandates
Path parameters
UserId
string
requiredThe unique identifier of the user.
Responses
Array (Mandates)
array
The list of mandates created by the platform.
Object (Mandate)
object
The mandate created by the platform.
Id
string
The unique identifier of the object.
CreationDate
timestamp
The date and time at which the object was created.
Status
string
Returned values: CREATED
, SUBMITTED
, ACTIVE
, FAILED
, EXPIRED
The status of the mandate:
CREATED
– The mandate has been generated but not yet confirmed.SUBMITTED
– The mandate has been confirmed and sent to the user’s bank, and can be used to request a direct debit pay-in.ACTIVE
– The mandate has been accepted by the user’s bank or successfully used to process a direct debit direct pay-in. Further pay-ins can be requested.FAILED
– The mandate has been canceled or otherwise failed, and can no longer be used for payments.EXPIRED
– No payment has been made against the mandate in the last 24 months. It can no longer be used for payments.
UserId
string
The unique identifier of the User (natural or legal) who owns the bank account.
ExecutionType
string
Returned values: WEB
The execution type of the mandate.
Tag
string
Max. length: 255 characters
Custom data that you can add to this object.
ResultCode
string
The code indicating the result of the operation. This information is mostly used to handle errors or for filtering purposes.
Was this page helpful?