--- swagger: "2.0" info: title: Subscription API description: Subscriptions Swagger Specification version: 1.0.6 contact: name: Nedbank API Marketplace license: name: TBD x-ibm-name: subscription-api name: "" basePath: /open-banking/v1 schemes: - https consumes: - application/json produces: - application/json - cc309236 paths: /subscriptions: post: summary: Create subscription operationId: CreateSubscription responses: 200: description: A successful response. schema: $ref: '#/definitions/subscriptionsSubscriptionResponse' 400: description: Bad Request 401: description: Unauthorized 403: description: Forbidden 429: description: Too Many Requests 500: description: Internal Server Error parameters: - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' - name: body in: body required: true schema: $ref: '#/definitions/subscriptionsCreateSubscriptionRequestBody' tags: - SubscriptionsService security: - TPPOAuth2Security: - tpp_client_credential /subscriptions/{subscription_id}: get: summary: Get Subscription based on subscription id operationId: GetSubscription responses: 200: description: A successful response. schema: $ref: '#/definitions/subscriptionsSubscriptionResponse' 400: description: Bad Request 401: description: Unauthorized 403: description: Forbidden 429: description: Too Many Requests 500: description: Internal Server Error parameters: - name: subscription_id in: path required: true type: string - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' tags: - SubscriptionsService security: - TPPOAuth2Security: - tpp_client_credential delete: summary: delete subscription operationId: DeleteSubscription responses: 200: description: A successful response. schema: $ref: '#/definitions/subscriptionsSubscriptionResponse' 400: description: Bad Request 401: description: Unauthorized 403: description: Forbidden 429: description: Too Many Requests 500: description: Internal Server Error parameters: - name: subscription_id in: path required: true type: string - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' tags: - SubscriptionsService security: - TPPOAuth2Security: - tpp_client_credential put: summary: update subscription operationId: UpdateSubscription responses: 200: description: A successful response. schema: $ref: '#/definitions/subscriptionsSubscriptionResponse' 400: description: Bad Request 401: description: Unauthorized 403: description: Forbidden 429: description: Too Many Requests 500: description: Internal Server Error parameters: - name: subscription_id in: path required: true type: string - $ref: '#/parameters/x-fapi-financial-id-Param' - $ref: '#/parameters/x-fapi-customer-last-logged-time-Param' - $ref: '#/parameters/x-fapi-customer-ip-address-Param' - $ref: '#/parameters/x-fapi-interaction-id-Param' - $ref: '#/parameters/AuthorizationParam' - $ref: '#/parameters/x-customer-user-agent-Param' - name: body in: body required: true schema: $ref: '#/definitions/subscriptionsUpdateSubscriptionRequestBody' tags: - SubscriptionsService security: - TPPOAuth2Security: - tpp_client_credential securityDefinitions: X-IBM-Client-Secret: type: apiKey description: "" in: header name: X-IBM-Client-Secret X-IBM-Client-Id: type: apiKey description: "" in: header name: X-IBM-Client-Id TPPOAuth2Security: type: oauth2 flow: application tokenUrl: https://api.nedbank.co.za/apimarket/sandbox/nboauth/oauth20/token scopes: tpp_client_credential: TPP Client Credential Scope description: TPP client credential authorisation flow with the ASPSP x-tokenIntrospect: url: https://api-market.nedsecure.nednet.co.za/mga/sps/oauth/oauth20/introspect parameters: x-fapi-financial-id-Param: in: header name: x-fapi-financial-id type: string required: true description: The unique id of the ASPSP to which the request is issued. The unique id will be issued by OB. x-fapi-customer-ip-address-Param: in: header name: x-fapi-customer-ip-address type: string required: false description: The PSU's IP address if the PSU is currently logged in with the TPP. x-fapi-interaction-id-Param: in: header name: x-fapi-interaction-id type: string required: false description: An RFC4122 UID used as a correlation id. x-fapi-customer-last-logged-time-Param: in: header name: x-fapi-customer-last-logged-time type: string required: false description: "The time when the PSU last logged in with the TPP. \nAll dates in the HTTP headers are represented as RFC 7231 Full Dates. An example is below: \nSun, 10 Sep 2017 19:43:31 UTC" pattern: ^(Mon|Tue|Wed|Thu|Fri|Sat|Sun), \d{2} (Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec) \d{4} \d{2}:\d{2}:\d{2} (GMT|UTC)$ AuthorizationParam: in: header name: Authorization type: string required: true description: An Authorisation Token as per https://tools.ietf.org/html/rfc6750 x-customer-user-agent-Param: in: header name: x-customer-user-agent type: string description: Indicates the user-agent that the PSU is using. required: false definitions: subscriptionsCreateSubscriptionRequestBody: type: object properties: Data: $ref: '#/definitions/subscriptionsData' subscriptionsData: type: object properties: SubscriptionId: type: string Status: type: string CreationDateTime: type: string format: date-time Permissions: type: array items: $ref: '#/definitions/subscriptionsPermissions' ExpirationDateTime: type: string format: date-time subscriptionsPermissions: type: string enum: - ACCESS_FINANCIAL_INFO - VERIFY_IDENTIFICATION - ACCESS_CUSTOMER_INFO - APPLY_FOR_LOAN - APPLY_FOR_PERSONAL_FUNERAL_INSURANCE subscriptionsSubscriptionResponse: type: object properties: Data: $ref: '#/definitions/subscriptionsData' subscriptionsUpdateSubscriptionRequestBody: type: object properties: Data: $ref: '#/definitions/subscriptionsData' x-ibm-configuration: enforced: true testable: true phase: realized security: - X-IBM-Client-Secret: [] X-IBM-Client-Id: [] TPPOAuth2Security: - tpp_client_credential x-ibm-endpoints: - endpointUrl: https://api.nedbank.co.za/apimarket/sandbox type: - production ...