Restaurant Brands International
Restaurant Brands International Loyalty API

The Loyalty API from Restaurant Brands International — 1 operation(s) for loyalty.
Documentation GitHub OpenAPI
OpenAPI Specification

openapi: 3.1.0
info:
  version: 1.0.0
  title: Burger King's Partners Loyalty API
  description: '## Overview


    The Channel Partners API are provided for third party food ordering marketplaces

    integrating into the Restaurant Brand International (RBI) fulfillment platform.


    ## Authentication

    ### Webhooks


    Webhook requests are signed using `hex` encoded HMAC signatures.


    An HMAC signature is derived for validation using three components:


    - the secret shared between the service and the consumer

    - the body of the request

    - the hash function or algorithm (SHA-256)


    Using these three pieces of information, compute an HMAC signature using the secret as the key and

    the body of the request as the message and encode the signature to a hexadecimal string for comparison.


    Compare the signature generated using the above information to the signature received in the `x-signature` header,

    if the two signatures match, the request is valid.

    '
  x-logo:
    altText: RBI logo
    url: data:image/svg+xml;base64,<svg width="79" height="81" viewBox="0 0 79 81" fill="none" xmlns="http://www.w3.org/2000/svg">
<g clip-path="url(#clip0_709_23737)">
<path d="M73.3832 75.1348C73.3832 73.6063 74.5683 72.3264 76.1916 72.3264C77.8149 72.3264 79 73.6063 79 75.1348C79 76.7781 77.8162 77.9619 76.1916 77.9619C74.5669 77.9619 73.3832 76.7581 73.3832 75.1348ZM78.3881 75.1348C78.3881 73.7212 77.2805 72.8996 76.1916 72.8996C75.1027 72.8996 73.9951 73.7212 73.9951 75.1348C73.9951 76.5483 75.1027 77.3887 76.1916 77.3887C77.2805 77.3887 78.3881 76.6058 78.3881 75.1348ZM75.2163 76.3386V73.951C75.2163 73.7987 75.3499 73.6451 75.5035 73.6451H76.3051C76.9358 73.6451 77.3753 74.0272 77.3753 74.5429C77.3753 74.9825 77.1268 75.3646 76.5537 75.4594L77.1843 76.1662C77.2417 76.2237 77.2805 76.2998 77.2805 76.3573C77.2805 76.5296 77.1656 76.6445 76.9946 76.6445C76.8797 76.6445 76.8035 76.5871 76.746 76.5109L75.9057 75.5169H75.8095V76.3386C75.8095 76.4909 75.6759 76.6245 75.5035 76.6245C75.3512 76.6245 75.2163 76.4909 75.2163 76.3386ZM76.229 74.9825C76.5724 74.9825 76.7634 74.8101 76.7634 74.5817C76.7634 74.3331 76.5911 74.1995 76.2864 74.1995H75.8095V74.9825H76.2303H76.229Z" fill="#D62300"/>
<path d="M70.7057 67.1144C72.0578 67.1144 72.6644 67.7677 72.6644 68.9101C72.6644 70.9155 70.822 73.7146 67.1839 75.7668C61.1208 79.1951 50.7196 80.1744 36.3315 80.1744C21.9435 80.1744 11.5422 79.1951 5.47918 75.7668C1.84109 73.7146 -0.00134277 70.9168 -0.00134277 68.9101C-0.00134277 67.7677 0.605229 67.1144 1.95732 67.1144H70.7057Z" fill="#FF8732"/>
<path d="M7.64895 60.6318V56.9243C7.64895 56.5983 7.78923 56.3644 8.11523 56.3644C8.53475 56.3644 8.65099 56.808 8.76857 57.0178C9.49137 58.4634 10.7045 61.4254 12.1501 63.0114C13.1295 64.0842 14.3426 64.7603 15.6252 64.7603C17.7937 64.7603 19.6134 62.8711 19.6134 60.8429C19.6134 59.583 19.0776 58.6504 18.0515 57.5322C16.7462 56.1093 15.207 54.2441 14.6472 53.381C14.4375 53.055 14.4134 52.8453 14.4134 52.7517C14.4134 52.4952 14.5537 52.3082 14.833 52.0516C15.4863 51.4451 17.0949 49.93 17.9807 48.5538C18.6568 47.505 18.9373 46.5484 18.9373 45.7548C18.9373 43.7253 17.0949 42.1407 15.0895 42.1407C13.8069 42.1407 12.5937 42.8635 11.7787 44.1929C10.6831 45.9659 9.56352 48.4603 8.63095 49.3929C8.39714 49.6267 8.2809 49.6721 8.09519 49.6721C7.7919 49.6721 7.65162 49.4623 7.65162 49.1363V46.2678C7.65162 43.9818 6.29952 42.1407 3.85052 42.1407C1.40152 42.1407 0.0467529 43.9818 0.0467529 46.2665V60.6318C0.0467529 62.9178 1.37613 64.7589 3.84785 64.7589C6.31956 64.7589 7.64895 62.9165 7.64895 60.6318Z" fill="#D62300"/>
<path d="M70.496 43.9578C69.0731 42.909 66.9287 42.1394 63.8958 42.1394C58.4621 42.1394 53.1686 45.5677 53.1686 53.5427C53.1686 61.5176 58.4621 64.7362 63.6861 64.7362C69.1666 64.7362 72.6403 61.3546 72.6403 56.4112C72.6403 53.2862 70.6817 51.1177 66.7403 51.1177H65.598C63.5458 51.1177 61.9599 52.0743 61.9599 54.1733C61.9599 56.0852 63.6861 56.9951 64.9687 56.9951C66.0642 56.9951 66.5078 57.1821 66.5078 57.6711C66.5078 58.2777 65.9253 58.6745 64.5024 58.6745C61.8677 58.6745 60.072 56.8788 60.072 53.544C60.072 49.8364 62.521 48.483 64.4089 48.483C66.7176 48.483 67.0903 49.6494 68.7003 49.6494C70.5654 49.6494 71.8253 48.133 71.8253 46.5938C71.8253 45.4515 71.3123 44.5643 70.496 43.9591V43.9578Z" fill="#D62300"/>
<path d="M51.3502 46.0808V60.6091C51.3502 62.9178 49.9981 64.7603 47.5491 64.7603C46.1262 64.7603 44.7968 64.2004 43.561 61.7982L40.3197 55.5254C40.0859 55.0818 39.9229 54.9656 39.6904 54.9656C39.3644 54.9656 39.2001 55.1994 39.2001 55.7352L39.2228 60.8189C39.2228 63.0113 37.9629 64.7603 35.6087 64.7603C33.2546 64.7603 32.0174 63.0113 32.0174 60.8189V46.2905C32.0174 43.9818 33.3695 42.1394 35.8185 42.1394C37.2882 42.1394 38.5708 42.6992 39.8066 45.1014L43.0479 51.3742C43.2817 51.8178 43.4447 51.9341 43.6772 51.9341C44.0032 51.9341 44.1675 51.7003 44.1675 51.1645L44.1448 46.0808C44.1448 43.8883 45.4047 42.1394 47.7589 42.1394C50.113 42.1394 51.3502 43.8883 51.3502 46.0808Z" fill="#D62300"/>
<path d="M29.3132 46.5471C29.3132 44.0981 27.8903 42.1394 25.2783 42.1394C22.6663 42.1394 21.2434 44.0981 21.2434 46.5471V60.3526C21.2434 62.8016 22.6663 64.7603 25.2783 64.7603C27.8903 64.7603 29.3132 62.8016 29.3132 60.3526V46.5471Z" fill="#D62300"/>
<path d="M35.749 36.7283C35.3522 36.238 34.3729 34.9794 34.1872 34.3261C34.1177 34.0923 34.1404 33.9293 34.3502 33.7436C35.073 33.0675 35.912 32.0174 35.912 30.1522C35.912 26.9577 33.463 25.3478 30.5023 25.3478H27.8676C26.0252 25.3478 25.1393 26.4206 25.1393 27.8662V38.2675C25.1393 39.6663 25.9557 40.786 27.4481 40.786C28.9404 40.786 29.7568 39.6663 29.7568 38.2675V35.9588C29.7568 35.6087 29.8971 35.3522 30.2698 35.3522C30.5958 35.3522 30.7361 35.6314 30.8056 35.9588C31.0153 36.9849 31.3186 38.5935 31.9479 39.4098C32.7402 40.4586 33.4871 40.786 34.2339 40.786C35.4471 40.786 36.4959 39.8293 36.4959 38.6402C36.4959 37.848 36.1699 37.2641 35.749 36.7283ZM4.68691 34.2326H5.34024C6.38905 34.2326 6.69233 35.0022 6.69233 35.7022C6.69233 36.4023 6.38905 37.1719 5.34024 37.1719H4.68691C4.2901 37.1719 4.10438 36.9381 4.10438 36.6362V34.771C4.10438 34.4677 4.29143 34.2353 4.68691 34.2353V34.2326ZM4.68691 31.4803C4.2901 31.4803 4.10438 31.2465 4.10438 30.9445V29.3586C4.10438 29.0553 4.29143 28.8229 4.68691 28.8229H5.22267C6.15524 28.8229 6.43581 29.4989 6.43581 30.1522C6.43581 30.8056 6.15657 31.4816 5.22267 31.4816H4.68691V31.4803ZM2.72824 40.6684H6.01629C9.11729 40.6684 11.0065 38.5935 11.0065 36.0042C11.0065 33.9988 9.77062 33.0889 9.49005 32.8564C9.37381 32.7629 9.25624 32.6694 9.25624 32.5772C9.25624 32.461 9.303 32.4142 9.44329 32.2739C9.95633 31.7609 10.4467 30.8751 10.4467 29.6392C10.4467 26.8401 8.44124 25.3478 5.50324 25.3478H2.72824C0.885809 25.3478 0 26.4206 0 27.8662V38.1499C0 39.5955 0.885809 40.6684 2.72824 40.6684ZM30.4088 32.2499H29.849C29.4522 32.2499 29.2664 32.0161 29.2664 31.7141V29.7087C29.2664 29.4054 29.4535 29.2183 29.849 29.2183H30.4088C31.5511 29.2183 31.9012 29.9879 31.9012 30.7107C31.9012 31.3868 31.5511 32.2499 30.4088 32.2499ZM55.2448 36.1204C55.2448 36.4237 55.4319 36.6562 55.8274 36.6562H58.0893C59.3024 36.6562 60.2577 37.379 60.2577 38.6616C60.2577 39.9442 59.3011 40.6671 58.0893 40.6671H53.6349C51.7924 40.6671 50.9066 39.5942 50.9066 38.1486V27.8649C50.9066 26.4193 51.7924 25.3464 53.6349 25.3464H58.0893C59.3024 25.3464 60.2577 26.0692 60.2577 27.3519C60.2577 28.6345 59.3011 29.3573 58.0893 29.3573H55.8274C55.4305 29.3573 55.2448 29.5911 55.2448 29.8931V30.5691C55.2448 30.8724 55.4319 31.1049 55.8274 31.1049H57.436C58.5556 31.1049 59.4414 31.7809 59.4414 32.97C59.4414 34.1591 58.5556 34.8351 57.436 34.8351H55.8274C55.4305 34.8351 55.2448 35.069 55.2448 35.3709V36.1178V36.1204ZM66.5786 32.2499H66.0188C65.622 32.2499 65.4363 32.0161 65.4363 31.7141V29.7087C65.4363 29.4054 65.6234 29.2183 66.0188 29.2183H66.5786C67.721 29.2183 68.071 29.9879 68.071 30.7107C68.071 31.3868 67.721 32.2499 66.5786 32.2499ZM48.2719 26.3498C47.7121 25.9062 46.173 25.2075 43.8643 25.2075C40.2502 25.2075 36.7283 27.5857 36.7283 33.0902C36.7283 38.5948 40.2502 40.8087 43.724 40.8087C47.3848 40.8087 49.6935 38.4772 49.6935 34.9781C49.6935 32.8097 48.3882 31.3173 45.7762 31.3173H45.0293C43.6532 31.3173 42.5803 31.9706 42.5803 33.439C42.5803 34.7443 43.7226 35.3749 44.6792 35.3749C45.2858 35.3749 45.6359 35.6542 45.6359 36.075C45.6359 36.6348 45.1455 37.0076 44.2597 37.0076C42.4413 37.0076 41.3217 35.6087 41.3217 33.0902C41.3217 30.5718 42.9544 29.5924 44.213 29.5924C45.7521 29.5924 46.0086 30.175 47.0815 30.175C48.3173 30.175 49.1564 29.1489 49.1564 28.076C49.1564 27.2837 48.8063 26.7707 48.2706 26.3498H48.2719ZM61.3079 38.2662C61.3079 39.665 62.1242 40.7846 63.6166 40.7846C65.109 40.7846 65.9253 39.665 65.9253 38.2662V35.9574C65.9253 35.6074 66.0656 35.3509 66.4384 35.3509C66.7644 35.3509 66.9046 35.6301 66.9741 35.9574C67.1612 36.9835 67.4872 38.5921 68.1164 39.4085C68.9087 40.4573 69.6556 40.7846 70.4025 40.7846C71.6156 40.7846 72.6644 39.828 72.6644 38.6389C72.6644 37.8466 72.3384 37.2628 71.9175 36.727C71.5207 36.2367 70.5414 34.9781 70.3557 34.3248C70.2862 34.091 70.3089 33.928 70.5187 33.7422C71.2415 33.0662 72.0805 32.0161 72.0805 30.1509C72.0805 26.9564 69.6315 25.3464 66.6708 25.3464H64.0361C62.1937 25.3464 61.3079 26.4193 61.3079 27.8649V38.2662ZM17.8631 40.7846C14.0848 40.7846 12.1034 38.5227 12.1034 35.6782V27.8195C12.1034 26.4206 12.9197 25.301 14.4121 25.301C15.9045 25.301 16.7435 26.4206 16.7435 27.8195V35.4217C16.7435 35.9815 17.0228 36.6348 17.8631 36.6348C18.7035 36.6348 19.0295 35.9815 19.0295 35.4217V27.8195C19.0295 26.4206 19.8459 25.301 21.3382 25.301C22.8306 25.301 23.647 26.4206 23.647 27.8195V35.6782C23.647 38.5227 21.6415 40.7846 17.8631 40.7846Z" fill="#D62300"/>
<path d="M70.7057 22.5968H1.95867C0.606572 22.5968 0 21.8967 0 20.6381C0 13.1762 11.2162 0 36.3329 0C61.4495 0 72.6657 13.1762 72.6657 20.6381C72.6657 21.8981 72.0591 22.5968 70.7071 22.5968H70.7057Z" fill="#FF8732"/>
</g>
<defs>
<clipPath id="clip0_709_23737">
<rect width="79" height="80.1744" fill="white"/>
</clipPath>
</defs>
</svg>

