openapi: 3.0.1
info:
  title: Balad Gateway APIs/Authentication APIs/Core/Secrets API
  description: Balad Gateway APIs — a suite of RESTful endpoints for secure inward cross-border remittances and payouts into Egypt (bank transfers, mobile wallets, cash pickup). Covers authentication, exchange rates, balance, secrets management, lookups, and the full transaction lifecycle. Assembled by API Evangelist from the provider's per-operation OpenAPI fragments published on developers.balad.tech.
  version: 1.0.0
  contact:
    name: Balad Support
    email: support@balad.me
    url: https://developers.balad.tech/
servers: []
tags:
- name: APIs/Core/Secrets
paths:
  /core/v1/developer/secrets/delete:
    post:
      summary: Delete Secret
      deprecated: false
      description: Remove an existing client secret using its unique secret ID.
      tags:
      - APIs/Core/Secrets
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                secret_id:
                  type: integer
              required:
              - secret_id
              x-apidog-orders:
              - secret_id
            example:
              secret_id: 90
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: 'null'
                  errors:
                    type: 'null'
                required:
                - data
                - errors
                x-apidog-orders:
                - data
                - errors
              example:
                data: null
                errors: null
          headers: {}
          x-apidog-name: Success
      security:
      - Balad Token: []
        x-apidog:
          required: true
          schemeGroups:
          - id: 87aTaQp8pR3_G2Uh_UKds
            schemeIds:
            - Balad Token
          use:
            id: 87aTaQp8pR3_G2Uh_UKds
      x-apidog-folder: APIs/Core/Secrets
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/1056134/apis/api-20919912-run
  /core/v1/developer/secrets:
    post:
      summary: Generate Secret
      deprecated: false
      description: Generate a new client secret by providing a name and an expiration date.
      tags:
      - APIs/Core/Secrets
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                secret_name:
                  type: string
                expiration_date:
                  type: string
              required:
              - secret_name
              - expiration_date
              x-apidog-orders:
              - secret_name
              - expiration_date
            example:
              secret_name: string
              expiration_date: 20-Jun-2025
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: object
                    properties:
                      id:
                        type: integer
                      client_id:
                        type: string
                      secret_value:
                        type: string
                      expiration_date:
                        type: string
                    required:
                    - id
                    - client_id
                    - secret_value
                    - expiration_date
                    x-apidog-orders:
                    - id
                    - client_id
                    - secret_value
                    - expiration_date
                  errors:
                    type: 'null'
                required:
                - data
                - errors
                x-apidog-orders:
                - data
                - errors
              example:
                data:
                  id: 10
                  client_id: xxxxxxxxxxxxxxxxxxxxxxxxxx
                  secret_value: xxxxxxxxxxxxxxxxxxxxxxxxxx
                  expiration_date: 19-Jun-2025 09:00 PM
                errors: null
          headers: {}
          x-apidog-name: Success
      security:
      - Balad Token: []
        x-apidog:
          required: true
          schemeGroups:
          - id: 87aTaQp8pR3_G2Uh_UKds
            schemeIds:
            - Balad Token
          use:
            id: 87aTaQp8pR3_G2Uh_UKds
      x-apidog-folder: APIs/Core/Secrets
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/1056134/apis/api-20919911-run
    get:
      summary: Get Secrets
      deprecated: false
      description: Retrieve a list of all existing client secrets associated with your account.
      tags:
      - APIs/Core/Secrets
      parameters:
      - name: Content-Type
        in: header
        description: ''
        required: false
        example: application/json
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties: {}
            examples: {}
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      type: object
                      properties:
                        secret_id:
                          type: integer
                        secret_name:
                          type: string
                        masked_secret:
                          type: string
                        expiration_date:
                          type: string
                        secret_status:
                          type: integer
                        secret_status_description:
                          type: string
                      required:
                      - secret_id
                      - secret_name
                      - masked_secret
                      - expiration_date
                      - secret_status
                      - secret_status_description
                      x-apidog-orders:
                      - secret_id
                      - secret_name
                      - masked_secret
                      - expiration_date
                      - secret_status
                      - secret_status_description
                  errors:
                    type: 'null'
                required:
                - data
                - errors
                x-apidog-orders:
                - data
                - errors
              example:
                data:
                - secret_id: 1
                  secret_name: MALL
                  masked_secret: CfDJXXXXXXXXXXXXXXXXXXXXXXXXbV
                  expiration_date: 05-May-2025
                  secret_status: 1
                  secret_status_description: Active
                - secret_id: 5
                  secret_name: ss
                  masked_secret: Ja98XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXQL
                  expiration_date: 25-Mar-2025
                  secret_status: 1
                  secret_status_description: Active
                - secret_id: 8
                  secret_name: asd22
                  masked_secret: 0D98XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXPB
                  expiration_date: 30-Mar-2025
                  secret_status: 1
                  secret_status_description: Active
                - secret_id: 9
                  secret_name: asd22
                  masked_secret: y2n8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXLj
                  expiration_date: 30-Mar-2025
                  secret_status: 1
                  secret_status_description: Active
                - secret_id: 10
                  secret_name: string
                  masked_secret: rCm8XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXW5
                  expiration_date: 19-Jun-2025
                  secret_status: 1
                  secret_status_description: Active
                errors: null
          headers: {}
          x-apidog-name: Success
      security:
      - Balad Token: []
        x-apidog:
          required: true
          schemeGroups:
          - id: 87aTaQp8pR3_G2Uh_UKds
            schemeIds:
            - Balad Token
          use:
            id: 87aTaQp8pR3_G2Uh_UKds
      x-apidog-folder: APIs/Core/Secrets
      x-apidog-status: released
      x-run-in-apidog: https://app.apidog.com/web/project/1056134/apis/api-20919913-run
components:
  securitySchemes:
    Balad Token:
      type: bearer
      scheme: bearer
    bearer:
      type: http
      scheme: bearer