BOBF Payment Initiation Services, supported since 2021

A PISP is a service provider who can initiate a payment transaction on behave of the customer, meaning they are able to withdraw the money directly from your account if you have given you’re consent.

Payment Initiation

The Payments Initiation API enables applications to make payments directly from a customer's account.
Customers remain in control, providing approval for each payment.

Access

You must be registered with the relevant competent authority as a Payment Initiation Services Provider (PISP), have valid transport and signing certificates in place and be onboarded as a Third Party. This can be done via an email specified in contacts.

Key features

The API allows a Payment Initiation Service Provider (PISP) to:

  • Register an intent to stage a payment-order consent.
  • Optionally confirm available funds for a payment-order.
  • Subsequently submit the payment-order for processing.
  • Optionally retrieve the status of a payment-order consent.

Avaliable payment types and API endpoints

APIs are grouped into API products, each with a subset of the API endpoints exposed as part of the banking APIs. Check out the products, API signatures, parameters, and response structure to understand the APIs from a functional perspective.

Payment types are categorized into:

Link Resource Endpoints
Single Domestic Payment domestic-payment-consents POST /bobf/release1.0.0/domestic-payment-consents
domestic-payment-consents GET /bobf/release1.0.0/domestic-payment-consents/
domestic-payment-consents GET /bobf/release1.0.0/domestic-payment-consents/{ConsentId}/funds-confirmation
domestic-payment POST /bobf/release1.0.0/domestic-payments
domestic-payment GET /bobf/release1.0.0/domestic-payments/
payment-details GET /bobf/release1.0.0/domestic-payments/{DomesticPaymentId}/payment-details
Single Future Dated Domestic Payment domestic-future-dated-payment-consents POST /bobf/release1.0.0/domestic-future-dated-payment-consents
domestic-future-dated-payment-consents GET /bobf/release1.0.0/domestic-future-dated-payment-consents/
domestic-future-dated-payment-consents POST /bobf/release1.0.0/domestic-future-dated-payment-cancellation-consents
domestic-future-dated-payment-consents GET /bobf/release1.0.0/domestic-future-dated-payment-cancellation-consents/
domestic-future-dated-payments POST /bobf/release1.0.0/domestic-future-dated-payments
domestic-future-dated-payments GET /bobf/release1.0.0/domestic-future-dated-payments/
payment-details GET /bobf/release1.0.0/domestic-future-dated-payments/{DomesticFutureDatedPaymentId}/payment-details
domestic-future-dated-payments PATCH /bobf/release1.0.0/domestic-future-dated-payments/
Single International Payment international-payment-consents POST /bobf/release1.0.0/international-payment-consents
international-payment-consents GET /bobf/release1.0.0/international-payment-consents/
international-payment-consents GET /bobf/release1.0.0/international-payment-consents/{ConsentId}/funds-confirmation
international-payments POST /bobf/release1.0.0/international-payments
international-payments GET /bobf/release1.0.0/international-payments/
payment-details GET /bobf/release1.0.0/international-payments/{InternationalPaymentId}/payment-details

How it works

The Payment Initiation is intended to initiate a payment with the consent of the customer.
Each customer must consent to allow you to initiate a payment request, consent is an agreement between you as the application owner and the customer. Once consent is agreed between you and the customer, the client application initiates the payment request, with authentication and request confirmation happening on the bank's web or mobile platform. The design of the API ensures that a customer's credentials are never shared with you, so they can be reassured that their credentials remain confidential at all times.

Making a Payment Request

The process of gaining confirmation of payment request from a customer is a multi-step process. You must complete each of the steps below in order to initiate a payment request.

  • You use your certificate based credentials to obtain an Access Token.
  • You use this Access Token to register with us your intent to make a payment on behalf a customer.
  • The customer is redirected by you to our Auth Page where they authenticate and view the payment request.
  • The customer views your request before confirming (or declining) it.
  • The customer is redirected back to your site or application and you receive an authorisation code.
  • You exchange this authorisation code for an Access Token specific to the payment request record.
  • You use that Access Token to submit the payment.

Obtains an Public Token using a Client Credentials Grant Type

Firstly, you authenticate with us and obtain an Public Token. This token is used later to register payment requests.

Example Post Request

https://ob-dev.alsalambahrain.com/apigateway/as/token.oauth2

Header Request

Content-Type:application/x-www-form-urlencoded

Body Request

grant_type:client_credentials
scope:payments
client_assertion_type:urn%3Aietf%3Aparams%3Aoauth%3Aclient-assertion-type%3Ajwt-bearer
client_assertion:eyJhbGciOiJSUzI1NiIsImtpZCI6IjEyMzQ1IiwidHlwIjoiSldUIn0.eyJpc3MiOiJUUFAxIiwiaWF0IjoxNTYwMTUyNDM4LCJleHAiOjE1NjAyNTQ0MDAsImF1ZCI6Imh0dHBzOi8vcGctbXNzcWwubW9zY293LmNtYS5ydTo5ODc2L2FzL3Rva2VuLm9hdXRoMiIsInN1YiI6InM2QmhkUmtxdDMifQ.Sseu8PEDRWFiU-VwBoF9mlWGzjAfWB_Thy_xY5-6lnQkHiHd7qDnYBHfFfdfRvV2HKNRuiMAlv60CkRabZ6ibGbej1xOK_kBd2UfJU6bkpYhigUygDhN8J1zwE3pGLtwA6lgICv0ihELb5S2EWz7A_mXouZoydgytHuUtG1PpujIhaKnlXTDJX010Nrs3HmdrRRDLBcvPdsQHc6-ghNYTT9fAq3bMr2PNwofpvZxoNK2DpAE5Qf1ZY4sPNZAFfp8xkIFXSIX6zRaqo3rbopxKuDbhWKEXP92GIk5IRUhGzZ1j3ZD9GnT_QiBQ_GNpy53bt0f4izSZqhNM7Fg0W99UA

