Schemas Postman

Fetch client direct debit mandates GET

Get client direct debit mandates

# ENDPOINT
/api/rbDebitMandateApi/getData/rbDebitMandateSearchRequest
# REQUEST BODY
# RESPONSE
# REQUEST BODY
Schema: rbDebitMandateSearchRequest
Type: object
Variable Name Type Format Usage Description
abs_account abs account string Client account opened in the System
abs_client_code Client code string Unique client identifier. Issued automatically by the System upon client registration.
debit_mandate_id debit mandate id string
debit_mandate_status debit mandate status string
holder_id holder id string
ledger_from_id ledger from id string
processing_date Processing date string
reference reference string reference
# REQUEST BODY EXAMPLE
							{
    "abs_client_code": "EN0000FRM"
}
# NEGATIVE RESPONSE

200 - Response with error when status is ERROR

Schema: HeaderResponseStatusError
Type: object
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object Empty object
# POSITIVE RESPONSE

200 - Response successfully when status is OK

Schema: rbDebitMandate
Type: object
Variable Name Type Format Description
status status string Request execution status
error_description Error Description string Description of error
error Error Code string Error code
data_type data_type string Type of data
total_records total_records string Total count of records
data data object data of Response
attribute: data
Variable Name Type Format Description
abs_account abs account string Client account opened in the System
abs_client_code Client code string Unique client identifier. Issued automatically by the System upon client registration.
action Action string
create_date Create Date string DATETIME The date entry was created on
create_user Create User string The username of ABS user who has created an entry
created_at created at string datetime
debit_mandate_data Debit mandate data STRING
debit_mandate_id debit mandate id string
debit_mandate_status debit mandate status string
error_description Error Description string Description of error
form_title form_title string Service field
holder_id holder id string
id id integer INT64 Record's sequence number generated in the system.
ledger_from_id ledger from id string
merchant_bank_code merchant bank code string
merchant_id merchant id string
merchant_name merchant name string
merchant_number merchant number string
merchant_type merchant type string
modify_date Modify Date string DATETIME The date entry was last modified on
modify_user Modify User string The username of ABS user who has made last changes to the entry
notifications_status notifications_status string
old_debit_mandate_status Old debit mandate status STRING
reference reference string reference
state state integer INT64 Record state for replication
uid uid string Unique record identifier which is used to distinguish between existing records
version version integer INT64 Record version for replication
# RESPONSE POSITIVE EXAMPLE
							{
    "status": "ok",
    "error_description": "",
    "error": {},
    "data_type": "",
    "total_records": 4,
    "data": [
        {
            "id": 5,
            "uid": "dd69390e-a507-0583-9014-d803a0e112f5",
            "version": 6499679,
            "state": 0,
            "modify_date": "2022-02-02T22:50:15.802",
            "modify_user": "root",
            "create_date": "2022-02-02T22:50:15.791",
            "create_user": "root",
            "debit_mandate_id": "fakeDMND-51bf-11eb-a46c-d1524fd043d8",
            "created_at": "2022-02-02T14:43:40.283",
            "debit_mandate_status": "mandate-status-active",
            "holder_id": "60bf1f70-1a9a-4401-8ef8-5e473e5eabf5",
            "ledger_from_id": "60bf1fc9-cb28-405d-bca9-40a5bdf49ec7",
            "reference": "1610109992931",
            "merchant_bank_code": "040379",
            "merchant_name": "Receiver Receive",
            "merchant_number": "01780486",
            "merchant_type": "sort-code",
            "merchant_id": "",
            "error_description": "",
            "abs_client_code": "EN0000FRM",
            "abs_account": "610000FR000EURH"
        },
        {
            "id": 8,
            "uid": "dd6a0286-b3b3-a48e-9014-db6d6023d78f",
            "version": 6512843,
            "state": 0,
            "modify_date": "2022-02-09T16:43:32.936",
            "modify_user": "root",
            "create_date": "2022-02-09T16:43:32.908",
            "create_user": "root",
            "debit_mandate_id": "fakeDMND-51bf-11eb-a46c-d1524fd043d7",
            "created_at": "2022-02-02T14:43:40.283",
            "debit_mandate_status": "mandate-status-active",
            "holder_id": "60bf1f70-1a9a-4401-8ef8-5e473e5eabf5",
            "ledger_from_id": "60bf1fc9-cb28-405d-bca9-40a5bdf49ec7",
            "reference": "1610109992931",
            "merchant_bank_code": "040379",
            "merchant_name": "Receiver Receive",
            "merchant_number": "01780486",
            "merchant_type": "sort-code",
            "merchant_id": "",
            "error_description": "",
            "abs_client_code": "EN0000FRM",
            "abs_account": "610000FR000EURH"
        },
        {
            "id": 10,
            "uid": "c6044206-9e12-169f-9014-4d7ae805767b",
            "version": 6514196,
            "state": 0,
            "modify_date": "2022-02-10T11:43:50.018",
            "modify_user": "root",
            "create_date": "2022-02-10T11:43:50.005",
            "create_user": "root",
            "debit_mandate_id": "fakeDMND-51bf-11eb-a46c-d1524fd043d6",
            "created_at": "2022-02-09T14:43:40.283",
            "debit_mandate_status": "mandate-status-active",
            "holder_id": "60bf1f70-1a9a-4401-8ef8-5e473e5eabf5",
            "ledger_from_id": "60bf1fc9-cb28-405d-bca9-40a5bdf49ec7",
            "reference": "1610109992931",
            "merchant_bank_code": "040379",
            "merchant_name": "Receiver Receive",
            "merchant_number": "01780486",
            "merchant_type": "sort-code",
            "merchant_id": "",
            "error_description": "",
            "abs_client_code": "EN0000FRM",
            "abs_account": "610000FR000EURH"
        },
        {
            "id": 12,
            "uid": "9109c98f-2986-6ba3-9014-4dc8289a7897",
            "version": 6522404,
            "state": 0,
            "modify_date": "2022-02-15T10:50:41.933",
            "modify_user": "root",
            "create_date": "2022-02-15T10:50:41.904",
            "create_user": "root",
            "debit_mandate_id": "fakeDMND-41bf-11eb-a46c-d1524fd043d7",
            "created_at": "2022-02-02T14:43:40.283",
            "debit_mandate_status": "mandate-status-active",
            "holder_id": "60bf1f70-1a9a-4401-8ef8-5e473e5eabf5",
            "ledger_from_id": "60bf1fc9-cb28-405d-bca9-40a5bdf49ec7",
            "reference": "1610109992931",
            "merchant_bank_code": "040379",
            "merchant_name": "Receiver Receive",
            "merchant_number": "01780486",
            "merchant_type": "sort-code",
            "merchant_id": "",
            "error_description": "",
            "abs_client_code": "EN0000FRM",
            "abs_account": "610000FR000EURH"
        }
    ]
}
# Other endpoints
Name Endpoint
Fetch client direct debit payments /api/rbDebitPaymentApi/getData/rbDebitPaymentSearchRequest
Cancel client direct debit mandate /api/rbDebitMandateApi/rbDebitMandateCancel/rbDebitMandateSearchRequest