openapi: 3.1.0
info:
  title: Deliverect Channel Accounts Profiles API
  description: Integrate ordering channels and marketplaces with Deliverect to create and cancel orders, sync menus, snooze products, update store and courier status, and exchange payment events. Authenticates with OAuth 2.0 machine-to-machine access tokens scoped via genericChannel.
  version: '1.0'
  x-generated-from: documentation
  x-source-url: https://developers.deliverect.com/reference
  x-last-validated: '2026-06-02'
  contact:
    name: Kin Lane
    email: kin@apievangelist.com
  license:
    name: All Rights Reserved
servers:
- url: https://api.deliverect.com
  description: Production
- url: https://api.staging.deliverect.com
  description: Staging
security:
- oauth2: []
tags:
- name: Profiles
  description: Profiles operations for the Deliverect Gift Cards API.
paths:
  /giftCards/registerProfile:
    post:
      summary: Deliverect Register Profile
      description: Deliverect Register Profile
      operationId: giftcards_registerprofile
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - account
              - apiKey
              properties:
                account:
                  type: string
                  example: string
                apiKey:
                  type: string
                  description: API key is the unique identifier of the customer within the gift cards gateway
                  example: string
            examples:
              giftcards_registerprofileRequest:
                summary: Default giftcards_registerprofile request
                x-microcks-default: true
                value:
                  account: string
                  apiKey: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value:
                    redeemGiftCardURL: https://yourwebhook.com/redeem
                    revertRedeemGiftCardURL: 'https: //yourwebhook.com/reverse'
                    getGiftCardBalanceURL: https://yourwebhook.com/balance
              schema:
                type: object
                properties:
                  redeemGiftCardURL:
                    type: string
                    description: ''
                    example: https://example.com/path/abc123
                  revertRedeemGiftCardURL:
                    type: string
                    description: ''
                    example: https://example.com/path/abc123
                  getGiftCardBalanceURL:
                    type: string
                    description: ''
                    example: https://example.com/path/abc123
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Profiles
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /giftCards/channel/{channelLinkId}/providerProfileLinks:
    get:
      summary: Deliverect Get Profile Links
      parameters:
      - name: channelLinkId
        in: path
        required: true
        schema:
          type: string
        example: '{{channelLinkId}}'
        description: The channelLinkId value.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  giftCardProviderProfileLinks:
                    type: array
                    items:
                      type: object
                      properties:
                        id:
                          type: string
                          example: 609a1b2c3d4e5f6a7b8c9d0e
                        name:
                          type: string
                          example: Deliverect's Pizza Place
              examples:
                response:
                  value:
                    giftCardProviderProfileLinks:
                    - id: '{{giftCardProviderProfileLinkId}}'
                      name: string
      tags:
      - Profiles
      operationId: get_giftcards_channel_channellinkid_providerprofilelinks
      description: Deliverect Get Profile Links
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /register:
    post:
      summary: Deliverect Register Profile
      description: Deliverect Register Profile
      operationId: payplatform_payments_profile_register
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - gatewayProfileId
              - accountId
              - apiKey
              - webhookUrl
              properties:
                gatewayProfileId:
                  type: string
                  description: Unique identifier of the payment gateway within a Deliverect customer account
                  example: 609a1b2c3d4e5f6a7b8c9d0e
                accountId:
                  type: string
                  example: 5b71c6489f00290d4
                apiKey:
                  type: string
                  description: API key is the unique identifier of the customer within the payment gateway
                  example: string
                webhookUrl:
                  type: string
                  description: Webhook URL which partners will send payment related update events
                  example: https://example.com/path/abc123
            examples:
              Request Example:
                value:
                  gatewayProfileId: 66d721b3df0f5a9fda62dd8b
                  accountId: 66570956c77ccc6b9d75e445
                  apiKey: api-key
                  webhookUrl: https://api.staging.deliverect.com/pay/events/integrationName/gatewayProfiles/66d721b3df0f5a9fda62dd8b
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n    \"requestPaymentURL\": \"https://yourwebhook.com/payments/request\",\n    \"refundPaymentURL\": \"https://yourwebhook.com/payments/refund\",\n    \"unregisterGatewayProfileURL\": \"https://yourwebhook.com/payments/unregister-profile\"\n}"
              schema:
                type: object
                properties:
                  requestPaymentURL:
                    type: string
                    example: https://yourwebhook.com/payments/request
                  refundPaymentURL:
                    type: string
                    example: https://yourwebhook.com/payments/refund
                  unregisterGatewayProfileURL:
                    type: string
                    example: https://yourwebhook.com/payments/unregister-profile
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Profiles
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /unregister-profile:
    post:
      summary: Deliverect Unregister Profile Event
      description: When the gateway profile is uninstalled, the partner is expected to handle the unregistered event so that the profile can be uninstalled and disabled.
      operationId: payplatform_payments_unregister_profile
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - accountId
              - gatewayProfileId
              properties:
                accountId:
                  type: string
                  description: The ID of the account the gateway profile belongs to.
                  example: 5b71c6489f00290d4
                gatewayProfileId:
                  type: string
                  description: The ID of the profile being unregistered.
                  example: 609a1b2c3d4e5f6a7b8c9d0e
            examples:
              payplatform_payments_unregister_profileRequest:
                summary: Default payplatform_payments_unregister_profile request
                x-microcks-default: true
                value:
                  accountId: 5b71c6489f00290d4
                  gatewayProfileId: 609a1b2c3d4e5f6a7b8c9d0e
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Profiles
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  securitySchemes:
    oauth2:
      type: oauth2
      description: OAuth 2.0 machine-to-machine client-credentials. Exchange client_id/client_secret at POST /oauth/token for a Bearer access_token.
      flows:
        clientCredentials:
          tokenUrl: https://api.deliverect.com/oauth/token
          scopes: {}