Corresponding Response:

{
    "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTU2MDI0MjIyMiwiaWF0IjoxNTYwMTU1ODIyfQ.eNpQEwvlHZ09h44N9Ds2j11PfWaldI925aBBQc1UnQVXg1NqDIipbPwqwt9AkU2m7M2HvPnXuxd_LBIKsUlPtz4e5P2fP4bBLa9rmzFCZqwyn8TyOFUd8Uzg4YsP9y2AE_k-MN0Ggd0FFVlLWj1Xcs5YbQxdlnhDKcwhO-4yw946qXQ4jAtA1zuoPwDkzHqojf8iSHQyPvmgvqee8XgpSLG4qEw0QGR6pKQ6VLA4WfLjVnQZVTqyHfAMA7wxS65ZhmspM6mq2xcd52BDyOw7QaecB8Tz6APt-86o7fwxQBg8YsP_Rk2sLoUdCxkePG6dwXn1pyd3WsaSGWi5oBMaNg",
    "expires_in": 86400,
    "token_type": "bearer",
    "scope": "payments"
}

Single Domestic Payment

POST /bobf/release1.0.0/domestic-payment-consents

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-payment-consents

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful request:

{
  "Data": {   
    "Initiation": {
      "InstructionIdentification": "20210523_01",
      "EndToEndIdentification": "20190616B002",
      "LocalInstrument": "BH.OBF.DNS",
      "InstructedAmount": {
        "Amount": "100000",
        "Currency": "BHD"
      },
       "DebtorAccount": {
        "SchemeName": "BH.OBF.IBAN",
        "Identification": "BH13ALSA00106976100100",
         "Name": "Faisal Hassan Mohammed"
      },
      "CreditorAccount": {
        "SchemeName": "BH.OBF.IBAN",
        "Identification": "BH38ALSA22223340000000",
        "Name": "Faisal Hassan Mohammed"
      },
       "CreditorPostalAddress": {
        "AddressType": "Business",
        "AddressLine": ["XYZ Bank, Diplomatic Area"],
        "StreetName": "Al Barsha",
        "BuildingNumber": "27",
        "PostCode": "317",
        "TownName": "Manama",
        "CountrySubDivision": "Manama",
        "Country": "BH"     
        },

      "RemittanceInformation": {
        "RemittanceDescription": "Internal ops code 5120101",
        "Reference": "STORE-101"
      }
    },
    "Authorisation": {
      "AuthorisationType": "Single",
      "CompletionDateTime": "2021-05-23T20:00:00.594+03:00"
    },
    "SCASupportData": {
      "RequestedSCAExemptionType": " ",
      "AppliedAuthenticationApproach": "SCA",
      "ReferencePaymentOrderId": "08976"
    }
  },
  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "002345",
    "MerchantCustomerIdentification": "0023456789",
    "DeliveryAddress": {
        "AddressLine": ["XYZ Bank, Diplomatic Area"],
        "StreetName": "Route 1888",
        "BuildingNumber": "27",
        "PostCode": "317",
        "TownName": "Manama",
        "CountrySubDivision": ["Manama"],      
        "Country": "BH"    }
    }
}

A sample successful response:

{
    "Data": {
        "ConsentId": "Y76LOxZjRHuwC7XLpHL71A",
        "CreationDateTime": "2021-05-23T19:35:47.111+03:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2021-05-23T19:35:47.111+03:00",
        "Initiation": {
            "InstructionIdentification": "20210523_01",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.DNS",
            "InstructedAmount": {
                "Amount": "100000",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Faisal Hassan Mohammed"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH38ALSA22223340000000",
                "Name": "Faisal Hassan Mohammed"
            },
            "RemittanceInformation": {
                "Reference": "STORE-101",
                "RemittanceDescription": "Internal ops code 5120101"
            },
            "CreditorPostalAddress": {
                "AddressType": "Business",
                "StreetName": "Al Barsha",
                "BuildingNumber": "27",
                "PostCode": "317",
                "TownName": "Manama",
                "CountrySubDivision": "Manama",
                "Country": "BH",
                "AddressLine": [
                    "XYZ Bank, Diplomatic Area"
                ]
            }
        },
        "SCASupportData": {
            "RequestedSCAExemptionType": " ",
            "AppliedAuthenticationApproach": "SCA",
            "ReferencePaymentOrderId": "08976"
        },
        "Authorisation": {
            "AuthorisationType": "Single",
            "CompletionDateTime": "2021-05-23T20:00:00.594+03:00"
        }
    },
    "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "002345",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
            "AddressLine": [
                "XYZ Bank, Diplomatic Area"
            ],
            "StreetName": "Route 1888",
            "BuildingNumber": "27",
            "PostCode": "317",
            "TownName": "Manama",
            "CountrySubDivision": [
                "Manama"
            ],
            "Country": "BH"
        }
    },
    "Links": {
        "Self": "https://ob-dev.alsalambahrain.com/authpage/paymentConsentId/Y76LOxZjRHuwC7XLpHL71A"
    }
}

GET /bobf/release1.0.0/domestic-payment-consents/

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-payment-consents/Y76LOxZjRHuwC7XLpHL71A

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:

