International Standing Order Payment API allows customer initiation of Standing Order Payment for scheduled international SWIFT MT103.
The API endpoint allows the PISP to ask an ASPSP to create a new international-standing-order-consents resource.
Request to create payment consent:
https://host:port/api/bobf/release1.0.0/international-standing-order-consents
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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": {
"Permission": "Create",
"ReadRefundAccount": "No",
"Initiation": {
"Frequency": "EvryDay",
"Reference": "20220629_66",
"FirstPaymentDateTime": "2022-06-29T08:26:39.976+03:00",
"FinalPaymentDateTime": "2022-07-05T08:26:39.976+03:00",
"Purpose": "P0808",
"ExtendedPurpose": "P08082",
"ChargeBearer": "BorneByCreditor",
"CurrencyOfTransfer": "USD",
"DestinationCountryCode": "BHD",
"InstructedAmount": {
"Amount": "7.71",
"Currency": "BHD"
},
"DebtorAccount": {
"SchemeName": "BH.OBF.PAN",
"Identification": "100000003385",
"Name": " Khalid Ahmed Ali"
},
"Creditor": {
"Name": " Ali Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"AddressLine": ["XYZ Bank, Diplomatic Area"],
"StreetName": "Al Barsha",
"BuildingNumber": "27",
"PostCode": "317",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH"
}
},
"CreditorAgent": {
"SchemeName": "BH.OBF.BICFI",
"Identification": "ALSABHB0",
"Name": " Faisal Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"AddressLine": ["Batelco Headquarters"],
"StreetName": "Acacia Avenue",
"BuildingNumber": "27",
"PostCode": "3122",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH"
}
},
"CreditorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "IN20ALSABHB06800274324567246",
"Name": " Ali Hassan Mohammed"
}
},
"Authorisation": {
"AuthorisationType": "Single",
"CompletionDateTime": "2020-07-10T05:16:38.184+03:00"
},
"SCASupportData": {
"RequestedSCAExemptionType": "BillPayment",
"AppliedAuthenticationApproach": "SCA",
"ReferencePaymentOrderId": "936427-2"
}
},
"Risk": {
"PaymentContextCode": "BillPayment",
"MerchantCategoryCode": "002345",
"MerchantCustomerIdentification": "0023456789",
"DeliveryAddress": {
"AddressLine": ["Block 317, Road 1702, Building 96"],
"StreetName": "Route 1888",
"BuildingNumber": "27",
"PostCode": "317",
"TownName": "Manama",
"CountrySubDivision": ["Manama"],
"Country": "BH"
}
}
}
Response:
201 Created
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/json
{
"Data": {
"ConsentId": "B1OYZm1-QMCaNo3n2NI3wA",
"CreationDateTime": "2022-06-29T19:56:26.96+03:00",
"Status": "AwaitingAuthorisation",
"StatusUpdateDateTime": "2022-06-29T19:56:26.96+03:00",
"ReadRefundAccount": "No",
"Permission": "Create",
"Initiation": {
"Frequency": "EvryDay",
"Reference": "20220629_66",
"FirstPaymentDateTime": "2022-06-29T08:26:39.976+03:00",
"FinalPaymentDateTime": "2022-07-05T08:26:39.976+03:00",
"InstructedAmount": {
"Amount": "7.71",
"Currency": "BHD"
},
"Purpose": "P0808",
"ExtendedPurpose": "P08082",
"ChargeBearer": "BorneByCreditor",
"CurrencyOfTransfer": "USD",
"DestinationCountryCode": "BHD",
"DebtorAccount": {
"SchemeName": "BH.OBF.PAN",
"Identification": "100000003385",
"Name": " Khalid Ahmed Ali"
},
"CreditorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "IN20ALSABHB06800274324567246",
"Name": " Ali Hassan Mohammed"
},
"Creditor": {
"Name": " Ali Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"StreetName": "Al Barsha",
"BuildingNumber": "27",
"PostCode": "317",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH",
"AddressLine": [
"XYZ Bank, Diplomatic Area"
]
}
},
"CreditorAgent": {
"SchemeName": "BH.OBF.BICFI",
"Identification": "ALSABHB0",
"Name": " Faisal Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"StreetName": "Acacia Avenue",
"BuildingNumber": "27",
"PostCode": "3122",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH",
"AddressLine": [
"Batelco Headquarters"
]
}
}
},
"Authorisation": {
"AuthorisationType": "Single",
"CompletionDateTime": "2020-07-10T05:16:38.184+03:00"
},
"SCASupportData": {
"RequestedSCAExemptionType": "BillPayment",
"AppliedAuthenticationApproach": "SCA",
"ReferencePaymentOrderId": "936427-2"
}
},
"Risk": {
"PaymentContextCode": "BillPayment",
"MerchantCategoryCode": "002345",
"MerchantCustomerIdentification": "0023456789",
"DeliveryAddress": {
"AddressLine": [
"Block 317, Road 1702, Building 96"
],
"StreetName": "Route 1888",
"BuildingNumber": "27",
"PostCode": "317",
"TownName": "Manama",
"CountrySubDivision": [
"Manama"
],
"Country": "BH"
}
},
"Links": {
"Self": "https://pg:9045/authpage/spoConsentId/B1OYZm1-QMCaNo3n2NI3wA"
}
}
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-standing-order-consents/B1OYZm1-QMCaNo3n2NI3wA
Request:
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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": {
"ConsentId": "B1OYZm1-QMCaNo3n2NI3wA",
"CreationDateTime": "2022-06-29T19:56:26+03:00",
"Status": "Consumed",
"StatusUpdateDateTime": "2022-06-29T19:57:33+03:00",
"ReadRefundAccount": "No",
"Permission": "Create",
"Initiation": {
"Frequency": "EvryDay",
"Reference": "20220629_66",
"FirstPaymentDateTime": "2022-06-29T08:26:39.976+03:00",
"FinalPaymentDateTime": "2022-07-05T08:26:39.976+03:00",
"InstructedAmount": {
"Amount": "7.71",
"Currency": "BHD"
},
"Purpose": "P0808",
"ExtendedPurpose": "P08082",
"ChargeBearer": "BorneByCreditor",
"CurrencyOfTransfer": "USD",
"DestinationCountryCode": "BHD",
"DebtorAccount": {
"SchemeName": "BH.OBF.PAN",
"Identification": "100000003385",
"Name": " Khalid Ahmed Ali"
},
"CreditorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "IN20ALSABHB06800274324567246",
"Name": " Ali Hassan Mohammed"
},
"Creditor": {
"Name": " Ali Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"StreetName": "Al Barsha",
"BuildingNumber": "27",
"PostCode": "317",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH",
"AddressLine": [
"XYZ Bank, Diplomatic Area"
]
}
},
"CreditorAgent": {
"SchemeName": "BH.OBF.BICFI",
"Identification": "ALSABHB0",
"Name": " Faisal Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"StreetName": "Acacia Avenue",
"BuildingNumber": "27",
"PostCode": "3122",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH"
}
}
},
"Authorisation": {
"AuthorisationType": "Single",
"CompletionDateTime": "2020-07-10T05:16:38.184+03:00"
},
"SCASupportData": {
"RequestedSCAExemptionType": "BillPayment",
"AppliedAuthenticationApproach": "SCA",
"ReferencePaymentOrderId": "936427-2"
}
},
"Risk": {
"PaymentContextCode": "BillPayment",
"MerchantCategoryCode": "002345",
"MerchantCustomerIdentification": "0023456789",
"DeliveryAddress": {
"AddressLine": [
"Block 317, Road 1702, Building 96"
],
"StreetName": "Route 1888",
"BuildingNumber": "27",
"PostCode": "317",
"TownName": "Manama",
"CountrySubDivision": [
"Manama"
],
"Country": "BH"
}
},
"Links": {
"Self": "https://pg:9045/authpage/spoConsentId/B1OYZm1-QMCaNo3n2NI3wA"
}
}
Once the international-standing-order-consents has been authorised by the user/customer, the PISP should proceed to submit the international-standing-orders for processing.
Request to initiate International standing orders:
https://host:port/api/bobf/release1.0.0/international-standing-orders
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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": {
"ConsentId": "B1OYZm1-QMCaNo3n2NI3wA",
"Initiation": {
"Frequency": "EvryDay",
"Reference": "20220629_66",
"FirstPaymentDateTime": "2022-06-29T08:26:39.976+03:00",
"FinalPaymentDateTime": "2022-07-05T08:26:39.976+03:00",
"Purpose": "P0808",
"ExtendedPurpose": "P08082",
"ChargeBearer": "BorneByCreditor",
"CurrencyOfTransfer": "USD",
"DestinationCountryCode": "BHD",
"InstructedAmount": {
"Amount": "7.71",
"Currency": "BHD"
},
"DebtorAccount": {
"SchemeName": "BH.OBF.PAN",
"Identification": "100000003385",
"Name": " Khalid Ahmed Ali"
},
"Creditor": {
"Name": " Ali Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"AddressLine": ["XYZ Bank, Diplomatic Area"],
"StreetName": "Al Barsha",
"BuildingNumber": "27",
"PostCode": "317",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH"
}
},
"CreditorAgent": {
"SchemeName": "BH.OBF.BICFI",
"Identification": "ALSABHB0",
"Name": " Faisal Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"AddressLine": ["Batelco Headquarters"],
"StreetName": "Acacia Avenue",
"BuildingNumber": "27",
"PostCode": "3122",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH"
}
},
"CreditorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "IN20ALSABHB06800274324567246",
"Name": " Ali Hassan Mohammed"
}
}
},
"Risk": {
"PaymentContextCode": "BillPayment",
"MerchantCategoryCode": "002345",
"MerchantCustomerIdentification": "0023456789",
"DeliveryAddress": {
"AddressLine": ["Block 317, Road 1702, Building 96"],
"StreetName": "Route 1888",
"BuildingNumber": "27",
"PostCode": "317",
"TownName": "Manama",
"CountrySubDivision": ["Manama"],
"Country": "BH"
}
}
}
Response:
201 Created
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-interaction-id: 75bdc714-b2dg-7676-c759-780d6815689f
Content-Type: application/jsonson
{
"Data": {
"InternationalStandingOrderId": "B1OYZm1-QMCaNo3n2NI3wA",
"ConsentId": "B1OYZm1-QMCaNo3n2NI3wA",
"CreationDateTime": "2022-06-29T19:56:26+03:00",
"Status": "InitiationCompleted",
"StatusUpdateDateTime": "2022-06-29T19:57:33.807+03:00",
"Initiation": {
"Frequency": "EvryDay",
"Reference": "20220629_66",
"FirstPaymentDateTime": "2022-06-29T08:26:39.976+03:00",
"FinalPaymentDateTime": "2022-07-05T08:26:39.976+03:00",
"InstructedAmount": {
"Amount": "7.71",
"Currency": "BHD"
},
"Purpose": "P0808",
"ExtendedPurpose": "P08082",
"ChargeBearer": "BorneByCreditor",
"CurrencyOfTransfer": "USD",
"DestinationCountryCode": "BHD",
"DebtorAccount": {
"SchemeName": "BH.OBF.PAN",
"Identification": "100000003385",
"Name": " Khalid Ahmed Ali"
},
"CreditorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "IN20ALSABHB06800274324567246",
"Name": " Ali Hassan Mohammed"
},
"Creditor": {
"Name": " Ali Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"StreetName": "Al Barsha",
"BuildingNumber": "27",
"PostCode": "317",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH",
"AddressLine": [
"XYZ Bank, Diplomatic Area"
]
}
},
"CreditorAgent": {
"SchemeName": "BH.OBF.BICFI",
"Identification": "ALSABHB0",
"Name": " Faisal Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"StreetName": "Acacia Avenue",
"BuildingNumber": "27",
"PostCode": "3122",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH",
"AddressLine": [
"Batelco Headquarters"
]
}
}
}
},
"Links": {
"Self": "https://pg:9045/authpage"
}
}
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-standing-orders/B1OYZm1-QMCaNo3n2NI3wA
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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: V2hhdCB3ZSBnb3QgaGVyZQ0K..aXMgZmFpbHVyZSB0byBjb21tdW5pY2F0ZQ0K
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"InternationalStandingOrderId": "B1OYZm1-QMCaNo3n2NI3wA",
"ConsentId": "B1OYZm1-QMCaNo3n2NI3wA",
"CreationDateTime": "2022-06-29T19:56:26+03:00",
"Status": "InitiationCompleted",
"StatusUpdateDateTime": "2022-06-29T19:57:33+03:00",
"Initiation": {
"Frequency": "EvryDay",
"Reference": "20220629_66",
"FirstPaymentDateTime": "2022-06-29T08:26:39.976+03:00",
"FinalPaymentDateTime": "2022-07-05T08:26:39.976+03:00",
"InstructedAmount": {
"Amount": "7.71",
"Currency": "BHD"
},
"Purpose": "P0808",
"ExtendedPurpose": "P08082",
"ChargeBearer": "BorneByCreditor",
"CurrencyOfTransfer": "USD",
"DestinationCountryCode": "BHD",
"DebtorAccount": {
"SchemeName": "BH.OBF.PAN",
"Identification": "100000003385",
"Name": " Khalid Ahmed Ali"
},
"CreditorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "IN20ALSABHB06800274324567246",
"Name": " Ali Hassan Mohammed"
},
"Creditor": {
"Name": " Ali Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"StreetName": "Al Barsha",
"BuildingNumber": "27",
"PostCode": "317",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH",
"AddressLine": [
"XYZ Bank, Diplomatic Area"
]
}
},
"CreditorAgent": {
"SchemeName": "BH.OBF.BICFI",
"Identification": "ALSABHB0",
"Name": " Faisal Hassan Mohammed",
"PostalAddress": {
"AddressType": "Business",
"StreetName": "Acacia Avenue",
"BuildingNumber": "27",
"PostCode": "3122",
"TownName": "Manama",
"CountrySubDivision": "Manama",
"Country": "BH"
}
}
}
},
"Links": {
"Self": "https://pg:9045/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-standing-orders/B1OYZm1-QMCaNo3n2NI3wA/payment-details
Authorisation: Bearer 4ZopnFZFKjr5zDsicSQpLL
x-idempotency-key: XYZ.51403.MLT.30
x-jws-signature: LMlmPSqzISEpar72ce5deMGue4RsZMDnZYG1bW6hdPlvriZ=..G1rrM18vVYBmdmRurS6nIR1yFHR8bGZyIJdvaB5nKGRvm35hTr==
x-fapi-auth-date: Tue, 18 Mar 2022 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:
{
"Data": {
"PaymentStatus": []
}
}