servers:
- url: https://sandbox-bk-partners.rbictg.com/api/v1
  description: Sandbox server (uses test data)
- url: https://bk-partners.rbictg.com/api/v1
  description: Production server
tags:
- name: Loyalty
paths:
  /loyalty/identify:
    post:
      summary: Identify
      tags:
      - Loyalty
      operationId: identify
      parameters: []
      security:
      - bearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/IdentifyRequest'
            examples:
              IdentifyRequestExample:
                summary: Default identify request
                x-microcks-default: true
                value:
                  identifier: '1234'
                  identifierType: OTP
                  storeId: '42'
                  serviceMode: TAKEOUT
                  details:
                    operator: {}
                    terminal: {}
                    transactionId: {}
      responses:
        '200':
          description: Loyalty identified
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    $ref: '#/components/schemas/IdentifyResponse'
                required:
                - data
              examples:
                Identify200Example:
                  summary: Default identify 200 response
                  x-microcks-default: true
                  value:
                    data:
                      cart:
                        menuSelections: {}
                      customer:
                        id: {}
                        externalReferenceId: {}
                        name: {}
                        username: {}
                        phone: {}
                        email: {}
                      loyalty:
                        balances: {}
                        loyaltyId: {}
                        transactionId: {}
                      storeId: '42'
                      serviceMode: TAKEOUT
        '400':
          description: Invalid request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Identify400Example:
                  summary: Default identify 400 response
                  x-microcks-default: false
                  value:
                    status: 400
                    code: ValidationError
                    message: isAvailable must be a boolean value
                    errors:
                    - code: ValidationError
                      details: example
                      message: example
                      domain: example
                      location: isAvailable
                      locationType: requestBody
                      sendReport: example
                      extendedHelp: example
        '403':
          description: Authentication failure
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Identify403Example:
                  summary: Default identify 403 response
                  x-microcks-default: false
                  value:
                    status: 400
                    code: ValidationError
                    message: isAvailable must be a boolean value
                    errors:
                    - code: ValidationError
                      details: example
                      message: example
                      domain: example
                      location: isAvailable
                      locationType: requestBody
                      sendReport: example
                      extendedHelp: example
        '404':
          description: Identifier Not found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Identify404Example:
                  summary: Default identify 404 response
                  x-microcks-default: false
                  value:
                    status: 400
                    code: ValidationError
                    message: isAvailable must be a boolean value
                    errors:
                    - code: ValidationError
                      details: example
                      message: example
                      domain: example
                      location: isAvailable
                      locationType: requestBody
                      sendReport: example
                      extendedHelp: example
        '500':
          description: Unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                Identify500Example:
                  summary: Default identify 500 response
                  x-microcks-default: false
                  value:
                    status: 400
                    code: ValidationError
                    message: isAvailable must be a boolean value
                    errors:
                    - code: ValidationError
                      details: example
                      message: example
                      domain: example
                      location: isAvailable
                      locationType: requestBody
                      sendReport: example
                      extendedHelp: example
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    MenuSelection:
      title: Menu Selection
      description: Menu selection in the cart
      type: object
      properties:
        id:
          type: string
          description: Menu item identifier
          example: item_42
        referenceId:
          type: string
          description: 'Secondary menu item identifier.


            ⚠️ This `referenceId` must be included along with the `id` when the value is present in the menu

            '
          example: item_603
        externalReferenceId:
          $ref: '#/components/schemas/ExternalReferenceId'
        quantity:
          type: number
          format: integer
          minimum: 0
          example: 1
        price:
          $ref: '#/components/schemas/Money'
        menuSelections:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/MenuSelection'
      required:
      - id
      - quantity
    IdentifierType:
      title: Identifier Type
      description: Determines the type of identifier being sent
      type: string
      example: OTP
      enum:
      - OTP
      - OFFER_CODE
    Money:
      title: Money
      description: 'Representation of money. Money amounts are always provided in the smallest currency unit (e.g,. 100 where `currency=USD` represents 100 "cents" or 1 USD).

        '
      type: object
      properties:
        currency:
          $ref: '#/components/schemas/Currency'
        amount:
          title: Amount
          description: Amount in the specified currency
          type: number
          example: 100
          format: integer
      required:
      - currency
      - amount
    Currency:
      title: Currency Code
      description: Currency code in [ISO-4217 alpha](https://en.wikipedia.org/wiki/ISO_4217) format
      format: ISO-4217 alpha
      type: string
      example: USD
    IdentifyResponse:
      title: Identify Response
      type: object
      properties:
        cart:
          $ref: '#/components/schemas/Cart'
        customer:
          $ref: '#/components/schemas/Customer'
        loyalty:
          $ref: '#/components/schemas/IdentifyLoyalty'
        storeId:
          $ref: '#/components/schemas/StoreId'
        serviceMode:
          $ref: '#/components/schemas/ServiceMode'
      required:
      - cart
      - storeId
      - serviceMode
    Error:
      title: Error
      type: object
      description: Standard error format for all errors returned by the API
      properties:
        status:
          description: HTTP status code
          type: number
          example: 400
        code:
          description: Unique error code. Same as errors[0].code
          type: string
          example: ValidationError
        message:
          description: Human readable error mesage. Same as errors[0].message
          type: string
          example: isAvailable must be a boolean value
        errors:
          description: All errors
          type: array
          items:
            type: object
            properties:
              code:
                description: Unique error code
                type: string
                example: ValidationError
              details:
                description: Detailed error information
                type: string
              message:
                description: Human readable error mesage
                type: string
              domain:
                type: string
              location:
                type: string
                description: Location the error occurred. Interpreation depends on `locationType`
                example: isAvailable
              locationType:
                type: string
                description: How to interpret the location property
                example: requestBody
              sendReport:
                description: URL to report this error
                type: string
              extendedHelp:
                description: URL with additional information about the error type
                type: string
            required:
            - code
            - message
      required:
      - code
      - message
      - errors
    Terminal:
      title: Terminal
      description: The terminal name.
      example: window-2
      type: string
    IdentifyRequestDetails:
      title: Identify Request Details
      type: object
      properties:
        operator:
          $ref: '#/components/schemas/Operator'
        terminal:
          $ref: '#/components/schemas/Terminal'
        transactionId:
          $ref: '#/components/schemas/TransactionId'
    StoreId:
      title: StoreId
      description: Unique Store ID
      example: '42'
      pattern: ^\d+$
      type: string
    IdentifyRequest:
      title: Identify Request
      type: object
      properties:
        identifier:
          $ref: '#/components/schemas/Identifier'
        identifierType:
          $ref: '#/components/schemas/IdentifierType'
        storeId:
          $ref: '#/components/schemas/StoreId'
        serviceMode:
          $ref: '#/components/schemas/ServiceMode'
        details:
          $ref: '#/components/schemas/IdentifyRequestDetails'
      required:
      - identifier
      - identifierType
      - storeId
      - serviceMode
    ExternalReferenceId:
      title: External Reference Id
      description: External reference ID. An example might be the external menu selection ID, customer ID or order ID.
      type: string
    IdentifyLoyalty:
      title: Loyalty Information
      description: User information on the Loyalty user identified
      type: object
      properties:
        balances:
          description: 'The loyalty user''s balances

            '
          type: array
          items:
            $ref: '#/components/schemas/Balance'
        loyaltyId:
          $ref: '#/components/schemas/LoyaltyId'
        transactionId:
          $ref: '#/components/schemas/LoyaltyTransactionId'
      required:
      - balances
      - loyaltyId
      - transactionId
    TransactionId:
      title: Transaction Id
      description: The Partner specific order lookup id.
      example: ORD-000002
      type: string
    LoyaltyTransactionId:
      title: Loyalty Transaction Id
      description: The loyalty transaction id created for the identify request
      example: a73ea594-202c-52b4-80af-1f6b518ef54d
      type: string
    LoyaltyId:
      title: Loyalty Id
      description: The loyalty user id
      example: a73ea594-202c-52b4-00a0-1f6b518ef54d
      type: string
    ServiceMode:
      title: Service Mode
      description: 'How a customer would like their order served.


        Note that not all service modes will be available at all restaurants.

        '
      type: string
      example: TAKEOUT
      enum:
      - CURBSIDE
      - DELIVERY
      - DRIVE_THRU
      - EAT_IN
      - TABLE_SERVICE
      - TAKEOUT
    Operator:
      title: Operator
      description: The cashier id submitting the transaction.
      example: ninja123
      type: string
    Identifier:
      title: Identifier
      description: An OTP code (6 digit code) or a static Offer code (4 digit code)
      example: '1234'
      pattern: ^(\d{6}|\d{4})$
      type: string
    Customer:
      title: Customer
      description: Customer personal details
      type: object
      properties:
        id:
          type: string
          description: Internal user ID
          example: '500123'
        externalReferenceId:
          $ref: '#/components/schemas/ExternalReferenceId'
        name:
          type: string
          description: 'Customers''s name. Format will depend on the context (full name, first name and initials, etc)

            '
          example: Whopper
        username:
          type: string
          description: Customer's username in the given context
          example: example
        phone:
          $ref: '#/components/schemas/Phone'
        email:
          type: string
          description: Customer's email
          format: email
          example: guest@example.com
      required:
      - name
      - email
    Cart:
      title: Cart
      description: Cart representing a customer's selections from the menu
      type: object
      properties:
        menuSelections:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/MenuSelection'
      required:
      - menuSelections
    Phone:
      title: Phone
      description: 'Phone number. Should always begin with the international country code (e.g., "+1")

        '
      type: string
      example: '+12223334444'
    Balance:
      title: Balance
      description: The amount of a given currency the user has
      type: object
      properties:
        amount:
          type: number
          example: 599
        currency:
          type: string
          example: USD
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http
x-tagGroups:
- name: API
  tags:
  - Loyalty
  - Orders
  - Menus
  - Stores
- name: Models
  tags:
  - OrderModel
  - MenuModel
  - StoreModel
  - ErrorModel
Restaurant Brands International Loyalty API

Documentation

Specifications

Other Resources

OpenAPI Specification