{
    "Data": {
        "ConsentId": "Y76LOxZjRHuwC7XLpHL71A",
        "CreationDateTime": "2021-05-23T19:35:47+03:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2021-05-23T19:35:47+03:00",
        "Initiation": {
            "InstructionIdentification": "20210523_01",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.DNS",
            "InstructedAmount": {
                "Amount": "100000",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Faisal Hassan Mohammed"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH38ALSA22223340000000",
                "Name": "Faisal Hassan Mohammed"
            },
            "RemittanceInformation": {
                "Reference": "STORE-101",
                "RemittanceDescription": "Internal ops code 5120101"
            },
            "CreditorPostalAddress": {
                "AddressType": "Business",
                "StreetName": "Al Barsha",
                "BuildingNumber": "27",
                "PostCode": "317",
                "TownName": "Manama",
                "CountrySubDivision": "Manama",
                "Country": "BH",
                "AddressLine": [
                    "XYZ Bank, Diplomatic Area"
                ]
            }
        },
        "SCASupportData": {
            "RequestedSCAExemptionType": " ",
            "AppliedAuthenticationApproach": "SCA",
            "ReferencePaymentOrderId": "08976"
        },
        "Authorisation": {
            "AuthorisationType": "Single",
            "CompletionDateTime": "2021-05-23T20:00:00.594+03:00"
        }
    },
    "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "002345",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
            "AddressLine": [
                "XYZ Bank, Diplomatic Area"
            ],
            "StreetName": "Route 1888",
            "BuildingNumber": "27",
            "PostCode": "317",
            "TownName": "Manama",
            "CountrySubDivision": [
                "Manama"
            ],
            "Country": "BH"
        }
    },
    "Links": {
        "Self": "https://ob-dev.alsalambahrain.com/authpage/paymentConsentId/Y76LOxZjRHuwC7XLpHL71A"
    }
}


Type of required token is Access token

An example initiating request:


https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-payment-consents/Y76LOxZjRHuwC7XLpHL71A/funds-confirmation

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:

{
    "Data": {
        "FundsAvailableResult": {
            "FundsAvailableDateTime": "2021-05-23T19:45:51.382+03:00",
            "FundsAvailable": false
        }
    }
}

POST /bobf/release1.0.0/domestic-payments

Type of required token is Access token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-payments

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful request:

{
    "Data":
    {
        "ConsentId": "Y76LOxZjRHuwC7XLpHL71A",
        "Initiation": {
      "InstructionIdentification": "20210523_01",
      "EndToEndIdentification": "20190616B002",
      "LocalInstrument": "BH.OBF.DNS",
      "InstructedAmount": {
        "Amount": "100000",
        "Currency": "BHD"
      },
        "DebtorAccount": {
        "SchemeName": "BH.OBF.IBAN",
        "Identification": "BH13ALSA00106976100100",
        "Name": "Faisal Hassan Mohammed"
      },


      "CreditorAccount": {
        "SchemeName": "BH.OBF.IBAN",
        "Identification": "BH38ALSA22223340000000",
        "Name": "Faisal Hassan Mohammed"
      },

       "CreditorPostalAddress": {
        "AddressType": "Business",
        "AddressLine": ["XYZ Bank, Diplomatic Area"],
        "StreetName": "Al Barsha",
        "BuildingNumber": "27",
        "PostCode": "317",
        "TownName": "Manama",
        "CountrySubDivision": "Manama",
        "Country": "BH"     
        },

      "RemittanceInformation": {
        "RemittanceDescription": "Internal ops code 5120101",
        "Reference": "STORE-101"
      }
    }
  },

  "Risk": {
    "PaymentContextCode": "BillPayment",
    "MerchantCategoryCode": "002345",
    "MerchantCustomerIdentification": "0023456789",
    "DeliveryAddress": {
        "AddressLine": ["XYZ Bank, Diplomatic Area"],
        "StreetName": "Route 1888",
        "BuildingNumber": "27",
        "PostCode": "317",
        "TownName": "Manama",
        "CountrySubDivision": ["Manama"],      
        "Country": "BH"    }
    }

A sample successful response:

{
    "Data": {
        "DomesticPaymentId": "Y76LOxZjRHuwC7XLpHL71A",
        "ConsentId": "Y76LOxZjRHuwC7XLpHL71A",
        "ReadRefundAccount": null,
        "CreationDateTime": "2021-05-23T19:35:47+03:00",
        "Status": "Pending",
        "StatusUpdateDateTime": "2021-05-23T19:50:04.381+03:00",
        "ExpectedExecutionDateTime": null,
        "ExpectedSettlementDateTime": null,
        "Initiation": {
            "InstructionIdentification": "20210523_01",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.DNS",
            "InstructedAmount": {
                "Amount": "100000",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Faisal Hassan Mohammed"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH38ALSA22223340000000",
                "Name": "Faisal Hassan Mohammed"
            },
            "RemittanceInformation": {
                "Reference": "STORE-101",
                "RemittanceDescription": "Internal ops code 5120101"
            },
            "CreditorPostalAddress": {
                "AddressType": "Business",
                "StreetName": "Al Barsha",
                "BuildingNumber": "27",
                "PostCode": "317",
                "TownName": "Manama",
                "CountrySubDivision": "Manama",
                "Country": "BH",
                "AddressLine": [
                    "XYZ Bank, Diplomatic Area"
                ]
            }
        },
        "Charges": null,
        "Debtor": null,
        "Refund": null
    },
    "Links": {
        "Self": "https://ob-dev.alsalambahrain.com/authpage"
    }
}

GET /bobf/release1.0.0/domestic-payments/

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-payments/Y76LOxZjRHuwC7XLpHL71A

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:

{
    "Data": {
        "DomesticPaymentId": "Y76LOxZjRHuwC7XLpHL71A",
        "ConsentId": "Y76LOxZjRHuwC7XLpHL71A",
        "ReadRefundAccount": null,
        "CreationDateTime": "2021-05-23T19:35:47+03:00",
        "Status": "Pending",
        "StatusUpdateDateTime": "2021-05-23T19:50:04+03:00",
        "ExpectedExecutionDateTime": null,
        "ExpectedSettlementDateTime": null,
        "Initiation": {
            "InstructionIdentification": "20210523_01",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.DNS",
            "InstructedAmount": {
                "Amount": "100000",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Faisal Hassan Mohammed"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH38ALSA22223340000000",
                "Name": "Faisal Hassan Mohammed"
            },
            "RemittanceInformation": {
                "Reference": "STORE-101",
                "RemittanceDescription": "Internal ops code 5120101"
            },
            "CreditorPostalAddress": {
                "AddressType": "Business",
                "StreetName": "Al Barsha",
                "BuildingNumber": "27",
                "PostCode": "317",
                "TownName": "Manama",
                "CountrySubDivision": "Manama",
                "Country": "BH",
                "AddressLine": [
                    "XYZ Bank, Diplomatic Area"
                ]
            }
        },
        "Charges": null,
        "Debtor": null,
        "Refund": null
    }
}

GET /bobf/release1.0.0/domestic-payments/ {DomesticPaymentId}/payment-details

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-payments/Y76LOxZjRHuwC7XLpHL71A/payment-details

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:

{
    "Data": {
        "PaymentStatus": [
            {
                "Status": "Pending",
                "StatusDetail": {}
            }
        ]
    },
    "Links": {
        "Self": "self"
    },
    "Meta": {}
}

Single Future Dated Domestic Payment

POST /bobf/release1.0.0/domestic-future-dated-payment-consents

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-future-dated-payment-consents


Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful request:

{
    "Data": {  
    "Permission": "Create", 
    "ReadRefundAccount": "Yes",
    "Initiation": {
        "InstructionIdentification": "20210523_21",
        "EndToEndIdentification": "20190616B002",
        "LocalInstrument": "BH.OBF.DNS",
        "RequestedExecutionDateTime": "2021-05-25T20:00:00.126+03:00",
        "InstructedAmount": {
            "Amount": "99999",
            "Currency": "BHD"
        },
        "DebtorAccount": {
            "SchemeName": "BH.OBF.IBAN",
            "Identification": "BH13ALSA00106976100100",
            "Name": "Khalid Ahmed Ali"
            },
        "CreditorAccount": {
            "SchemeName": "BH.OBF.IBAN",
            "Identification": "BH38ALSA22223340000000",
            "Name": "Faisal Hassan Mohammed"
        },
        "CreditorPostalAddress": {
            "AddressType": "Business",
            "AddressLine": ["XYZ Bank, Diplomatic Area"],
            "StreetName": "Al Barsha",
            "BuildingNumber": "27",
            "PostCode": "317",
            "TownName": "Manama",
            "CountrySubDivision": "Manama",
            "Country": "BH"     
        },
        "RemittanceInformation": {
            "RemittanceDescription": "Internal ops code 5120101",
            "Reference": "STORE-101"
        }
    },
    "Authorisation": {
        "AuthorisationType": "Single",
        "CompletionDateTime": "2020-04-07T09:10:17.594+03:00"
    },
    "SCASupportData": {
        "RequestedSCAExemptionType": " ",
        "AppliedAuthenticationApproach": "SCA",
        "ReferencePaymentOrderId": "08976"
    }
  },
    "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "002345",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
            "AddressLine": ["XYZ Bank, Diplomatic Area"],
            "StreetName": "Route 1888",
            "BuildingNumber": "27",
            "PostCode": "317",
            "TownName": "Manama",
            "CountrySubDivision": ["Manama"],      
            "Country": "BH"
        }
    }
}

