API Explorer

MXOFv1.0.0 (57 APIs)

Bank
Accounts
Views
Counterparties
Transactions

Create International Payment Consents

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" }, "Risk":{ "DeliveryAddress":{ "CountrySubDivision":["CountrySubDivision","CountrySubDivision"], "AddressLine":["AddressLine","AddressLine"], "Country":"Country" }, "PaymentContextCode":"BillPayment", "MerchantCategoryCode":"MerchantCategoryCode", "MerchantCustomerIdentification":"MerchantCustomerIdentification" }, "Data":{ "Status":"Authorised", "ConsentId":"ConsentId", "SCASupportData":{ "RequestedSCAExemptionType":"BillPayment", "AppliedAuthenticationApproach":"CA", "ReferencePaymentOrderId":"ReferencePaymentOrderId" }, "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", "CutOffDateTime":"2000-01-23T04:56:07.000+00:00", "ExchangeRateInformation":{ "ExchangeRate":0.8008281904610115, "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "RateType":"Actual", "ContractIdentification":"ContractIdentification", "UnitCurrency":"UnitCurrency" }, "Authorisation":{ "CompletionDateTime":"2000-01-23T04:56:07.000+00:00", "AuthorisationType":"Single" }, "Charges":[{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } },{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } }], "ReadRefundAccount":"No", "Initiation":{ "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "CountrySubDivision":{ }, "StreetName":{ }, "Department":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "SubDepartment":{ }, "AddressType":{ }, "PostCode":{ } }, "Identification":{ }, "SchemeName":{ }, "Name":{ } }, "DebtorAccount":{ "Name":"Name" }, "EndToEndIdentification":"EndToEndIdentification", "CurrencyOfTransfer":"CurrencyOfTransfer", "InstructionIdentification":"InstructionIdentification", "CreditorAccount":{ "Identification":{ }, "SchemeName":{ }, "Name":"Name" }, "ChargeBearer":{ }, "Purpose":"Purpose", "ExtendedPurpose":"ExtendedPurpose", "InstructionPriority":"Normal", "LocalInstrument":{ }, "RemittanceInformation":{ "RemittanceDescription":"RemittanceDescription", "Reference":"Reference" }, "DestinationCountryCode":"DestinationCountryCode", "ExchangeRateInformation":{ "ExchangeRate":6.027456183070403, "RateType":"Actual", "ContractIdentification":"ContractIdentification", "UnitCurrency":"UnitCurrency" }, "Creditor":{ "PostalAddress":{ "CountrySubDivision":{ }, "StreetName":{ }, "Department":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "SubDepartment":{ }, "AddressType":{ }, "PostCode":{ } }, "Name":"Name" }, "InstructedAmount":{ "Amount":{ }, "Currency":{ } } }, "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 internationalPaymentConsentsPost, operation_id: BAHRAIN-OBFv1.0.0-internationalPaymentConsentsPost Tags: International Payment Consents, Mocked-Data,

Get International Payment Consents Funds Confirmation by ConsentId

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":{ "SupplementaryData":{ }, "FundsAvailableResult":{ "FundsAvailableDateTime":"2000-01-23T04:56:07.000+00:00", "FundsAvailable":true } } }
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 internationalPaymentConsentsConsentIdFundsConfirmationGet, operation_id: BAHRAIN-OBFv1.0.0-internationalPaymentConsentsConsentIdFundsConfirmationGet Tags: International Payment Consents, Mocked-Data,

Get International Payment Consents by ConsentId

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" }, "Risk":{ "DeliveryAddress":{ "CountrySubDivision":["CountrySubDivision","CountrySubDivision"], "AddressLine":["AddressLine","AddressLine"], "Country":"Country" }, "PaymentContextCode":"BillPayment", "MerchantCategoryCode":"MerchantCategoryCode", "MerchantCustomerIdentification":"MerchantCustomerIdentification" }, "Data":{ "Status":"Authorised", "ConsentId":"ConsentId", "SCASupportData":{ "RequestedSCAExemptionType":"BillPayment", "AppliedAuthenticationApproach":"CA", "ReferencePaymentOrderId":"ReferencePaymentOrderId" }, "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", "CutOffDateTime":"2000-01-23T04:56:07.000+00:00", "ExchangeRateInformation":{ "ExchangeRate":0.8008281904610115, "ExpirationDateTime":"2000-01-23T04:56:07.000+00:00", "RateType":"Actual", "ContractIdentification":"ContractIdentification", "UnitCurrency":"UnitCurrency" }, "Authorisation":{ "CompletionDateTime":"2000-01-23T04:56:07.000+00:00", "AuthorisationType":"Single" }, "Charges":[{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } },{ "Type":{ }, "Amount":{ "Amount":{ }, "Currency":{ } }, "ChargeBearer":{ } }], "ReadRefundAccount":"No", "Initiation":{ "SupplementaryData":{ }, "CreditorAgent":{ "PostalAddress":{ "CountrySubDivision":{ }, "StreetName":{ }, "Department":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "SubDepartment":{ }, "AddressType":{ }, "PostCode":{ } }, "Identification":{ }, "SchemeName":{ }, "Name":{ } }, "DebtorAccount":{ "Name":"Name" }, "EndToEndIdentification":"EndToEndIdentification", "CurrencyOfTransfer":"CurrencyOfTransfer", "InstructionIdentification":"InstructionIdentification", "CreditorAccount":{ "Identification":{ }, "SchemeName":{ }, "Name":"Name" }, "ChargeBearer":{ }, "Purpose":"Purpose", "ExtendedPurpose":"ExtendedPurpose", "InstructionPriority":"Normal", "LocalInstrument":{ }, "RemittanceInformation":{ "RemittanceDescription":"RemittanceDescription", "Reference":"Reference" }, "DestinationCountryCode":"DestinationCountryCode", "ExchangeRateInformation":{ "ExchangeRate":6.027456183070403, "RateType":"Actual", "ContractIdentification":"ContractIdentification", "UnitCurrency":"UnitCurrency" }, "Creditor":{ "PostalAddress":{ "CountrySubDivision":{ }, "StreetName":{ }, "Department":{ }, "AddressLine":["AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine","AddressLine"], "BuildingNumber":{ }, "TownName":{ }, "Country":{ }, "SubDepartment":{ }, "AddressType":{ }, "PostCode":{ } }, "Name":"Name" }, "InstructedAmount":{ "Amount":{ }, "Currency":{ } } }, "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 internationalPaymentConsentsConsentIdGet, operation_id: BAHRAIN-OBFv1.0.0-internationalPaymentConsentsConsentIdGet Tags: International Payment Consents, Mocked-Data,