v1

latestOpenAPI 3.0.12026-08-0674476716.0 KB

Accounts

Get standing order information

The GET /accounts/{accountId}/standing-orders/{standingOrderId} endpoint retrieves information for a specific standing order in a given account, once consent has been given.

get/accounts/{accountId}/standing-orders/{standingOrderId}

Path parameters

accountIdstring

The system-generated, unique bank account id, which specifies the account for which the information is requested.

standingOrderIdstring required

The unique standing order identifier, which specifies the standing order requested.

Headers

on-behalf-ofstring required

The tokenId represents the consent granted by the user (PSU).

token-customer-ip-addressstring ipv4

The user's IP address if the user is currently logged in with the TPP. If the customer IP address is supplied (recommended), it is inferred that the user is present during the session (<i>i.e.</i>, the request is user-initiated; adding a customer-initiated = true header makes this explicit). For AIS calls, if the customer's IP address is not provided in the request, the bank assumes it is a TPP-initiated request and may limit the TPP to 4 TPP-initiated access attempts within a given 24-hour period.

Response

Successful response

status'INVALID_REQUEST' | 'SUCCESSFUL_REQUEST' | 'MORE_SIGNATURES_NEEDED'

Specifies the status of the request.

Example response

{
  "standingOrder": {
    "creditorEndpoint": {
      "account": {
        "custom": {
          "bankId": "ob-modelo",
          "payload": "sdfjds12-f85-46b0-8058-343dek543grt"
        }
      },
      "accountIdentifier": {
        "bankgiro": {
          "bankgiroNumber": "56781234"
        }
      },
      "bankId": "ob-modelo",
      "bic": "BOFIIE2D",
      "customerData": {
        "address": {
          "city": "Berlin",
          "conscriptionNumber": "2831",
          "country": "DE",
          "district": "Friedrichshain",
          "flats": "21A - 21C",
          "full": "Fifth house on the left after the village oak, Smalltown, Smallcountry",
          "hamlet": "Botzowviertel",
          "houseName": "Grossen Blauen Haus",
          "houseNumber": "123",
          "place": "Arnswalder Platz",
          "postCode": "10243",
          "province": "BC",
          "state": "CA",
          "street": "Hans-Otto-Strasse",
          "subdistrict": "Friedrichshain Nord",
          "suburb": "Altona Meadows Suburb"
        }
      }
    },
    "frequency": "WEEK",
    "id": "tt:83KiRJuXmEDV5m2b8ZvLGE91ELf7PPw5BaDab98kMguu:3VMczyq7r7b6HwC",
    "providerStandingOrderDetails": {
      "cma9StandingOrderDetails": {
        "finalPaymentAmount": {
          "currency": "EUR",
          "value": "10.23"
        },
        "firstPaymentAmount": {
          "currency": "EUR",
          "value": "10.23"
        },
        "frequency": "WEEK",
        "nextPaymentAmount": {
          "currency": "EUR",
          "value": "10.23"
        }
      }
    },
    "status": "PROCESSING",
    "tokenId": "tt:8zK1dic95omjWb72gvc3z3ELKbTNfnGd89MbDnM73er4:ZhBVAJSH8DeU1",
    "tokenSubmissionId": "12345678"
  },
  "status": "SUCCESSFUL_REQUEST"
}