Corporate
Collections - Direct Debits
Collections - Direct Debits

Description

These APIs provide services that enable businesses to receive payments from their customers efficiently. They are used to manage receivables and streamline the inflow of funds into a corporate account.

In order to subscribe, Please

  • Overview
  • APIs Offered
    Collection Fetch And Inquire API

    This API enables clients to fetch the details of collection requests initiated by clients and supports real-time inquiries to verify the status, reference details, and settlement updates of those requests.

    Collection Fetch And Inquire API
    View API Specifications

    This API enables clients to fetch the details of collection requests initiated by clients and supports real-time inquiries to verify the status, reference details, and settlement updates of those requests.

    NOTE:

    • Applications must get the token using the “Get Token API," which will provide the access token details. This token must be used for the subsequent interactions of RESTful APIs. Tokens will be valid for 180s

    Flow Chart

    Image
    Flow Chart Collection Fetch And Inquiry API

    What operations can be performed?

    1. collectionFetchAndInquiry: This is a POST method that allows the clients to fetch details and inquiry about the previously initiated collection request..

    Request Headers:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    clientId
    Unique client ID provided by Mashreq to corporate.
    Mandatory
    STRING
     
     
    batchId
    If there is only one transaction batchId becomes optional, you can also pass one transaction with batch details.
    Conditional Mandatory
    STRING
    Min 1 - Max 16
     
    batchCount
    If there is only one transaction batchCount becomes optional, you can also pass one transaction with batch details.
    Conditional Mandatory
    STRING
    Min 0 - Max 1000
     
    Authorization
    Bearer Token received from get token API with respect to Scope
    Mandatory
    STRING
     
     

    Request Parameters:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    channelCode
    Sender channel code defined for eCollect.
    Optional
    STRING
    Max 20
    CBK
    customerCode
    Corporate Customer Code defined by eCollect during customer onboarding
    Optional
    STRING
    Max 20
    10150935
    eventType
    Type of event
    Mandatory
    STRING
    Max 10
    New
    lang
    Language Code.
    Mandatory
    STRING
    Max 3
    EN (English) AR (Arabic)
    requestDateTime
    Service Request initiated date & time.
    Mandatory
    STRING
    Max 30
    30092021000000 (YYYYMMDDHHMMSS)
    requestId
    Unique Request Id generated by customer EPR for every API Request.
    Mandatory
    STRING
    Max 50
    1234567891
    serviceCode
    Unique service code defined by eCollect for each service
    Mandatory
    STRING
    Max 10
    SVC111
    serviceName
    Unique Service Name defined by eCollect for each service
    Mandatory
    STRING
    Max 30
    COLLECTION_FET1
    filterInfo
    This block contains filter details
    Mandatory
    JSON
     
     
    id
    Fetch based on customer reference number associated with one collection
    Optional
    STRING
     
     
    fromCore
    Flag to fetch from core application rather than the interfacing application
    Optional
    STRING
    1
    Y - Yes N - No
    referenceNumber
    This block contains reference number related details
    Mandatory
    JSON
     
     
    type
    Fetch based on the reference number returned during initial response for the collection request
    Optional
    STRING
    3
    CHN - channel reference number COR - core reference number
    value
    Value of the reference number
    Optional
    STRING
     
     
    multiFetchInfo
    This block contains multi fetch information
    Optional
    JSON
     
     
    all
    Flag to fetch entire list of the Collections.
    Optional
    STRING
    1
    Y - Yes N - No
    detailsRequired
    Flag to fetch only entire details or just ids. This field works with "all" field.
    Optional
    STRING
    1
    Y - Yes N - No
    status
    Flag to fetch DDAs based on the status. Values can be provided as an array. This field works with "all" field.
    Optional
    ARRAY
     
    S - Success E - Failed P - Pending
    id
    This block contains ID related information
    Optional
    JSON
     
     
    type
    Fetch based on the grouping elements such as CIC etc. during initial response
    Optional
    STRING
    Max 10
    CIC - originator identification code DDA - DDA reference number
    value
    Value of ID
    Optional
    STRING
     
     
    dateFilterInfo
    This block contains date filter information
    Optional
    JSON
     
     
    fromDate
    Date range start date. Date is the Collection request date
    Optional
    STRING
    Max 20
    dd-MM-yyyy
    toDate
    Date range end date. Date is the Collection request date
    Optional
    STRING
    Max 20
    dd-MM-yyyy
    paginationInfo
    This block contains pagination settings
    Optional
    JSON
     
     
    pageNumber
    Page number for the paginated response
    Optional
    STRING
     
    Defaulted to 0
    pageSize
    Number of records in a page
    Optional
    STRING
     
    Defaulted to 10
    sortInfo
    This block containing sorting related details
    Optional
    JSON
     
     
    sortBy
    Sort the entire result set in a specific order by a field. Please note each page would not be sorted instead the entire result set is sorted
    Optional
    STRING
    1
    D - DATE A - AMOUNT (CLAIMED AMOUNT) Defaulted to D
    sortOrder
    Sorting order of the elements
    Optional
    STRING
    3
    ASC - Ascending Order DSC - Descending Order
    additionalInfo
    Contains additional information fields
    Optional
    JSON
     
     
    additionalField
    Additional information to be added as part of audit for the bank or for channel or operations of the originator
    Optional
    STRING
     
    ADD1

    Response Parameters:

    Fields
    Description
    Mandatory/Optional
    Data type
    Length
    Sample value
    responseMessage
    This block contains response message data
    Optional
    STRING
     
     
    channelCode
    Sender channel code defined for eCollect
    Optional
    STRING
    Max 20
    CBK
    customerCode
    Corporate Customer Code defined by eCollect during customer onboarding
    Optional
    STRING
    Max 20
    10150935
    eventType
    Type of event
    Mandatory
    STRING
    Max 10
    NEW UPDATE
    lang
    Language Code.
    Mandatory
    STRING
    Max 3
    en (English) ar (Arabic)
    requestDateTime
    Service Request initiated date & time.
    Mandatory
    STRING
    Max 30
    30092021000000 (YYYYMMDDHHMMSS)
    requestId
    Unique Request Id generated by customer EPR for every API Request.
    Mandatory
    STRING
    Max 50
    1234567891
    serviceCode
    Unique Service Code defined by eCollect for each service
    Mandatory
    STRING
    Max 10
    SVC111
    serviceName
    Unique Service Name defined by eCollect for each service
    Mandatory
    STRING
    Max 30
    COLLECTION_REQ1
    serviceStatusCode
    Status code at service level indicating whether the API call was successfully initiated.
    Optional
    STRING
    1
    S
    serviceStatusDesc
    Detailed status description
    Optional
    STRING
    Max 100
    Success
    channelReferenceNumber
    Reference number generated by transact.DigiTB application
    Mandatory
    STRING
    Max 35
    DDA202505292260009975
    coreReferenceNumber
    Reference number generated by core banking system
    Optional
    STRING
    Max 50
     
    collectionList
    This block contains list of collections details.
    Mandatory
    ARRAY of JSON
     
     
    currency
    ISO 3 Character currency code
    Optional
    STRING
    3
    Always defaulted to AED for UAEDDS
    claimedAmount
    Amount claimed for the given collection request
    Mandatory
    STRING
     
     
    ddaReferenceNumber
    DDA reference number for which the collection is initiated
    Mandatory
    STRING
    Max 23
     
    payingBankRoutingCode
    Paying bank routing code
    Optional
    STRING
    3
     
    payerIBAN
    Payer IBAN which would be debited for the mentioned collection.
    Optional
    STRING
    Max 23
     
    customerReferenceNumber
    Customer reference number associated with each collection record.
    Optional
    STRING
    Max 35
     
    originatorAccountNumber
    Collection account number associated with OIC (Originator Identification Code)
    Optional
    STRING
    Max 15
     
    remarks
    Remarks for the given collection. Only last remarks would be provided.
    Optional
    STRING
    Max 100
    Test Collection Fetch
    collectionStatus
    Block containing collection status details
    Mandatory
    JSON
     
     
    code
    Status code for collection request
    Mandatory
    STRING
    1
    S - Success - PAID F - Failure - NO PAY P - Pending
    description
    Description corresponding to collection status code returned
    Mandatory
    STRING
    Max 100
     
    remarks
    Additional information enriching the collection status response
    Optional
    STRING
    Max 150
     
    collectionRequestDate
    Date when the collection was initially requested
    Mandatory
    STRING
    Max 12
    dd-MM-YYYY
    collectionProcessingDate
    Last processing date based on the response from central bank
    Mandatory
    STRING
    Max 12
    dd-MM-YYYY
    collectionInitiatedBy
    Audit for the Last entity initiating the collection
    Mandatory
    STRING
    3
    CUS - Customer SYS - System
    retrialCount
    Count of retry attempts
    Mandatory
    STRING
    Max 1
     
    uniqueReferenceNumber
    System generated unique reference number per collection records
    Mandatory
    STRING
    Max 21
     
    narration
    If the collection is successful then narration of the account posting
    Mandatory
    STRING
    Max 200
     
    status
    Block containing status details
    Mandatory
    STRING
     
     
    code
    Status code at request level whether the request call was successfully processed
    Mandatory
    STRING
    Max 3
     
    description
    Description corresponding to status code returned
    Mandatory
    STRING
    Max 100
     
    remarks
    Additional information enriching the status response
    Optional
    STRING
    Min 150
     
    additionalInfo
    Contains additional information fields
    Optional
    STRING
     
     
    additionalField
    Additional information to be added as part of audit for the bank or for channel or operations of the originator
    Optional
    STRING
     
     

    Status Code Information:

    Status
    Status Code
    Description
    Success
    200
    Collection Request is Pending
    Bad Request
    400
    Request Type should not be empty
     
    400
    Provided Request Type is invalid
     
    400
    Originator Identification Code should not be empty
     
    400
    Originator Identification Code is invalid.
     
    400
    Corporate Identification Code should not be empty
     
    400
    Originator Identification Code is invalid.
     
    400
    Corporate Identification Code is invalid
     
    400
    Originator Identification Code is invalid.
     
    400
    Payer Identification should be 81 character.
     
    400
    Customer Type should not be empty
     
    400
    Customer Type is Invalid
     
    400
    IBAN / Card Number is Invalid
     
    400
    Currency Code should be AED
     
    400
    Currency Code should be equal to 3 characters.
     
    400
    Currency Code should not be empty
     
    400
    Mobile Number should be 9 digit with country code
     
    400
    Customer reference number already exists
    IMPORTANTS NOTES:
    • This API is used to inquire about the status of previously initiated collection request.
    • This is a bulk API and supports batch request processing.
    • The “collectionStatus” indicates the status of previously initiated collection request and “status” indicates whether the API call is successful or not.
    View API Specifications
    Collection Request API

    This API allows clients to initiate, track, and manage payment collection requests from customers.

    Collection Request API
    View API Specifications

    This API allows clients to initiate, track, and manage payment collection requests from customers.

    NOTE:

    • Applications must get the token using the “Get Token API," which will provide the access token details. This token must be used for the subsequent interactions of RESTful APIs. Tokens will be valid for 180s

    Flow Chart

    Image
    Flow Chart Collection Request API

    What operations can be performed?

    1. collectionRequest: This is a POST method that allows the clients to initiate, track, and manage payment collection requests from customers.

    Request Headers:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    clientId
    Unique client ID provided by Mashreq to corporate.
    Mandatory
    STRING
     
     
    batchId
    If there is only one transaction batchId becomes optional, you can also pass one transaction with batch details.
    Conditional Mandatory
    STRING
    Min 1 - Max 16
     
    batchCount
    If there is only one transaction batchCount becomes optional, you can also pass one transaction with batch details.
    Conditional Mandatory
    STRING
    Min 0 - Max 1000
     
    Authorization
    Bearer Token received from get token API with respect to Scope
    Mandatory
    STRING
     
     

    Request Parameters:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    channelCode
    Sender channel code defined for eCollect.
    Optional
    STRING
    Max 20
    CBK
    customerCode
    Corporate Customer Code defined by eCollect during customer onboarding
    Optional
    STRING
    Max 20
    10150935
    eventType
    Type of event.
    Mandatory
    STRING
    Max 10
    New
    lang
    Language Code.
    Mandatory
    STRING
    Max 3
    en (English) ar (Arabic)
    requestDateTime
    Service Request initiated date & time.
    Mandatory
    STRING
    Max 30
    30092021000000 (YYYYMMDDHHMMSS)
    requestId
    Unique Request Id generated by customer EPR for every API Request.
    Mandatory
    STRING
    Max 50
    1234567891
    serviceCode
    Unique service code defined by eCollect for each service
    Mandatory
    STRING
    Max 10
    SVC111
    serviceName
    Unique Service Name defined by eCollect for each service
    Mandatory
    STRING
    Max 30
    COLLECTION_REQ1
    collectionList
    This block contains list of collections details.
    Mandatory
    ARRAY of JSON
     
     
    currency
    ISO 3 Character currency code
    Optional
    STRING
    3
    AED
    claimedAmount
    Amount claimed for the given collection request
    Mandatory
    STRING
     
     
    ddaReferenceNumber
    DDA reference number for which the collection is initiated
    Mandatory
    STRING
    Max 23
     
    payingBankRoutingCode
    Paying bank routing code
    Optional
    STRING
    3
     
    payerIBAN
    Payer IBAN which would be debited for the mentioned collection.
    Optional
    STRING
    Max 23
     
    customerReferenceNumber
    Customer reference number associated with each collection record.
    Optional
    STRING
    Max 35
     
    originatorAccountNumber
    Collection account number associated with OIC (Originator Identification Code).
    Optional
    STRING
    Max 15
     
    remarks
    Remarks for the given collection. Only last remarks would be provided.
    Optional
    STRING
    Max 100
    Test Collection Req
    additionalInfo
    Contains additional information fields
    Optional
    JSON
     
     
    additionalField
    Additional information to be added as part of audit for the bank or for channel or operations of the originator
    Optional
    STRING
    Max 100
    ADD1

    Response Parameters:

    Fields
    Description
    Mandatory/Optional
    Data type
    Length
    Sample value
    responseMessage
    This block contains response message data
    Optional
    STRING
     
     
    channelCode
    Sender channel code defined for eCollect.
    Optional
    STRING
    Max 20
    CBK
    customerCode
    Corporate Customer Code defined by eCollect during customer onboarding
    Optional
    STRING
    Max 20
    10150935
    eventType
    Type of event
    Mandatory
    STRING
    Max 10
    New
    lang
    Language Code.
    Mandatory
    STRING
    Max 3
    en (English) ar (Arabic)
    requestDateTime
    Service Request initiated date & time.
    Mandatory
    STRING
    Max 30
    30092021000000 (YYYYMMDDHHMMSS)
    requestId
    Unique Request Id generated by customer EPR for every API Request.
    Mandatory
    STRING
    Max 50
    1234567891
    serviceCode
    Unique Service Code defined by eCollect for each service
    Mandatory
    STRING
    Max 10
    SVC111
    serviceName
    Unique Service Name defined by eCollect for each service
    Mandatory
    STRING
    Max 30
    COLLECTION_REQ1
    serviceStatusCode
    Status code at service level indicating whether the API call was successfully initiated.
    Optional
    STRING
    1
    S
    serviceStatusDesc.
    Detailed status description
    Optional
    STRING
    Max 100
    Success
    channelReferenceNumber
    Reference number generated by transact.DigiTB application
    Mandatory
    STRING
    Max 35
    DDA202505292260009975
    coreReferenceNumber
    Reference number generated by core banking system
    Optional
    STRING
    Max 50
     
    status
    Block containing status details
    Mandatory
    STRING
    Min 7
    1475033
    code
    Status code at request level whether the request call was successfully processed
    Mandatory
    STRING
    3
    109
    description
    Description corresponding to status code returned
    Mandatory
    STRING
    Max 100
     
    remarks
    Additional information enriching the status response
    Optional
    STRING
    Max 150
     
    additionalInfo
    Contains additional information fields
    Optional
    JSON
     
     
    additionalField
    Additional information to be added as part of audit for the bank or for channel or operations of the originator
    Optional
    STRING
    Max 100
     

    Status Code Information:

    Status
    Status Code
    Description
    Success
    200
    Collection Request Initiated
    Rejected
    400
    Request Type should not be empty
     
    400
    Provided Request Type is invalid
     
    400
    Originator Identification Code should not be empty
     
    400
    Originator Identification Code is invalid.
     
    400
    Corporate Identification Code should not be empty
     
    400
    Originator Identification Code is invalid.
     
    400
    Corporate Identification Code is invalid
     
    400
    Originator Identification Code is invalid.
     
    400
    Payer Identification should be 81 character.
     
    400
    Customer Type should not be empty
     
    400
    Customer Type is Invalid
     
    400
    IBAN / Card Number is Invalid
     
    400
    Currency Code should be AED
     
    400
    Currency Code should be equal to 3 characters.
     
    400
    Currency Code should not be empty
     
    400
    Mobile Number should be 9 digit with country code
     
    400
    Customer reference number already exists
    IMPORTANTS NOTES:
    • This API is used to initiate payment collection from customers.
    • This is a bulk API and supports batch request processing.
    • This API provides detailed response for the status of collection request initiated with status code, description and additional remarks
    View API Specifications
    Direct Debit Authorisation Inquiry API

    This API allows clients to initiate a Direct Debit Authorisation (DDA) status inquiry and returns the interim status.

    Direct Debit Authorisation Inquiry API
    View API Specifications

    This API allows clients to initiate a Direct Debit Authorisation (DDA) status inquiry and returns the interim status.

    NOTE:

    • Applications must get the token using the “Get Token API," which will provide the access token details. This token must be used for the subsequent interactions of RESTful APIs. Tokens will be valid for 180s

    Flow Chart

    Image
    Flow Chart Direct Debit Authorisation Inquiry API

    What operations can be performed?

    1. dda-inquiry: This is a GET method that allows clients to fetch the status of previously initiated Direct Debit Authorisation registration.

    Request Headers:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    clientId
    Unique client ID provided by Mashreq to corporate.
    Mandatory
    STRING
     
     
    Authorization
    Bearer Token received from get token API with respect to Scope
    Mandatory
    STRING
     
     

    Request Parameters:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    channelCode
    Sender channel code defined for eCollect.
    Optional
    STRING
    Max 20
    CBK
    customerCode
    Corporate Customer Code defined by eCollect during customer onboarding
    Optional
    STRING
    Max 20
    10150935
    eventType
    Type of event.
    Mandatory
    STRING
    Max 10
    New
    lang
    Language Code.
    Mandatory
    STRING
    Max 3
    en (English) ar (Arabic)
    requestDateTime
    Service Request initiated date & time.
    Mandatory
    STRING
    Max 30
    30092021000000 (YYYYMMDDHHMMSS)
    requestId
    Unique Request Id generated by customer EPR for every API Request.
    Mandatory
    STRING
    Max 50
    1234567891
    serviceCode
    Unique service code defined by eCollect for each service
    Mandatory
    STRING
    Max 10
    SVC111
    serviceName
    Unique Service Name defined by eCollect for each service
    Mandatory
    STRING
    Max 30
    MANDATE_API1
    message
    Contains DDA Registration information
    Mandatory
    JSON
     
     
    corporateIdentificationCode
    Corporate identification code
    Mandatory
    STRING
    Max 9
    427
    originatorIdentificationCode
    Originator identification code generated by approaching CBUAE for a particular biller
    Mandatory
    STRING
    Max 9
    724000007
    ddaReferenceNumber
    DDA reference number
    Optional
    STRING
     
     
    channelReferenceNumber
    Channel reference number
    Optional
    STRING
     
    DDA202502262260009899
    fromDate
    Starting Date range
    Mandatory
    STRING
     
    2025-02-26 00:00:00
    toDate
    Ending Date range
    Mandatory
    STRING
     
    2025-12-30 00:00:00
    pagingAndFilterRequest
    Contains paging and filter setting information
    Mandatory
    JSON
     
     
    pageNumber
    Current page number
    Mandatory
    STRING
     
    0
    pageSize
    Page size
    Mandatory
    STRING
     
    10
    sortBy
    Option to sort by
    Mandatory
    STRING
     
     
    sortingOrder
    Option to provide sort order
    Mandatory
    STRING
     
     

    Response Parameters:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    responseMessage
    Block containing response message
    Mandatory
    JSON
     
     
    message
    Block containing the message
    Mandatory
    JSON
     
     
    mandateDetailsInfo
    Block containing mandate details
    Mandatory
    JSON
     
     
    isEFormReg
    Flag for E-Form registration
    Mandatory
    STRING
    Max 10
    N
    corporateIdentificationCode
    Corporate identification code
    Mandatory
    STRING
    Max 9
    128530
    customerInformationFileNumber
    Reference number
    Mandatory
    STRING
    Max 9
    010760743
    originatorAccountNumber
    Originator Account number generated by approaching CBUAE for a particular biller
    Mandatory
    STRING
    Max 9
    010493173081
    originatorIdentificationCode
    Originator identification code generated by approaching CBUAE for a particular biller
    Mandatory
    STRING
    Max 9
    330000015
    isPappReferenceBasedReg
    Flag for pre-approved reference number based registration
    Mandatory
    STRING
    Max 3
    N
    purposeCode
    Purpose of the mandate. Value defined as per the central bank of UAE
    Mandatory
    STRING
    Max 3
    301
    payerIdentificationNumber
    Consumer or payer identification number with originator
    Mandatory
    STRING
    Max 100
    400002116
    customerType
    Type of customer
    Mandatory
    STRING
    Max 2
    IN - Individual NI - Non-Individual
    customerIdentificationType
    Identification type for the customer. This varies based on the type of customer
    Mandatory
    STRING
    Max 26
    TRDLN
    customerIdentifier
    Unique customer identifier
    Mandatory
    STRING
     
    123456X989
    payingBankIdentifier
    Unique paying bank identifier
    Mandatory
    STRING
     
    MASHREQBANK PSC
    payerName
    Name of payer
    Mandatory
    STRING
     
    abcd
    fundingAccountType
    Type of account
    Mandatory
    STRING
     
    Current account*
    accountIdentifier
    Unique account identifier
    Mandatory
    STRING
     
    AE560330000010690XXXXXX
    mobileNumber
    Mobile number
    Mandatory
    STRING
     
    +971XXXXXXXXX
    email
    Email address
    Mandatory
    STRING
     
    abc@mashreq.com
    currencyCode
    Currency code
    Mandatory
    STRING
     
    AED
    commencementDate
    Date of commencement
    Mandatory
    STRING
     
    28-02-2025 00:04:00.0
    expiryDate
    Date of expiry
    Mandatory
    STRING
     
    30-12-2035 00:00:00.0
    amountType
    Type of amount
    Mandatory
    STRING
     
    Variable
    minAmount
    Minimum amount
    Mandatory
    STRING
     
    10000.00
    maxAmount
    Maximum amount
    Mandatory
    STRING
     
    100000000.00
    paymentFrequency
    Payment frequency
    Mandatory
    STRING
     
    M
    debitRequestInstances
    Instances of debit request
    Mandatory
    STRING
     
    48
    firstInitiationDate
    First initiation date
    Mandatory
    STRING
     
    28-02-2025
    dayIdentifier
    Day identifier
    Mandatory
    STRING
     
    28
    monthIdentifier
    Month identifier
    Mandatory
    STRING
     
    Feb
    customerReference1
    Customer reference
    Mandatory
    STRING
     
    400002116
    customerReference2
    Customer reference
    Mandatory
    STRING
     
    400002116
    sealReqFlag
    Flag for seal request
    Mandatory
    STRING
     
    N
    requestType
    Request type
    Mandatory
    STRING
     
    Registration
    statusDescription
    Status description
    Mandatory
    STRING
     
    Approved
    channelReferenceNumber
    Channel reference number
    Mandatory
    STRING
     
    DDA202303052620007271
    ddaReferenceNumber
    DDA reference number
    Mandatory
    STRING
     
    330000015320220000190 9

    Status Code Information:

    Status
    Status Code
    Description
    Success
    200
    Transaction initiated
    Rejected
    400
    Request Type should not be empty
     
    400
    Provided Request Type is invalid
     
    400
    Originator Identification Code should not be empty
     
    400
    Originator Identification Code is invalid.
     
    400
    Corporate Identification Code should not be empty
     
    400
    Originator Identification Code is invalid.
     
    400
    Corporate Identification Code is invalid
     
    400
    Originator Identification Code is invalid.
     
    400
    Payer Identification should be 81 character.
     
    400
    Customer Type should not be empty
     
    400
    Customer Type is Invalid
     
    400
    IBAN / Card Number is Invalid
     
    400
    Currency Code should be AED
     
    400
    Currency Code should be equal to 3 characters.
     
    400
    Currency Code should not be empty
     
    401
    Unauthorised user access
    Failed
    500
    Internal server error
    IMPORTANTS NOTES:
    • “pappReferenceNumber” is required when “isPappReferenceBasedReg” is set to “Yes”.
    • “customerType” value is provided as “IN” for Individual and NI for Non-Individual customer types.
    View API Specifications
    Direct Debit Authorisation Registration API

    This API allows clients to register a customer’s Direct Debit Authorisation (DDA) details into the system securely. This API captures essential banking and customer information required to set up recurring payments via direct debit.

    Direct Debit Authorisation Registration API
    View API Specifications

    This API allows clients to register a customer’s Direct Debit Authorisation (DDA) details into the system securely. This API captures essential banking and customer information required to set up recurring payments via direct debit.

    NOTE:

    • Applications must get the token using the “Get Token API," which will provide the access token details. This token must be used for the subsequent interactions of RESTful APIs. Tokens will be valid for 180s

    Flow Chart

    Image
    Flow Chart Direct Debit Authorisation Registration API

    What operations can be performed?

    1. dda-registration: This service is a POST method and enables corporates to initiate registration for Direct Debit Authorisation and returns the interim status.

    Request Headers:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    clientId
    Unique client ID provided by Mashreq to corporate.
    Mandatory
    STRING
     
     
    Authorization
    Bearer Token received from get token API with respect to Scope
    Mandatory
    STRING
     
     

    Request Parameters:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    channelCode
    Sender channel code defined for eCollect
    Optional
    STRING
    Max 20
    CBK
    customerCode
    Corporate Customer Code defined by eCollect during customer onboarding
    Optional
    STRING
    Max 20
    10150935
    eventType
    Type of event
    Mandatory
    STRING
    Max 10
    New
    lang
    Language Code.
    Mandatory
    STRING
    Max 3
    en (English) ar (Arabic)
    requestDateTime
    Service Request initiated date & time.
    Mandatory
    STRING
    Max 30
    30092021000000 (YYYYMMDDHHMMSS)
    requestId
    Unique Request Id generated by customer EPR for every API Request
    Mandatory
    STRING
    Max 50
    1234567891
    serviceCode
    Unique service code defined by eCollect for each service
    Mandatory
    STRING
    Max 10
    SVC111
    serviceName
    Unique Service Name defined by eCollect for each service
    Mandatory
    STRING
    Max 30
    MANDATE_API1
    message
    Contains DDA Registration information
    Mandatory
    STRING
     
     
    ddaRegistrationInfo
    This block contains DDA Registration details as fields mentioned below:
    Mandatory
    STRING
     
     
    workflowID
    Workflow Identifier
    Optional
    STRING
     
     
    channelReferenceNumber
    Channel reference number
    Optional
    STRING
     
     
    ddaReferenceNumber
    DDA reference number
    Optional
    STRING
     
     
    mandate
    Mandate contains ID
    Optional
    STRING
     
     
    id
    ID for Mandate
    Optional
    STRING
     
     
    corporateIdentificationCode
    Corporate identification code
    Mandatory
    STRING
    Max 9
     
    originatorIdentificationCode
    Originator identification code generated by approaching CBUAE for a particular biller
    Mandatory
    STRING
    Max 9
     
    isDataEntry
    Flag for data entry
    Mandatory
    STRING
    Max 3
    No
    isPappReferenceBasedReg
    Flag for pre-approved reference number based registration
    Mandatory
    STRING
    Max 3
    Yes
    pappReferenceNumber
    Pre-approved reference number. This is generated by the payer by approaching the paying bank. In this case payer details captured here are optional. This reference is required when request Type = PAPP
    Optional
    STRING
    Max 100
     
    purposeCode
    Purpose of the mandate. Value defined as per the central bank of UAE.
    Optional
    STRING
    Max 3
     
    payerIdentificationNumber
    Consumer or payer identification number with originator
    Mandatory
    STRING
    Max 100
     
    customerType
    Type of customer
    Mandatory
    STRING
    Max 2
    IN - Individual NI - Non-Individual
    customerIdentificationType
    Identification type for the customer. This varies based on the type of customer
    Mandatory
    STRING
    Max 20
     
    customerIdentifier
    Unique customer identifier
    Mandatory
    STRING
     
    123456X989
    payingBankIdentifier
    Unique paying bank identifier
    Mandatory
    STRING
     
    MASHREQBANK PSC
    payerName
    Name of payer
    Mandatory
    STRING
     
    abcd
    fundingAccountType
    Type of account
    Mandatory
    STRING
     
    Current account*
    accountIdentifier
    Unique account identifier
    Mandatory
    STRING
     
    AE560330000010690XXXXXX
    mobileNumber
    Mobile number
    Mandatory
    STRING
     
    +971XXXXXXXXX
    email
    Email address
    Mandatory
    STRING
     
    abc@mashreq.com
    currencyCode
    Currency code
    Mandatory
    STRING
     
    AED
    commencementDate
    Date of commencement
    Mandatory
    STRING
     
    28/02/2025
    expiryDate
    Date of expiry
    Mandatory
    STRING
     
    30/12/2035
    amountType
    Type of amount
    Mandatory
    STRING
     
    Variable
    minAmount
    Minimum amount
    Mandatory
    STRING
     
    10000.00
    maxAmount
    Maximum amount
    Mandatory
    STRING
     
    100000000.00
    paymentFrequency
    Payment Frequency
    Mandatory
    STRING
     
    Daily
    debitRequestInstances
    Instances of debit request
    Optional
    STRING
     
     
    firstInitiationDate
    First initiation date
    Optional
    STRING
     
     
    dayIdentifier
    Day identifier
    Optional
    STRING
     
     
    weekIdentifier
    Week identifier
    Optional
    STRING
     
     
    monthIdentifier
    Month identifier
    Optional
    STRING
     
     
    ddrDefinedDays
    DDR defined days
    Optional
    STRING
     
     
    customerReference1
    Customer reference
    Optional
    STRING
     
     
    customerReference2
    Customer reference
    Optional
    STRING
     
     
    sealReqFlag
    Flag for seal request
    Mandatory
    STRING
     
    No
    requestType
    Request type
    Mandatory
    STRING
     
    RQST
    actionType
    Action type
    Optional
    STRING
     
     
    remarks
    Remarks
    Mandatory
    STRING
     
    Test DDA
    imageInfo
    Image details
    Mandatory
    STRING
     
     
    imageFileID
    Image ID
    Mandatory
    STRING
     
    7
    imageFileName
    File name
    Mandatory
    STRING
     
    OpenData1.pdf
    imageFileExtension
    Extension of image
    Mandatory
    STRING
     
    pdf
    imageData
    Image Data encrypted
    Mandatory
    STRING
     
    Encrypted image data
    additionalInfo
    Contains additional information fields
    Mandatory
    STRING
     
     
    additionalField
    Additional information field
    Mandatory
    STRING
     
    ADD1

    Response Parameters:

    Fields
    Description
    Mandatory/Optional
    Data Type
    Length
    Sample Value
    responseMessage
    Block containing response message
    Mandatory
    JSON
     
     
    message
    Block containing the message
    Mandatory
    JSON
     
     
    mandateDetailsInfo
    Block containing mandate details
    Mandatory
    JSON
     
     
    isEFormReg
    Flag for E-Form registration
    Mandatory
    STRING
    Max 10
    N
    corporateIdentificationCode
    Corporate identification code
    Mandatory
    STRING
    Max 9
    128530
    customerInformationFileNumber
    Reference number
    Mandatory
    STRING
    Max 9
    010760743
    originatorAccountNumber
    Originator Account number generated by approaching CBUAE for a particular biller
    Mandatory
    STRING
    Max 9
    010493173081
    originatorIdentificationCode
    Originator identification code generated by approaching CBUAE for a particular biller
    Mandatory
    STRING
    Max 9
    330000015
    isPappReferenceBasedReg
    Flag for pre-approved reference number based registration
    Mandatory
    STRING
    Max 3
    N
    purposeCode
    Purpose of the mandate. Value defined as per the central bank of UAE
    Mandatory
    STRING
    Max 3
    301
    payerIdentificationNumber
    Consumer or payer identification number with originator
    Mandatory
    STRING
    Max 100
    400002116
    customerType
    Type of customer
    Mandatory
    STRING
    Max 2
    IN - Individual NI - Non-Individual
    customerIdentificationType
    Identification type for the customer. This varies based on the type of customer
    Mandatory
    STRING
    Max 26
    TRDLN
    customerIdentifier
    Unique customer identifier
    Mandatory
    STRING
     
    123456X989
    payingBankIdentifier
    Unique paying bank identifier
    Mandatory
    STRING
     
    MASHREQBANK PSC
    payerName
    Name of payer
    Mandatory
    STRING
     
    abcd
    fundingAccountType
    Type of account
    Mandatory
    STRING
     
    Current account*
    accountIdentifier
    Unique account identifier
    Mandatory
    STRING
     
    AE560330000010690XXXXXX
    mobileNumber
    Mobile number
    Mandatory
    STRING
     
    +971XXXXXXXXX
    email
    Email address
    Mandatory
    STRING
     
    abc@mashreq.com
    currencyCode
    Currency code
    Mandatory
    STRING
     
    AED
    commencementDate
    Date of commencement
    Mandatory
    STRING
     
    28-02-2025 00:00:00.0
    expiryDate
    Date of expiry
    Mandatory
    STRING
     
    30-12-2035 00:00:00.0
    amountType
    Type of amount
    Mandatory
    STRING
     
    Variable
    minAmount
    Minimum amount
    Mandatory
    STRING
     
    10000.00
    maxAmount
    Maximum amount
    Mandatory
    STRING
     
    100000000.00
    paymentFrequency
    Payment frequency
    Mandatory
    STRING
     
    M
    debitRequestInstances
    Instances of debit request
    Mandatory
    STRING
     
    48
    firstInitiationDate
    First initiation date
    Mandatory
    STRING
     
    28-02-2025
    dayIdentifier
    Day identifier
    Mandatory
    STRING
     
    28
    monthIdentifier
    Month identifier
    Mandatory
    STRING
     
    Feb
    customerReference1
    Customer reference
    Mandatory
    STRING
     
    400002116
    customerReference2
    Customer reference
    Mandatory
    STRING
     
    400002116
    sealRequestFlag
    Flag for seal request
    Mandatory
    STRING
     
    N
    requestType
    Request type
    Mandatory
    STRING
     
    Registration
    statusDescription
    Status description
    Mandatory
    STRING
     
    Approved
    channelReferenceNumber
    Channel reference number
    Mandatory
    STRING
     
    DDA202303052620007271
    ddaReferenceNumber
    DDA reference number
    Mandatory
    STRING
     
    330000015320220000190 9

    Status Code Information:

    Status
    Status Code
    Description
    Success
    S
    DDA Request has been Submitted and Sent for Approval Successfully
    Bad Request
    400
    Request Type should not be empty
     
    400
    Provided Request Type is invalid
     
    400
    Originator Identification Code should not be empty
     
    400
    Originator Identification Code is invalid.
     
    400
    Corporate Identification Code should not be empty
     
    400
    Originator Identification Code is invalid.
     
    400
    Corporate Identification Code is invalid
     
    400
    Originator Identification Code is invalid.
     
    400
    Payer Identification should be 81 character.
     
    400
    Customer Type should not be empty
     
    400
    Customer Type is Invalid
     
    400
    IBAN / Card Number is Invalid
     
    400
    Currency Code should be AED
     
    400
    Currency Code should be equal to 3 characters.
     
    400
    Currency Code should not be empty
     
    400
    Mobile Number should be 9 digit with country code
     
    400
    Customer reference number already exists
    IMPORTANTS NOTES:
    • “pappReferenceNumber” is required when “isPappReferenceBasedReg” is set to “Yes”.
    • “customerType” value is provided as “IN” for Individual and NI for Non-Individual customer types.
    View API Specifications