A sample successful response:

{
    "Data": {
        "ConsentId": "GytpOjKhSluM8cJvFz6BpA",
        "CreationDateTime": "2021-05-23T20:34:36.289+03:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2021-05-23T20:34:36.289+03:00",
        "Permission": "Create",
        "ReadRefundAccount": "Yes",
        "CutOffDateTime": null,
        "ExpectedExecutionDateTime": null,
        "ExpectedSettlementDateTime": null,
        "Charges": null,
        "Initiation": {
            "InstructionIdentification": "20210523_21",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.DNS",
            "InstructedAmount": {
                "Amount": "99999",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH38ALSA22223340000000",
                "Name": "Faisal Hassan Mohammed"
            },
            "RemittanceInformation": {
                "Reference": "STORE-101",
                "RemittanceDescription": "Internal ops code 5120101"
            },
            "RequestedExecutionDateTime": "2021-05-25T20:00:00.126+03:00",
            "CreditorPostalAddress": {
                "AddressType": "Business",
                "StreetName": "Al Barsha",
                "BuildingNumber": "27",
                "PostCode": "317",
                "TownName": "Manama",
                "CountrySubDivision": "Manama",
                "Country": "BH",
                "AddressLine": [
                    "XYZ Bank, Diplomatic Area"
                ]
            }
        },
        "Authorisation": {
            "AuthorisationType": "Single",
            "CompletionDateTime": "2020-04-07T09:10:17.594+03:00"
        },
        "SCASupportData": {
            "RequestedSCAExemptionType": " ",
            "AppliedAuthenticationApproach": "SCA",
            "ReferencePaymentOrderId": "08976"
        },
        "Debtor": null
    },
    "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "002345",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
            "AddressLine": [
                "XYZ Bank, Diplomatic Area"
            ],
            "StreetName": "Route 1888",
            "BuildingNumber": "27",
            "PostCode": "317",
            "TownName": "Manama",
            "CountrySubDivision": [
                "Manama"
            ],
            "Country": "BH"
        }
    },
    "Links": {
         "Self": "https://ob-dev.alsalambahrain.com/authpage/paymentConsentId/RHBUUkpNQ5-KcJAcGiTXsg"
    },
    "Meta": {}
}


