Schemas Postman

Fetch client direct debit payments POST

Get client direct debit payments

# ENDPOINT
/api/rbDebitPaymentApi/getData/rbDebitPaymentSearchRequest
# REQUEST BODY
# RESPONSE
# REQUEST BODY
Schema: rbDebitPaymentSearchRequest
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_payment_id debit payment id string
debit_payment_status debit_payment_status string
ledger_from_id ledger from id string
processing_date Processing date string
reference reference string reference
transaction_id transaction id string
# 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: rbDebitPayment
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
amount amount number decimal Operation amount
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
currency currency string Currency of the account
debit_mandate_id debit mandate id string
debit_payment_data Debit payment data STRING
debit_payment_id debit payment id string
debit_payment_status debit_payment_status string
error_description Error Description string Description of error
form_title form_title string Service field
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_payment_status Old debit payment status STRING
processing_date Processing date string
reference reference string reference
state state integer INT64 Record state for replication
transaction_id transaction id string
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": 5,
    "data": [
        {
            "id": 6,
            "uid": "b189cab7-a73e-c491-9014-f31c9867aec5",
            "version": 6504151,
            "state": 0,
            "modify_date": "2022-02-04T18:12:24.961",
            "modify_user": "root",
            "create_date": "2022-02-04T13:10:30.588",
            "create_user": "root",
            "amount": 0.03000000,
            "created_at": "2022-01-29T18:00:00.000",
            "currency": "eur",
            "debit_mandate_id": "",
            "debit_payment_id": "fakeDPMT-51af-11eb-96a0-35c6069e10ef",
            "debit_payment_status": "payment-status-accepted",
            "ledger_from_id": "60bf1fc9-cb28-405d-bca9-40a5bdf49ec7",
            "processing_date": "2022-01-29T18:00:00.000",
            "reference": "1610110016921",
            "transaction_id": "5ff853f6-add8-4337-988b-366628e71efe",
            "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": 7,
            "uid": "869f98b4-f632-3694-9014-9a4050de7208",
            "version": 6507544,
            "state": 0,
            "modify_date": "2022-02-06T19:36:55.555",
            "modify_user": "root",
            "create_date": "2022-02-06T19:36:55.547",
            "create_user": "root",
            "amount": 0.04000000,
            "created_at": "2022-01-29T18:00:00.000",
            "currency": "eur",
            "debit_mandate_id": "",
            "debit_payment_id": "fakeDPMT-52af-11eb-96a0-35c6069e10ef",
            "debit_payment_status": "payment-status-accepted",
            "ledger_from_id": "60bf1fc9-cb28-405d-bca9-40a5bdf49ec7",
            "processing_date": "2022-01-29T18:00:00.000",
            "reference": "1610110016921",
            "transaction_id": "fakeDTRN-2dd8-4337-988b-366628e71efe",
            "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": 9,
            "uid": "dd6a0286-b3b3-a48e-9014-e06d18e03c88",
            "version": 6512849,
            "state": 0,
            "modify_date": "2022-02-09T16:45:19.630",
            "modify_user": "root",
            "create_date": "2022-02-09T16:45:19.621",
            "create_user": "root",
            "amount": 0.08000000,
            "created_at": "2022-01-29T18:00:00.000",
            "currency": "eur",
            "debit_mandate_id": "",
            "debit_payment_id": "fakeDPMT-51af-11eb-96a0-35c6069e11ef",
            "debit_payment_status": "payment-status-accepted",
            "ledger_from_id": "60bf1fc9-cb28-405d-bca9-40a5bdf49ec7",
            "processing_date": "2022-01-29T18:00:00.000",
            "reference": "1610110016921",
            "transaction_id": "fakeDTRN-add8-4337-988b-366628e72efe",
            "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": 11,
            "uid": "f10ab647-795b-96bf-9014-627a10ccf066",
            "version": 6514254,
            "state": 0,
            "modify_date": "2022-02-10T11:51:19.268",
            "modify_user": "root",
            "create_date": "2022-02-10T11:51:19.257",
            "create_user": "root",
            "amount": 1.23000000,
            "created_at": "2022-02-09T18:00:00.000",
            "currency": "eur",
            "debit_mandate_id": "",
            "debit_payment_id": "fakeDPMT-51af-11eb-96a0-35c6069e13ef",
            "debit_payment_status": "payment-status-accepted",
            "ledger_from_id": "60bf1fc9-cb28-405d-bca9-40a5bdf49ec7",
            "processing_date": "2022-02-09T18:00:00.000",
            "reference": "1610110016921",
            "transaction_id": "fakeDTRN-add8-4337-988b-366628e76efe",
            "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": 13,
            "uid": "9109c98f-2986-6ba3-9014-4fc810bb537f",
            "version": 6522409,
            "state": 0,
            "modify_date": "2022-02-15T10:51:22.833",
            "modify_user": "root",
            "create_date": "2022-02-15T10:51:22.822",
            "create_user": "root",
            "amount": 0.09000000,
            "created_at": "2022-02-15T10:00:00.000",
            "currency": "eur",
            "debit_mandate_id": "",
            "debit_payment_id": "fakeDPMT-40af-11eb-96a0-35c6069e11ef",
            "debit_payment_status": "payment-status-accepted",
            "ledger_from_id": "60bf1fc9-cb28-405d-bca9-40a5bdf49ec7",
            "processing_date": "2022-01-29T18:00:00.000",
            "reference": "1610110016921",
            "transaction_id": "fakeDTRN-add1-4337-988b-366628e72efe",
            "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 mandates /api/rbDebitMandateApi/getData/rbDebitMandateSearchRequest
Cancel client direct debit mandate /api/rbDebitMandateApi/rbDebitMandateCancel/rbDebitMandateSearchRequest