List all Mandates - Mangopay docs

const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

const listMandates = async () => {
  return await mangopay.Mandates.getAll()
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

listMandates()  

[
    {
        "Id": "mdt_m_01J98YZT8AJBGWX47AA077XMKZ",
        "CreationDate": 1663244376,
        "Status": "FAILED",
        "UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
        "ExecutionType": "WEB",
        "MandateType": "DIRECT_DEBIT",
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "001807",
        "ResultMessage": "User has let the mandate session expire without confirming"
    },
    {
        "Id": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
        "CreationDate": 1669040333,
        "Status": "ACTIVE",
        "UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
        "ExecutionType": "WEB",
        "MandateType": "DIRECT_DEBIT",
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "000000",
        "ResultMessage": "Success"
    }
]  

GET

v2.01

{ClientId}

mandates

const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

const listMandates = async () => {
  return await mangopay.Mandates.getAll()
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

listMandates()  

[
    {
        "Id": "mdt_m_01J98YZT8AJBGWX47AA077XMKZ",
        "CreationDate": 1663244376,
        "Status": "FAILED",
        "UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
        "ExecutionType": "WEB",
        "MandateType": "DIRECT_DEBIT",
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "001807",
        "ResultMessage": "User has let the mandate session expire without confirming"
    },
    {
        "Id": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
        "CreationDate": 1669040333,
        "Status": "ACTIVE",
        "UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
        "ExecutionType": "WEB",
        "MandateType": "DIRECT_DEBIT",
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "000000",
        "ResultMessage": "Success"
    }
]  

Query parameters

BeforeDate

Unix timestamp

The date before which the object was created (based on the object’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

AfterDate

Unix timestamp

The date after which the object was created (based on the object’s CreationDate parameter). You can filter on a specific time range by using both the AfterDate and BeforeDate query parameters.

Path parameters

MandateId

string

required

The unique identifier of the mandate.

Responses

200

Array (Mandates)

array

The list of mandates created by the platform.

Show properties

Object (Mandate)

object

The mandate created by the platform.

Show properties

string

Max length: 128 characters (see data formats for details)The unique identifier of the object.

CreationDate

Unix timestamp

The date and time at which the object was created.

Status

string

Returned values: CREATED, SUBMITTED, ACTIVE, FAILED, EXPIREDThe 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: WEBThe execution type of the mandate.

Tag

string

Max. length: 255 charactersCustom 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.

[
    {
        "Id": "mdt_m_01J98YZT8AJBGWX47AA077XMKZ",
        "CreationDate": 1663244376,
        "Status": "FAILED",
        "UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
        "ExecutionType": "WEB",
        "MandateType": "DIRECT_DEBIT",
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "001807",
        "ResultMessage": "User has let the mandate session expire without confirming"
    },
    {
        "Id": "mdt_m_01J999B9HSEDH9CZDEXXYZGHEZ",
        "CreationDate": 1669040333,
        "Status": "ACTIVE",
        "UserId": "user_m_01J8SY95DQ5CM7DH43NQCAS65T",
        "ExecutionType": "WEB",
        "MandateType": "DIRECT_DEBIT",
        "Tag": "Created using the Mangopay API Postman collection",
        "ResultCode": "000000",
        "ResultMessage": "Success"
    }
]  

const mangopayInstance = require('mangopay4-nodejs-sdk')
const mangopay = new mangopayInstance({
  clientId: 'your-client-id',
  clientApiKey: 'your-api-key',
})

const listMandates = async () => {
  return await mangopay.Mandates.getAll()
    .then((response) => {
      console.info(response)
      return response
    })
    .catch((err) => {
      console.log(err)
      return false
    })
}

listMandates()  

View a Mandate List Mandates for a User

⌘I

Documentation Index

​Query parameters

​Path parameters

​Responses

Query parameters

Path parameters

Responses