GET /bobf/release1.0.0/domestic-future-dated-payment-consents/

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-future-dated-payment-consents/RHBUUkpNQ5-KcJAcGiTXsg


Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:

{
    "Data": {
        "ConsentId": "RHBUUkpNQ5-KcJAcGiTXsg",
        "CreationDateTime": "2021-05-23T20:27:45+03:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2021-05-23T20:27:45+03:00",
        "Permission": "Create",
        "ReadRefundAccount": "Yes",
        "CutOffDateTime": null,
        "ExpectedExecutionDateTime": null,
        "ExpectedSettlementDateTime": null,
        "Charges": null,
        "Initiation": {
            "InstructionIdentification": "20210523_20",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.DNS",
            "InstructedAmount": {
                "Amount": "99999",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH38ALSA22223340000000",
                "Name": "Faisal Hassan Mohammed"
            },
            "RemittanceInformation": {
                "Reference": "STORE-101",
                "RemittanceDescription": "Internal ops code 5120101"
            },
            "RequestedExecutionDateTime": "2021-05-23T20:00:00.126+03:00",
            "CreditorPostalAddress": {
                "AddressType": "Business",
                "StreetName": "Al Barsha",
                "BuildingNumber": "27",
                "PostCode": "317",
                "TownName": "Manama",
                "CountrySubDivision": "Manama",
                "Country": "BH",
                "AddressLine": [
                    "XYZ Bank, Diplomatic Area"
                ]
            }
        },
        "Authorisation": {
            "AuthorisationType": "Single",
            "CompletionDateTime": "2020-04-07T09:10:17.594+03:00"
        },
        "SCASupportData": {
            "RequestedSCAExemptionType": " ",
            "AppliedAuthenticationApproach": "SCA",
            "ReferencePaymentOrderId": "08976"
        },
        "Debtor": null
    },
    "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "002345",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
            "AddressLine": [
                "XYZ Bank, Diplomatic Area"
            ],
            "StreetName": "Route 1888",
            "BuildingNumber": "27",
            "PostCode": "317",
            "TownName": "Manama",
            "CountrySubDivision": [
                "Manama"
            ],
            "Country": "BH"
        }
    },
    "Links": {
        "Self": "https://ob-dev.alsalambahrain.com/authpage/paymentConsentId/RHBUUkpNQ5-KcJAcGiTXsg"
    },
    "Meta": {}
}

POST /bobf/release1.0.0/domestic-future-dated-payment-cancellation-consents

Type of required token is Public token

An example initiating request:


https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-future-dated-payment-cancellation-consents

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful request:

{

  "Data": {

    "Permission": "Create",
    "DomesticFutureDatedPaymentId": "RHBUUkpNQ5-KcJAcGiTXsg",
    "ExpectedExecutionDateTime": "2021-05-23T04:57:51.126+03:00",
    "ExpectedSettlementDateTime": "2021-05-23T04:57:51.126+03:00"

  }

}

A sample successful response:

{
    "Data": {
        "ConsentId": "1x6FcO_JQ2WZJDAf1U3dxw",
        "Permission": "Create",
        "DomesticFutureDatedPaymentId": "RHBUUkpNQ5-KcJAcGiTXsg",
        "ExpectedExecutionDateTime": "2021-05-23T04:57:51.126+03:00",
        "ExpectedSettlementDateTime": "2021-05-23T04:57:51.126+03:00",
        "Charges": null
    }
}

GET /bobf/release1.0.0/domestic-future-dated-payment-cancellation-consents/

Type of required token is Public token

An example initiating request:


https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-future-dated-payment-cancellation-consents/RHBUUkpNQ5-KcJAcGiTXsg

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:

{
    "Data": {
        "ConsentId": "RHBUUkpNQ5-KcJAcGiTXsg",
        "Permission": "Update",
        "DomesticFutureDatedPaymentId": "RHBUUkpNQ5-KcJAcGiTXsg",
        "ExpectedExecutionDateTime": "2021-05-23T04:57:51.126+03:00",
        "ExpectedSettlementDateTime": "2021-05-23T04:57:51.126+03:00",
        "Charges": null
    }
}

POST /bobf/release1.0.0/domestic-future-dated-payments

Type of required token is Access token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-future-dated-payments

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful request:

{
    "Data": {
        "ConsentId": "7dtvguT9SfKrcmVUrYBeDw",
        "Initiation": {
            "InstructionIdentification": "20210523_21",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.DNS",
            "RequestedExecutionDateTime": "2021-05-25T20:00:00.126+03:00",
            "InstructedAmount": {
                "Amount": "99999",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH38ALSA22223340000000",
                "Name": "Faisal Hassan Mohammed"
            },
            "CreditorPostalAddress": {
                "AddressType": "Business",
                "AddressLine": ["XYZ Bank, Diplomatic Area"],
                "StreetName": "Al Barsha",
                "BuildingNumber": "27",
                "PostCode": "317",
                "TownName": "Manama",
                "CountrySubDivision": "Manama",
                "Country": "BH"     
            },
            "RemittanceInformation": {
                "RemittanceDescription": "Internal ops code 5120101",
                "Reference": "STORE-101"
            }
        }
    },
    "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "002345",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
            "AddressLine": ["XYZ Bank, Diplomatic Area"],
            "StreetName": "Route 1888",
            "BuildingNumber": "27",
            "PostCode": "317",
            "TownName": "Manama",
            "CountrySubDivision": ["Manama"],      
            "Country": "BH"
        }
    }
}