Number of API/s
4
Number of APIs
APIC Calls
160
K
Calls per month
Active users
250
Active users
UAE
Regions
Overview
Overview

Mashreq’s Collection APIs enable corporate clients to efficiently manage and automate the collection of payments from their customers, partners, or subsidiaries. The product supports multiple collection channels like Direct Debit Authorisation (DDA) to streamline receivables, enhance cash flow visibility, and simplify reconciliation.

What are the benefits?

  • Instant Payment Visibility

    Provides instant access to payment status, supporting better cash flow and liquidity management.

  • Automated Payment Collection

    Reduces manual effort by enabling scheduled, rule-based collections directly from customer accounts.

  • Improved Reconciliation

    Simplifies reconciliation of payments with online tracking and detailed transaction records.

  • Reduced Fraud Risk

    Direct debit mandates verify customer accounts upfront, lowering the risk of fraudulent transactions. 

  • Operational Efficiency

    Minimises errors, reduces manual tracking, and integrates easily with ERP and treasury systems.

  • Timely Payments

    Reduces the likelihood of missed or delayed payments, improving payment efficiency.

 
Which APIs are offered?
  • Direct Debit Authorisation Registration API: This API allows clients to register a customer’s Direct Debit Authorisation (DDA) details into the system securely. This API captures essential banking and customer information required to set up recurring payments via direct debit.
  • Direct Debit Authorisation Inquiry API: This API allows clients to initiate a Direct Debit Authorisation (DDA) status inquiry and returns the interim status.
  • Collection Request API: This API allows clients to initiate, track, and manage payment collection requests from customers.
  • Collection Fetch and Inquiry API: This API enables clients to fetch the details of collection requests initiated by clients and supports real-time inquiries to verify the status, reference details, and settlement updates of those requests.

 

By leveraging Mashreq’s Collection APIs, corporates can achieve faster payment cycles, improved liquidity, and greater operational efficiency by making receivables management seamless, secure, and scalable. 

What can I do with this API ?
icon
icon
icon
icon
Product benefits
Distributors can collect payments from dealers or resellers efficiently.
Service-based enterprises can collect recurring payments from corporate clients via Direct Debit.
Financial institutions can automate bulk loan or leasing repayments from business borrowers.
Large organisations can manage internal or partner-based fee collections through structured, automated processes.
Collections - Direct Debits
Engage with us
Get started today or reach out to learn more.
 
Register today to access and get started with our tools and API documentation.
 
Schedule a call with our team to understand how our offering can support you and your customers.