After successfull authorisation of account access consent an AISP may retreive account standing orders using GET endpoints.
Required permissions: ReadStandingOrdersBasic or ReadStandingOrdersDetail (the most detailed level).
Related security requirements: request must contain consent access token.
Request:
GET https://bank:8745/api/bobf/release1.0.0/accounts/standing-orders
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
Accept: application/json
Response:
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"StandingOrder": [
{
"AccountId": "00345897",
"StandingOrderId": "2276",
"Frequency": "Monthly",
"Reference": "Bill payment",
"FirstPaymentDateTime": "2020-03-26T10:54:49.225+03:00",
"NextPaymentDateTime": "2020-04-26T10:54:49.225+03:00",
"LastPaymentDateTime": "2020-02-26T10:54:49.225+03:00",
"FinalPaymentDateTime": "2020-10-26T10:54:49.225+03:00",
"NumberOfPayments": "8",
"StandingOrderStatusCode": "Active",
"FirstPaymentAmount": {
"Amount": "1000",
"Currency": "BHD"
},
"NextPaymentAmount": {
"Amount": "1000",
"Currency": "BHD"
},
"LastPaymentAmount": {
"Amount": "1000",
"Currency": "BHD"
},
"FinalPaymentAmount": {
"Amount": "1000",
"Currency": "BHD"
},
"CreditorAgent": {
"SchemeName": "BH.OBF.BBAN",
"Identification": "BH10XYZU00100000001789"
},
"CreditorAccount": {
"SchemeName": "BH.OBF.BBAN",
"Identification": "BH10XYZU00100000008876",
"Name": "Khalid Ahmed Ali",
}
},
{
"AccountId": "00135678",
"StandingOrderId": "2277",
"Frequency": "Monthly",
"Reference": "Instalment",
"FirstPaymentDateTime": "2020-03-26T10:54:49.225+03:00",
"NextPaymentDateTime": "2020-04-26T10:54:49.225+03:00",
"LastPaymentDateTime": "2020-02-26T10:54:49.225+03:00",
"FinalPaymentDateTime": "2020-10-26T10:54:49.225+03:00",
"NumberOfPayments": "8",
"StandingOrderStatusCode": "Active",
"FirstPaymentAmount": {
"Amount": "1200",
"Currency": "BHD"
},
"NextPaymentAmount": {
"Amount": "1200",
"Currency": "BHD"
},
"LastPaymentAmount": {
"Amount": "1200",
"Currency": "BHD"
},
"FinalPaymentAmount": {
"Amount": "1200",
"Currency": "BHD"
},
"CreditorAgent": {
"SchemeName": "BH.OBF.BICFI",
"Identification": "BH10BBKU00100000001789"
},
"CreditorAccount": {
"SchemeName": "BH.OBF.IBAN",
"Identification": "BH10XYZU00100000006789",
"Name": "Mohammed Ahmed Abdulla"
}
}]
},
"Links": {
"Self": "www.bank.com"
},
"Meta": {
"TotalPages": "01",
"FirstAvailableDateTime": "2020-03-26T09:10:17.596+03:00",
"LastAvailableDateTime": "2020-03-26T09:10:17.596+03:00"
}
}
An AISP may retrieve the standing order resource for a specific AccountId (which is retrieved in the call to GET /accounts).
Required permissions: ReadStandingOrdersBasic or ReadStandingOrdersDetail (the most detailed level).
Related security requirements: request must contain consent access token.
Request:
GET https://bank:8745/api/bobf/release1.0.0/accounts/_e-VLgkAQ-qYxFvW6vb64g/standing-orders
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
Accept: application/json
Response:
HTTP/1.1 200 OK
x-fapi-interaction-id: 93bac548-d2de-4546-b106-880a5018460d
Content-Type: application/json
{
"Data": {
"StandingOrder": [
{
"AccountId": "00345897",
"StandingOrderId": "2276",
"Frequency": "Monthly",
"Reference": "Bill payment",
"FirstPaymentDateTime": "2020-03-26T10:54:49.225+03:00",
"NextPaymentDateTime": "2020-04-26T10:54:49.225+03:00",
"LastPaymentDateTime": "2020-02-26T10:54:49.225+03:00",
"FinalPaymentDateTime": "2020-10-26T10:54:49.225+03:00",
"NumberOfPayments": "8",
"StandingOrderStatusCode": "Active",
"FirstPaymentAmount": {
"Amount": "1000",
"Currency": "BHD"
},
"NextPaymentAmount": {
"Amount": "1000",
"Currency": "BHD"
},
"LastPaymentAmount": {
"Amount": "1000",
"Currency": "BHD"
},
"FinalPaymentAmount": {
"Amount": "1000",
"Currency": "BHD"
},
"CreditorAgent": {
"SchemeName": "BH.OBF.BBAN",
"Identification": "BH10XYZU00100000001789"
},
"CreditorAccount": {
"SchemeName": "BH.OBF.BBAN",
"Identification": "BH10XYZU00100000008876",
"Name": "Khalid Ahmed Ali",
}
}]
},
"Links": {
"Self": "www.TBC.com"
},
"Meta": {
"TotalPages": "01",
"FirstAvailableDateTime": "2020-03-26T09:10:17.596+03:00",
"LastAvailableDateTime": "2020-03-26T09:10:17.596+03:00"
}
}