A sample successful response:

{
    "Data": {
        "DomesticFutureDatedPaymentId": "GytpOjKhSluM8cJvFz6BpA",
        "ConsentId": "GytpOjKhSluM8cJvFz6BpA",
        "CreationDateTime": "2021-05-23T20:34:36+03:00",
        "Status": "InitiationCompleted",
        "StatusUpdateDateTime": "2021-05-23T20:36:01+03:00",
        "ExpectedExecutionDateTime": null,
        "ExpectedSettlementDateTime": null,
        "Refund": {
            "Account": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            }
        },
        "Charges": null,
        "Initiation": {
            "InstructionIdentification": "20210523_21",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.DNS",
            "InstructedAmount": {
                "Amount": "99999",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH38ALSA22223340000000",
                "Name": "Faisal Hassan Mohammed"
            },
            "RemittanceInformation": {
                "Reference": "STORE-101",
                "RemittanceDescription": "Internal ops code 5120101"
            },
            "RequestedExecutionDateTime": "2021-05-25T20:00:00.126+03:00",
            "CreditorPostalAddress": {
                "AddressType": "Business",
                "StreetName": "Al Barsha",
                "BuildingNumber": "27",
                "PostCode": "317",
                "TownName": "Manama",
                "CountrySubDivision": "Manama",
                "Country": "BH",
                "AddressLine": [
                    "XYZ Bank, Diplomatic Area"
                ]
            }
        },
        "Debtor": null
    },
    "Links": {
        "Self": "https://ob-dev.alsalambahrain.com/authpage"
    },
    "Meta": {}
}

GET /bobf/release1.0.0/domestic-future-dated-payments/

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-future-dated-payments/GytpOjKhSluM8cJvFz6BpA

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:

{
    "Data": {
        "DomesticFutureDatedPaymentId": "GytpOjKhSluM8cJvFz6BpA",
        "ConsentId": "GytpOjKhSluM8cJvFz6BpA",
        "CreationDateTime": "2021-05-23T20:34:36+03:00",
        "Status": "InitiationCompleted",
        "StatusUpdateDateTime": "2021-05-23T20:37:41+03:00",
        "ExpectedExecutionDateTime": null,
        "ExpectedSettlementDateTime": null,
        "Refund": {
            "Account": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            }
        },
        "Charges": null,
        "Initiation": {
            "InstructionIdentification": "20210523_21",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.DNS",
            "InstructedAmount": {
                "Amount": "99999",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH38ALSA22223340000000",
                "Name": "Faisal Hassan Mohammed"
            },
            "RemittanceInformation": {
                "Reference": "STORE-101",
                "RemittanceDescription": "Internal ops code 5120101"
            },
            "RequestedExecutionDateTime": "2021-05-25T20:00:00.126+03:00",
            "CreditorPostalAddress": {
                "AddressType": "Business",
                "StreetName": "Al Barsha",
                "BuildingNumber": "27",
                "PostCode": "317",
                "TownName": "Manama",
                "CountrySubDivision": "Manama",
                "Country": "BH",
                "AddressLine": [
                    "XYZ Bank, Diplomatic Area"
                ]
            }
        },
        "Debtor": null
    }
}

GET /bobf/release1.0.0/domestic-future-dated-payments/ {DomesticFutureDatedPaymentId}/payment-details

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-future-dated-payments/GytpOjKhSluM8cJvFz6BpA/payment-details

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:

{
    "Data": {
        "PaymentStatus": [
            {
                "Status": "Pending",
                "StatusDetail": {}
            }
        ]
    },
    "Links": {
        "Self": "self"
    },
    "Meta": {}
}

PATCH /bobf/release1.0.0/ domestic-future-dated-payments/

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/domestic-payment-consents

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful request:

{

  "Data": {

    "ConsentId": "IGpeBYUqQ-e6Y9GPLvdkfQ",

    "Status": "PendingCancellationRequest"

  }

A sample successful response:


https://ob-dev.alsalambahrain.com/authpage

Single International Payment

POST /bobf/release1.0.0/international-payment-consents

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/international-payment-consents

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful request:

{
    "Data": {
        "ReadRefundAccount": "No",
        "Initiation": {
            "InstructionIdentification": "20210523_10",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.SWIFT",
            "CurrencyOfTransfer": "USD",
            "InstructedAmount": {
                "Amount": "500.60",
                "Currency": "BHD"
            },
            "ExchangeRateInformation": {
                "UnitCurrency": "BHD",
                "ExchangeRate": 30,
                "RateType": "Agreed",
                "ContractIdentification": "FEC"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            },
            "CreditorAgent": {
                "SchemeName": "BH.OBF.BICFI",
                "Identification": "CITIUS33XXX"
                               
            },

            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "KW47BAYT0000002203202111111111",
                "Name": "Ali Hassan Mohammed"
            }
        },
        "Authorisation": {
            "AuthorisationType": "Single",
            "CompletionDateTime": "2021-05-23T20:00:00.597+03:00"
        },
        "SCASupportData": {
            "RequestedSCAExemptionType": "",
            "AppliedAuthenticationApproach": "SCA",
            "ReferencePaymentOrderId": "936427-2"
        }
    },
    "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "4444",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
            "AddressLine": ["XYZ Bank, Diplomatic Area"],
            "StreetName": "Al Barsha",
            "BuildingNumber": "27",
            "PostCode": "317",
            "TownName": "Kuwait",             
            "Country": "KW"
        }
    }
}

A sample successful response:

