API Explorer

MXOFv1.0.0 (57 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create Domestic Future Dated Payments

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

JSON request body fields:

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "First":"http://example.com/aeiou", "Self":"http://example.com/aeiou" }, "Data":{ "Status":"Cancelled", "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "Debtor":{ "Name":"Name" }, "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "Refund":{ "Account":{ "Identification":{ }, "SchemeName":{ }, "Name":"Name" } }, "DomesticFutureDatedPaymentId":"DomesticFutureDatedPaymentId", "Charges":[{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } },{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } }], "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "LocalInstrument":{ }, "DebtorAccount":{ "Name":"Name" }, "RemittanceInformation":{ "RemittanceDescription":"RemittanceDescription", "Reference":"Reference" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CreditorAccount":{ "Identification":{ }, "SchemeName":{ }, "Name":"Name" }, "CreditorPostalAddress":{ "CountrySubDivision":{ }, "StreetName":{ }, "Department":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "SubDepartment":{ }, "AddressType":{ }, "PostCode":{ } }, "InstructedAmount":{ "Amount":{ }, "Currency":{ } }, "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00" }, "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: BAHRAIN-OBFv1.0.0, function_name: by domesticFutureDatedPaymentsPost, operation_id: BAHRAIN-OBFv1.0.0-domesticFutureDatedPaymentsPost Tags: Domestic Future Dated Payments, Mocked-Data,

Get Domestic Future Dated Payment Details by DomesticFutureDatedPaymentId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "First":"http://example.com/aeiou", "Self":"http://example.com/aeiou" }, "Data":{ "PaymentStatus":[{ "PaymentTransactionId":"PaymentTransactionId", "Status":"Accepted", "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "StatusDetail":{ "Status":"Status", "LocalInstrument":{ }, "StatusReason":"Cancelled", "StatusReasonDescription":"StatusReasonDescription" } },{ "PaymentTransactionId":"PaymentTransactionId", "Status":"Accepted", "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "StatusDetail":{ "Status":"Status", "LocalInstrument":{ }, "StatusReason":"Cancelled", "StatusReasonDescription":"StatusReasonDescription" } }] } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: BAHRAIN-OBFv1.0.0, function_name: by domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdPaymentDetailsGet, operation_id: BAHRAIN-OBFv1.0.0-domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdPaymentDetailsGet Tags: Domestic Future Dated Payments, Mocked-Data,

Get Domestic Future Dated Payments by DomesticFutureDatedPaymentId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "First":"http://example.com/aeiou", "Self":"http://example.com/aeiou" }, "Data":{ "Status":"Cancelled", "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "Debtor":{ "Name":"Name" }, "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "Refund":{ "Account":{ "Identification":{ }, "SchemeName":{ }, "Name":"Name" } }, "DomesticFutureDatedPaymentId":"DomesticFutureDatedPaymentId", "Charges":[{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } },{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } }], "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "LocalInstrument":{ }, "DebtorAccount":{ "Name":"Name" }, "RemittanceInformation":{ "RemittanceDescription":"RemittanceDescription", "Reference":"Reference" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CreditorAccount":{ "Identification":{ }, "SchemeName":{ }, "Name":"Name" }, "CreditorPostalAddress":{ "CountrySubDivision":{ }, "StreetName":{ }, "Department":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "SubDepartment":{ }, "AddressType":{ }, "PostCode":{ } }, "InstructedAmount":{ "Amount":{ }, "Currency":{ } }, "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00" }, "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: BAHRAIN-OBFv1.0.0, function_name: by domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdGet, operation_id: BAHRAIN-OBFv1.0.0-domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdGet Tags: Domestic Future Dated Payments, Mocked-Data,

Patch Domestic Future Dated Payments by DomesticFutureDatedPaymentId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ "Meta":{ "FirstAvailableDateTime":{ }, "TotalPages":0 }, "Links":{ "Last":"http://example.com/aeiou", "Prev":"http://example.com/aeiou", "Next":"http://example.com/aeiou", "First":"http://example.com/aeiou", "Self":"http://example.com/aeiou" }, "Data":{ "Status":"Cancelled", "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "Debtor":{ "Name":"Name" }, "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "ExpectedExecutionDateTime":"2000-01-23T04:56:07.000+00:00", "Refund":{ "Account":{ "Identification":{ }, "SchemeName":{ }, "Name":"Name" } }, "DomesticFutureDatedPaymentId":"DomesticFutureDatedPaymentId", "Charges":[{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } },{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } }], "ConsentId":"ConsentId", "Initiation":{ "SupplementaryData":{ }, "LocalInstrument":{ }, "DebtorAccount":{ "Name":"Name" }, "RemittanceInformation":{ "RemittanceDescription":"RemittanceDescription", "Reference":"Reference" }, "EndToEndIdentification":"EndToEndIdentification", "InstructionIdentification":"InstructionIdentification", "CreditorAccount":{ "Identification":{ }, "SchemeName":{ }, "Name":"Name" }, "CreditorPostalAddress":{ "CountrySubDivision":{ }, "StreetName":{ }, "Department":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "SubDepartment":{ }, "AddressType":{ }, "PostCode":{ } }, "InstructedAmount":{ "Amount":{ }, "Currency":{ } }, "RequestedExecutionDateTime":"2000-01-23T04:56:07.000+00:00" }, "ExpectedSettlementDateTime":"2000-01-23T04:56:07.000+00:00" } }
Validations:
  • Required JSON Validation: No
  • Allowed Authentication Types: Not set
Possible Errors:
  • OBP-20001: User not logged in. Authentication is required!
  • OBP-50000: Unknown Error.
Connector Methods:
Version: BAHRAIN-OBFv1.0.0, function_name: by domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdPatch, operation_id: BAHRAIN-OBFv1.0.0-domesticFutureDatedPaymentsDomesticFutureDatedPaymentIdPatch Tags: Domestic Future Dated Payments, Mocked-Data,