Single International Payment API allows customer initiation of international SWIFT MT103 payments.
The API endpoint allows the PISP to ask an ASPSP to create a new international-payment-consents resource.
Request:
https://host:port/api/bobf/release1.0.0/international-payment-consents
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
Accept: application/json
{
"Data" : {
"ReadRefundAccount" : "No",
"SCASupportData" : {
"AppliedAuthenticationApproach" : "SCA",
"ReferencePaymentOrderId" : "936427-2"
},
"Authorisation" : {
"AuthorisationType" : "Single",
"CompletionDateTime" : "2020-03-19T06:17:39.597+03:00"
},
"Initiation" : {
"InstructionIdentification" : "0616I568",
"EndToEndIdentification" : "20190616B002",
"LocalInstrument" : "BH.OBF.SWIFT",
"InstructedAmount" : {
"Amount" : "27.60",
"Currency" : "BHD"
},
"CreditorAccount" : {
"SchemeName" : "BH.OBF.IBAN",
"Identification" : "KW47BAYT0000002203202111111111",
"Name" : "Ali Hassan Mohammed"
},
"CurrencyOfTransfer" : "BHD",
"ExchangeRateInformation" : {
"UnitCurrency" : "USD",
"ExchangeRate" : "30",
"RateType" : "Agreed",
"ContractIdentification" : "FEC"
}
}
},
"Risk" : {
"PaymentContextCode" : "BillPayment",
"MerchantCategoryCode" : "4444",
"MerchantCustomerIdentification" : "0023456789",
"DeliveryAddress" : {
"AddressLine" : [ "XYZ Bank, Diplomatic Area" ],
"StreetName" : "Al Barsha",
"BuildingNumber" : "27",
"PostCode" : "317",
"TownName" : "Kuwait",
"CountrySubDivision" : "",
"Country" : "KW"
}
}
}
Response:
201 Created
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
{
"Risk" : {
"PaymentContextCode" : "BillPayment",
"MerchantCategoryCode" : "4444",
"MerchantCustomerIdentification" : "0023456789",
"DeliveryAddress" : {
"AddressLine" : [ "XYZ Bank, Diplomatic Area" ],
"StreetName" : "Al Barsha",
"BuildingNumber" : "27",
"PostCode" : "317",
"TownName" : "Kuwait",
"CountrySubDivision" : "",
"Country" : "KW"
}
},
"Data" : {
"ConsentId" : "BHGlHBaIS_GY5m6eH3BdeQ",
"CreationDateTime" : "2021-04-27T19:09:28.315+03:00",
"Status" : "AwaitingAuthorisation",
"StatusUpdateDateTime" : "2021-04-27T19:09:28.315+03:00",
"ReadRefundAccount" : "No",
"CutOffDateTime" : "",
"ExpectedExecutionDateTime" : "",
"ExpectedSettlementDateTime" : "",
"Initiation" : {
"InstructionIdentification" : "0616I568",
"EndToEndIdentification" : "20190616B002",
"LocalInstrument" : "BH.OBF.SWIFT",
"InstructedAmount" : {
"Amount" : "27.60",
"Currency" : "BHD"
},
"CreditorAccount" : {
"SchemeName" : "BH.OBF.IBAN",
"Identification" : "KW47BAYT0000002203202111111111",
"Name" : "Ali Hassan Mohammed"
},
"CurrencyOfTransfer" : "BHD",
"ExchangeRateInformation" : {
"UnitCurrency" : "USD",
"ExchangeRate" : "30",
"RateType" : "Agreed",
"ContractIdentification" : "FEC"
}
},
"SCASupportData" : {
"AppliedAuthenticationApproach" : "SCA",
"ReferencePaymentOrderId" : "936427-2"
},
"Authorisation" : {
"AuthorisationType" : "Single",
"CompletionDateTime" : "2020-03-19T06:17:39.597+03:00"
},
"Charges" : "",
"ExchangeRateInformation" : "",
"Debtor" : ""
},
"Links" : {
"Self" : "https://host:port/authpage/paymentConsentId/BHGlHBaIS_GY5m6eH3BdeQ"
}
}
A PISP can optionally retrieve a payment resource that has been created to check its status.
https://host:port/api/bobf/release1.0.0/international-payment-consents/VaMsiY0-SOK9JjjXpBKDvA
Request:
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
Accept: application/json
Response:
200 OK
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
{
"Risk" : {
"PaymentContextCode" : "BillPayment",
"MerchantCategoryCode" : "4444",
"MerchantCustomerIdentification" : "0023456789",
"DeliveryAddress" : {
"AddressLine" : [ "XYZ Bank, Diplomatic Area" ],
"StreetName" : "Al Barsha",
"BuildingNumber" : "27",
"PostCode" : "317",
"TownName" : "Kuwait",
"CountrySubDivision" : "",
"Country" : "KW"
}
},
"Data" : {
"ConsentId" : "VaMsiY0-SOK9JjjXpBKDvA",
"CreationDateTime" : "2021-04-23T17:35:15.581+03:00",
"Status" : "AwaitingAuthorisation",
"StatusUpdateDateTime" : "2021-04-23T17:35:15.581+03:00",
"ReadRefundAccount" : "Yes",
"CutOffDateTime" : "",
"ExpectedExecutionDateTime" : "",
"ExpectedSettlementDateTime" : "",
"Initiation" : {
"InstructionIdentification" : "0816I5744",
"EndToEndIdentification" : "20190616B002",
"LocalInstrument" : "BH.OBF.GCCNET",
"InstructedAmount" : {
"Amount" : "100",
"Currency" : "USD"
},
"DebtorAccount" : {
"SchemeName" : "BH.OBF.IBAN",
"Identification" : "BH81BBKU00100000005211",
"Name" : "Khalid Ahmed Ali"
},
"CreditorAccount" : {
"SchemeName" : "BH.OBF.IBAN",
"Identification" : "KW47BAYT0000002203202111111111",
"Name" : "Ali Hassan Mohammed"
},
"RemittanceInformation" : {
"Reference" : "XYZ-101",
"RemittanceDescription" : "External Ops Code 34251"
},
"InstructionPriority" : "Urgent",
"Purpose" : "AGRT",
"ExtendedPurpose" : "AGRT",
"ChargeBearer" : "BorneByCreditor",
"CurrencyOfTransfer" : "BHD",
"DestinationCountryCode" : "KW",
"ExchangeRateInformation" : {
"UnitCurrency" : "BHD",
"RateType" : "Actual"
},
"Creditor" : {
"Name" : "Ali Hassan Mohammed",
"PostalAddress" : {
"AddressType" : "Business",
"StreetName" : "Al Barsha",
"BuildingNumber" : "27",
"PostCode" : "317",
"TownName" : "Kuwait",
"Country" : "KW",
"AddressLine" : [ "XYZ Bank, Diplomatic Area" ]
}
},
"CreditorAgent" : {
"SchemeName" : "BH.OBF.BICFI",
"Identification" : "BAYTKWK1",
"Name" : "BAYT AL MAL INVESTMENT COMPANY",
"PostalAddress" : {
"AddressType" : "Business",
"StreetName" : "Acacia Avenue",
"BuildingNumber" : "27",
"PostCode" : "3122",
"TownName" : "Kuwait",
"Country" : "KW",
"AddressLine" : [ "Batelco Headquarters" ]
}
}
},
"SCASupportData" : {
"AppliedAuthenticationApproach" : "SCA",
"ReferencePaymentOrderId" : "936427-2"
},
"Authorisation" : {
"AuthorisationType" : "Single",
"CompletionDateTime" : "2020-03-19T06:17:39.597+03:00"
},
"Charges" : "",
"ExchangeRateInformation" : "",
"Debtor" : ""
}
}
A PISP to ask an ASPSP to confirm funds on a international-payment-consents resource.
https://host:port/api/bobf/release1.0.0/international-payment-consents/nwyUJ7mOS3eluGMSyF9kdQ/funds-confirmation
Request:
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-fapi-auth-date: Tue, 18 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 204.35.213.15
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
Accept: application/json
Response:
200 OK
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
{
"Data" : {
"FundsAvailableResult" : {
"FundsAvailableDateTime" : "2021-04-27T14:53:52.219+03:00",
"FundsAvailable" : true
}
}
}
Once the international-payment-consents has been authorised by the user/customer, the PISP should proceed to submit the international-payment for processing.
Request:
https://host:port/api/bobf/release1.0.0/international-payments
{
"Data" : {
"ConsentId" : "aqfJ--S_RFyEJodOyRDU8g",
"Initiation" : {
"InstructionIdentification" : "0626I543",
"EndToEndIdentification" : "20190616B002",
"LocalInstrument" : "BH.OBF.SWIFT",
"InstructedAmount" : {
"Amount" : "500.60",
"Currency" : "BHD"
},
"CreditorAccount" : {
"SchemeName" : "BH.OBF.IBAN",
"Identification" : "KW47BAYT0000002203202111111111",
"Name" : "Ali Hassan Mohammed"
},
"CurrencyOfTransfer" : "BHD",
"ExchangeRateInformation" : {
"UnitCurrency" : "BHD",
"ExchangeRate" : "0.378",
"RateType" : "Agreed",
"ContractIdentification" : "FEC"
}
}
},
"Risk" : {
"PaymentContextCode" : "BillPayment",
"MerchantCategoryCode" : "5555",
"MerchantCustomerIdentification" : "0023456789",
"DeliveryAddress" : {
"AddressLine" : [ "XYZ Bank, Diplomatic Area" ],
"StreetName" : "Al Barsha",
"BuildingNumber" : "27",
"PostCode" : "317",
"TownName" : "Kuwait",
"CountrySubDivision" : null,
"Country" : "KW"
}
}
}
Response:
201 Created
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
{
"Data" : {
"ConsentId" : "aqfJ--S_RFyEJodOyRDU8g",
"CreationDateTime" : "2021-04-26T12:05:06+03:00",
"Status" : "Pending",
"StatusUpdateDateTime" : "2021-04-26T12:06:14.965+03:00",
"ReadRefundAccount" : "No",
"CutOffDateTime" : null,
"ExpectedExecutionDateTime" : null,
"ExpectedSettlementDateTime" : null,
"Initiation" : {
"InstructionIdentification" : "0626I543",
"EndToEndIdentification" : "20190616B002",
"LocalInstrument" : "BH.OBF.SWIFT",
"InstructedAmount" : {
"Amount" : "500.60",
"Currency" : "BHD"
},
"CreditorAccount" : {
"SchemeName" : "BH.OBF.IBAN",
"Identification" : "KW47BAYT0000002203202111111111",
"Name" : "Ali Hassan Mohammed"
},
"CurrencyOfTransfer" : "BHD",
"ExchangeRateInformation" : {
"UnitCurrency" : "BHD",
"ExchangeRate" : "0.378",
"RateType" : "Agreed",
"ContractIdentification" : "FEC"
}
},
"Charges" : null,
"ExchangeRateInformation" : null,
"Debtor" : null,
"Refund" : null
}
}
A PISP can optionally retrieve a payment resource that has been created to check its status.
Request:
https://host:port/api/bobf/release1.0.0/international-payments/aqfJ--S_RFyEJodOyRDU8g
Authorisation: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-auth-date: Tue, 17 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json
Accept: application/json
Response:
200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data" : {
"ConsentId" : "aqfJ--S_RFyEJodOyRDU8g",
"CreationDateTime" : "2021-04-26T12:05:06+03:00",
"Status" : "Pending",
"StatusUpdateDateTime" : "2021-04-26T12:06:14.965+03:00",
"ReadRefundAccount" : "No",
"CutOffDateTime" : null,
"ExpectedExecutionDateTime" : null,
"ExpectedSettlementDateTime" : null,
"Initiation" : {
"InstructionIdentification" : "0626I543",
"EndToEndIdentification" : "20190616B002",
"LocalInstrument" : "BH.OBF.SWIFT",
"InstructedAmount" : {
"Amount" : "500.60",
"Currency" : "BHD"
},
"CreditorAccount" : {
"SchemeName" : "BH.OBF.IBAN",
"Identification" : "KW47BAYT0000002203202111111111",
"Name" : "Ali Hassan Mohammed"
},
"CurrencyOfTransfer" : "BHD",
"ExchangeRateInformation" : {
"UnitCurrency" : "BHD",
"ExchangeRate" : "0.378",
"RateType" : "Agreed",
"ContractIdentification" : "FEC"
}
},
"Charges" : null,
"ExchangeRateInformation" : null,
"Debtor" : null,
"Refund" : null
},
"Links" : {
"Self" : "https://host:port/authpage"
}
}
A PISP can retrieve the Details of the underlying payment transaction via this endpoint. This resource allows ASPSPs to return richer list of Payment Statuses, and if available payment scheme related statuses.
Request:
https://host:port/api/bobf/release1.0.0/international-payments/nwyUJ7mOS3eluGMSyF9kdQ/payment-details
Authorisation: Bearer 2YotnFZFEjr1zCsicMWpAA
x-fapi-auth-date: Tue, 17 Mar 2020 19:43:31 GMT+03:00
x-fapi-customer-ip-address: 104.25.212.99
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d Accept: application/json
Accept: application/json
Response:
200 OK
x-jws-signature: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data" : {
"PaymentStatus" : [ {
"PaymentTransactionId" : "nwyUJ7mOS3eluGMSyF9kdQ",
"Status" : "AcceptedCreditSettlementCompleted",
"StatusUpdateDateTime" : "2020-03-12T09:42:25.959+03:00",
"StatusDetail" : { }
} ]
}