{
    "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "4444",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
            "AddressLine": [
                "XYZ Bank, Diplomatic Area"
            ],
            "StreetName": "Al Barsha",
            "BuildingNumber": "27",
            "PostCode": "317",
            "TownName": "Kuwait",
            "CountrySubDivision": null,
            "Country": "KW"
        }
    },
    "Data": {
        "ConsentId": "sbmoobLXSK6B-rcHsOuY6w",
        "CreationDateTime": "2021-05-23T20:06:04.398+03:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2021-05-23T20:06:04.398+03:00",
        "ReadRefundAccount": "No",
        "CutOffDateTime": null,
        "ExpectedExecutionDateTime": null,
        "ExpectedSettlementDateTime": null,
        "Initiation": {
            "InstructionIdentification": "20210523_10",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.SWIFT",
            "InstructedAmount": {
                "Amount": "500.60",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "KW47BAYT0000002203202111111111",
                "Name": "Ali Hassan Mohammed"
            },
            "CurrencyOfTransfer": "USD",
            "ExchangeRateInformation": {
                "UnitCurrency": "BHD",
                "ExchangeRate": "30",
                "RateType": "Agreed",
                "ContractIdentification": "FEC"
            },
            "CreditorAgent": {
                "SchemeName": "BH.OBF.BICFI",
                "Identification": "CITIUS33XXX"
            }
        },
        "SCASupportData": {
            "AppliedAuthenticationApproach": "SCA",
            "ReferencePaymentOrderId": "936427-2"
        },
        "Authorisation": {
            "AuthorisationType": "Single",
            "CompletionDateTime": "2021-05-23T20:00:00.597+03:00"
        },
        "Charges": null,
        "ExchangeRateInformation": null,
        "Debtor": null
    },
    "Links": {
        "Self": "https://ob-dev.alsalambahrain.com/authpage/paymentConsentId/sbmoobLXSK6B-rcHsOuY6w"
    }
}

GET /bobf/release1.0.0/international-payment-consents/

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/international-payment-consents/sbmoobLXSK6B-rcHsOuY6w

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:

{
    "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "4444",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
            "AddressLine": [
                "XYZ Bank, Diplomatic Area"
            ],
            "StreetName": "Al Barsha",
            "BuildingNumber": "27",
            "PostCode": "317",
            "TownName": "Kuwait",
            "CountrySubDivision": [
                null
            ],
            "Country": "KW"
        }
    },
    "Data": {
        "ConsentId": "sbmoobLXSK6B-rcHsOuY6w",
        "CreationDateTime": "2021-05-23T20:06:04+03:00",
        "Status": "AwaitingAuthorisation",
        "StatusUpdateDateTime": "2021-05-23T20:06:04+03:00",
        "ReadRefundAccount": "No",
        "CutOffDateTime": null,
        "ExpectedExecutionDateTime": null,
        "ExpectedSettlementDateTime": null,
        "Initiation": {
            "InstructionIdentification": "20210523_10",
            "EndToEndIdentification": "20190616B002",
            "InstructedAmount": {
                "Amount": "500.6",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "KW47BAYT0000002203202111111111",
                "Name": "Ali Hassan Mohammed"
            },
            "RemittanceInformation": {},
            "InstructionPriority": "Normal",
            "CurrencyOfTransfer": "USD",
            "Creditor": {
                "PostalAddress": {
                    "AddressLine": []
                }
            },
            "CreditorAgent": {
                "SchemeName": "BH.OBF.BICFI",
                "Identification": "CITIUS33XXX",
                "PostalAddress": {}
            }
        },
        "SCASupportData": {
            "AppliedAuthenticationApproach": "SCA",
            "ReferencePaymentOrderId": "936427-2"
        },
        "Authorisation": {
            "AuthorisationType": "Single",
            "CompletionDateTime": "2021-05-23T20:00:00.597+03:00"
        },
        "Charges": null,
        "ExchangeRateInformation": null,
        "Debtor": null
    },
    "Links": {
        "Self": "https://ob-dev.alsalambahrain.com/authpage/paymentConsentId/sbmoobLXSK6B-rcHsOuY6w"
    }
}

Type of required token is Access token

An example initiating request:


https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/international-payment-consents/awypfr0cSdWODjjCEhChgg/funds-confirmation

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:

{
    "Data": {
        "FundsAvailableResult": {
            "FundsAvailableDateTime": "2021-05-23T20:18:49.225+03:00",
            "FundsAvailable": false
        }
    }
}

POST /bobf/release1.0.0/international-payments

Type of required token is Access token

An example initiating request:


https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/international-payments

Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful request:

{
    "Data": {
       
        "ConsentId" : "sbmoobLXSK6B-rcHsOuY6w",
        "Initiation": {
            "InstructionIdentification": "20210523_10",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.SWIFT",
            "CurrencyOfTransfer": "USD",
            "InstructedAmount": {
                "Amount": "500.60",
                "Currency": "BHD"
            },
            "ExchangeRateInformation": {
                "UnitCurrency": "BHD",
                "ExchangeRate": 30,
                "RateType": "Agreed",
                "ContractIdentification": "FEC"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            },
            "CreditorAgent": {
                "SchemeName": "BH.OBF.BICFI",
                "Identification": "CITIUS33XXX"
                               
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "KW47BAYT0000002203202111111111",
                "Name": "Ali Hassan Mohammed"
            }
        }
    },
    "Risk": {
        "PaymentContextCode": "BillPayment",
        "MerchantCategoryCode": "5555",
        "MerchantCustomerIdentification": "0023456789",
        "DeliveryAddress": {
            "AddressLine": ["XYZ Bank, Diplomatic Area"],
            "StreetName": "Al Barsha",
            "BuildingNumber": "27",
            "PostCode": "317",
            "TownName": "Kuwait",             
            "Country": "KW"
        }
    }
}

A sample successful response:

