API Explorer

MXOFv1.0.0 (57 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create File 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":"InitiationCompleted", "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "Debtor":{ "Name":"Name" }, "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "Charges":[{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } },{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } }], "FilePaymentId":"FilePaymentId", "ConsentId":"ConsentId", "Initiation":{ "FileContextFormat":"FileContextFormat", "SupplementaryData":{ }, "ControlSum":0.8008281904610115, "LocalInstrument":{ }, "DebtorAccount":{ "Name":"Name" }, "RemittanceInformation":{ "RemittanceDescription":"RemittanceDescription", "Reference":"Reference" }, "FileHash":"FileHash", "NumberOfTransactions":"NumberOfTransactions", "FileReference":"FileReference", "RequestedExecutionDateTime":"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 filePaymentsPost, operation_id: BAHRAIN-OBFv1.0.0-filePaymentsPost Tags: File Payments, Mocked-Data,

Get File Payment Details by FilePaymentId

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 filePaymentsFilePaymentIdPaymentDetailsGet, operation_id: BAHRAIN-OBFv1.0.0-filePaymentsFilePaymentIdPaymentDetailsGet Tags: File Payments, Mocked-Data,

Get File Payments Report File by FilePaymentId

NOTE: This endpoint currently only returns example data.

Authentication is Mandatory

URL Parameters:

JSON response body fields:

Typical Successful Response:

								
									
{ }
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 filePaymentsFilePaymentIdReportFileGet, operation_id: BAHRAIN-OBFv1.0.0-filePaymentsFilePaymentIdReportFileGet Tags: File Payments, Mocked-Data,

Get File Payments by FilePaymentId

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":"InitiationCompleted", "StatusUpdateDateTime":"2000-01-23T04:56:07.000+00:00", "Debtor":{ "Name":"Name" }, "CreationDateTime":"2000-01-23T04:56:07.000+00:00", "Charges":[{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } },{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } }], "FilePaymentId":"FilePaymentId", "ConsentId":"ConsentId", "Initiation":{ "FileContextFormat":"FileContextFormat", "SupplementaryData":{ }, "ControlSum":0.8008281904610115, "LocalInstrument":{ }, "DebtorAccount":{ "Name":"Name" }, "RemittanceInformation":{ "RemittanceDescription":"RemittanceDescription", "Reference":"Reference" }, "FileHash":"FileHash", "NumberOfTransactions":"NumberOfTransactions", "FileReference":"FileReference", "RequestedExecutionDateTime":"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 filePaymentsFilePaymentIdGet, operation_id: BAHRAIN-OBFv1.0.0-filePaymentsFilePaymentIdGet Tags: File Payments, Mocked-Data,