{
    "Data": {
        "ConsentId": "sbmoobLXSK6B-rcHsOuY6w",
        "CreationDateTime": "2021-05-23T20:06:04+03:00",
        "Status": "Pending",
        "StatusUpdateDateTime": "2021-05-23T20:14:23.724+03:00",
        "ReadRefundAccount": "No",
        "CutOffDateTime": null,
        "ExpectedExecutionDateTime": null,
        "ExpectedSettlementDateTime": null,
        "Initiation": {
            "InstructionIdentification": "20210523_10",
            "EndToEndIdentification": "20190616B002",
            "LocalInstrument": "BH.OBF.SWIFT",
            "InstructedAmount": {
                "Amount": "500.60",
                "Currency": "BHD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "KW47BAYT0000002203202111111111",
                "Name": "Ali Hassan Mohammed"
            },
            "CurrencyOfTransfer": "USD",
            "ExchangeRateInformation": {
                "UnitCurrency": "BHD",
                "ExchangeRate": "30",
                "RateType": "Agreed",
                "ContractIdentification": "FEC"
            },
            "CreditorAgent": {
                "SchemeName": "BH.OBF.BICFI",
                "Identification": "CITIUS33XXX"
            }
        },
        "Charges": null,
        "ExchangeRateInformation": {
            "UnitCurrency": "BHD",
            "ExchangeRate": "2.6455026",
            "RateType": "Agreed",
            "ContractIdentification": "FEC"
        },
        "Debtor": null,
        "Refund": null
    },
    "Links": {
        "Self": "https://pg:9047/authpage"
    }
}

GET /bobf/release1.0.0/international-payments/

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/international-payments/awypfr0cSdWODjjCEhChgg


Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:

{
    "Data": {
        "ConsentId": "awypfr0cSdWODjjCEhChgg",
        "CreationDateTime": "2021-05-23T20:15:33+03:00",
        "Status": "AcceptedSettlementInProcess",
        "StatusUpdateDateTime": "2021-05-23T20:16:04+03:00",
        "ReadRefundAccount": "No",
        "CutOffDateTime": null,
        "ExpectedExecutionDateTime": null,
        "ExpectedSettlementDateTime": null,
        "Initiation": {
            "InstructionIdentification": "20210523_11",
            "EndToEndIdentification": "20190616B002",
            "InstructedAmount": {
                "Amount": "1324.34",
                "Currency": "USD"
            },
            "DebtorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "BH13ALSA00106976100100",
                "Name": "Khalid Ahmed Ali"
            },
            "CreditorAccount": {
                "SchemeName": "BH.OBF.IBAN",
                "Identification": "KW47BAYT0000002203202111111111",
                "Name": "Ali Hassan Mohammed"
            },
            "RemittanceInformation": {},
            "InstructionPriority": "Normal",
            "CurrencyOfTransfer": "USD",
            "ExchangeRateInformation": {
                "UnitCurrency": "BHD",
                "ExchangeRate": "2.6455026",
                "RateType": "Agreed",
                "ContractIdentification": "FEC"
            },
            "Creditor": {
                "PostalAddress": {
                    "AddressLine": []
                }
            },
            "CreditorAgent": {
                "SchemeName": "BH.OBF.BICFI",
                "Identification": "CITIUS33XXX",
                "PostalAddress": {}
            }
        },
        "Charges": null,
        "ExchangeRateInformation": {
            "UnitCurrency": "BHD",
            "ExchangeRate": "2.6455026",
            "RateType": "Agreed",
            "ContractIdentification": "FEC"
        },
        "Debtor": null,
        "Refund": null
    }
}

GET /bobf/release1.0.0/international-payments/ {InternationalPaymentId}/payment-details

Type of required token is Public token

An example initiating request:

https://ob-dev.alsalambahrain.com/apigatway/bobf/release1.0.0/international-payments/awypfr0cSdWODjjCEhChgg/payment-details


Request Headers

Content-Type:application/json
Authorization:Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzUxMiJ9.eyJzdWIiOiJUUFAxIiwic2NvcGUiOiJwYXltZW50cyIsImlzcyI6IkFQSV9HVyIsImV4cCI6MTYyMTg3NDAyMCwidG9rZW5fdHlwZSI6IlBVQkxJQyIsImlhdCI6MTYyMTc4NzYyMH0.iJfMcKjGR7YpK5xvUlos8i_lR3BDEQpkxUt_WpravIWDvRKYZ-1IFfpwxCqpbDEHBOJaoDqAhwQbSR6hRu3Z-D9z2XtqLtGGG5ADzTb5CSmhRBcd14TLhgZVg7PvXluQtLCR_U2OvzqlYhqM7VEtWXnnaCDN3VZAG4wqu1TKYPQEs0Gplr0l8YDxMH3NHIeE9Rtgms4KiT5KEw7mIoor1wBJ1kkTBVdFmA-5Z_UcNxtoqKdN7kxJTP3O5nDQjOE-65LiWXNP0wR9uUtJYpRduybHc-EoxfplS2zRT4YqXfsYNQrl7ae5B0xb9UB_4GDJOB40h3C9z4tQr6tg7BJUKg
Accept:application/json
x-idempotency-key:XYZ.51403.MLT.30
x-jws-signature:LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date:Tue, 12 Mar 2021 09:10:17 GMT+3
x-fapi-customer-ip-address:204.35.213.15
x-fapi-interaction-id:75bdc714-b2dg-7676-c759-780d6815689f

A sample successful response:


{
    "Data": {
        "PaymentStatus": [
            {
                "Status": "AcceptedSettlementInProcess",
                "StatusDetail": {}
            }
        ]
    },
    "Links": {
        "Self": "self"
    },
    "Meta": {}
}