> ## Documentation Index
> Fetch the complete documentation index at: https://docs.equalsmoney.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Upload the merchant logo

> Replaces the logo payers see with an uploaded image and returns the merchant with its new `logoUrl`. Returns 400 if the image is undecodable, animated or too small, 413 if it is over 5 MiB or more than one file is sent, and 415 if it is not a PNG, JPEG or WebP image. Nothing is changed on failure.



## OpenAPI

````yaml /autogenerated/openapi/roqqett.openapi.json patch /roqqett/merchant/logo
openapi: 3.1.0
info:
  title: Roqqett API
  version: 2.0.0
  description: Version 2
  license:
    name: UNLICENSED
    url: https://docs.equalsmoney.com
servers:
  - url: https://api.equalsmoney.com/v2
    description: Production
security: []
paths:
  /roqqett/merchant/logo:
    patch:
      tags:
        - Merchant
      summary: Upload the merchant logo
      description: >-
        Replaces the logo payers see with an uploaded image and returns the
        merchant with its new `logoUrl`. Returns 400 if the image is
        undecodable, animated or too small, 413 if it is over 5 MiB or more than
        one file is sent, and 415 if it is not a PNG, JPEG or WebP image.
        Nothing is changed on failure.
      operationId: updateMerchantLogo
      parameters:
        - name: accountId
          in: query
          schema:
            description: The ID of the account to work with.
            type:
              - string
            example: F50091
          required: true
      requestBody:
        description: Body
        content:
          multipart/form-data:
            schema:
              type:
                - object
              properties:
                file:
                  description: >-
                    The logo image: PNG, JPEG or WebP, not animated, at most 5
                    MiB, and at least 256px on its shortest side. Detected by
                    content, not by the declared type. Stored re-encoded as a
                    512x512 PNG.
              example:
                file: null
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  accountId:
                    description: The ID of the account to work with.
                    type:
                      - string
                    example: F50091
                  name:
                    type:
                      - string
                    minLength: 1
                    maxLength: 64
                    pattern: \S
                    description: >-
                      The merchant name shown to payers on checkout screens and
                      sent as the payee name when a payment is initiated with
                      the payer's bank.
                    example: Example Shop
                  status:
                    type:
                      - string
                    enum:
                      - ACTIVE
                      - DEACTIVATED
                    description: >-
                      Only an ACTIVE merchant can take payments. Set by Equals
                      through the CIS account status; read-only here.
                    example: ACTIVE
                  logoUrl:
                    type:
                      - string
                      - 'null'
                    format: uri
                    maxLength: 2048
                    description: >-
                      Stable URL of the merchant logo as shown to payers, a
                      512x512 PNG. `null` when no logo has been uploaded; payer
                      screens show the merchant's initials instead.
                    example: >-
                      https://pay.roqqett.com/api/assets-management/avatar-image/e9293471-5eb3-4dbc-916c-dbaf9e2deefd
                  returnPolicyUrl:
                    type:
                      - string
                      - 'null'
                    format: uri
                    maxLength: 2048
                    pattern: ^https:\/\/
                    description: Link to the merchant's returns policy, shown to payers.
                    example: https://shop.example.com/returns
                  branding:
                    type:
                      - object
                    properties:
                      primaryColour:
                        type:
                          - string
                          - 'null'
                        pattern: ^#[0-9A-Fa-f]{6}$
                        description: >-
                          Main brand colour on payer-facing checkout screens.
                          `null` uses the Roqqett default.
                        example: '#1A2B3C'
                      contentOnPrimaryColour:
                        type:
                          - string
                          - 'null'
                        pattern: ^#[0-9A-Fa-f]{6}$
                        description: >-
                          Text and icon colour on the primary colour. `null`
                          uses the Roqqett default.
                        example: '#1A2B3C'
                      secondaryColour:
                        type:
                          - string
                          - 'null'
                        pattern: ^#[0-9A-Fa-f]{6}$
                        description: >-
                          Accent colour on payer-facing checkout screens. `null`
                          uses the Roqqett default.
                        example: '#1A2B3C'
                      contentOnSecondaryColour:
                        type:
                          - string
                          - 'null'
                        pattern: ^#[0-9A-Fa-f]{6}$
                        description: >-
                          Text and icon colour on the secondary colour. `null`
                          uses the Roqqett default.
                        example: '#1A2B3C'
                      hideRoqqettLogo:
                        type:
                          - boolean
                        description: >-
                          Whether the "powered by Roqqett" logo is hidden on
                          payer-facing screens.
                    required:
                      - primaryColour
                      - contentOnPrimaryColour
                      - secondaryColour
                      - contentOnSecondaryColour
                      - hideRoqqettLogo
                  brandingPermissions:
                    type:
                      - object
                    properties:
                      canCustomiseColours:
                        type:
                          - boolean
                        description: >-
                          Whether Equals has enabled custom colours for the
                          merchant. When false, the colours are `null` and
                          cannot be set.
                      canHideRoqqettLogo:
                        type:
                          - boolean
                        description: >-
                          Whether Equals allows the merchant to hide the Roqqett
                          logo. When false, `hideRoqqettLogo` is false and
                          cannot be set.
                    required:
                      - canCustomiseColours
                      - canHideRoqqettLogo
                    description: >-
                      What Equals has enabled the merchant to change. Only
                      Equals can change it.
                  canCreateTopUpCheckouts:
                    type:
                      - boolean
                    description: >-
                      Whether Equals allows the merchant to create top-up
                      checkout sessions.
                    example: false
                  reconciliation:
                    type:
                      - object
                    properties:
                      enabled:
                        type:
                          - boolean
                        description: >-
                          Whether Equals reconciles the merchant's payments
                          against its bank account.
                        example: true
                    required:
                      - enabled
                    description: >-
                      Whether Equals reconciles the merchant's payments. Only
                      Equals can change it.
                  paymentsSummary:
                    type:
                      - array
                      - 'null'
                    items:
                      type:
                        - object
                      properties:
                        currencyCode:
                          type:
                            - string
                          enum:
                            - GBP
                            - EUR
                          description: >-
                            ISO-4217 code of a currency Roqqett can take
                            payments in: GBP over Faster Payments, EUR over SEPA
                            Instant.
                          example: GBP
                        today:
                          type:
                            - object
                          properties:
                            amount:
                              type:
                                - string
                              maxLength: 32
                              pattern: ^[0-9]+(\.[0-9]+)?$
                              description: >-
                                Decimal amount in major units, as a string.
                                Never a float.
                              example: '10000.00'
                            currencyCode:
                              type:
                                - string
                              enum:
                                - GBP
                                - EUR
                              description: >-
                                ISO-4217 code of a currency Roqqett can take
                                payments in: GBP over Faster Payments, EUR over
                                SEPA Instant.
                              example: GBP
                          required:
                            - amount
                            - currencyCode
                          description: Total completed since 00:00 UTC today.
                        last7Days:
                          type:
                            - object
                          properties:
                            amount:
                              type:
                                - string
                              maxLength: 32
                              pattern: ^[0-9]+(\.[0-9]+)?$
                              description: >-
                                Decimal amount in major units, as a string.
                                Never a float.
                              example: '10000.00'
                            currencyCode:
                              type:
                                - string
                              enum:
                                - GBP
                                - EUR
                              description: >-
                                ISO-4217 code of a currency Roqqett can take
                                payments in: GBP over Faster Payments, EUR over
                                SEPA Instant.
                              example: GBP
                          required:
                            - amount
                            - currencyCode
                          description: >-
                            Total completed since 00:00 UTC six days before
                            today: today plus the previous six days, seven days
                            in all.
                        last30Days:
                          type:
                            - object
                          properties:
                            amount:
                              type:
                                - string
                              maxLength: 32
                              pattern: ^[0-9]+(\.[0-9]+)?$
                              description: >-
                                Decimal amount in major units, as a string.
                                Never a float.
                              example: '10000.00'
                            currencyCode:
                              type:
                                - string
                              enum:
                                - GBP
                                - EUR
                              description: >-
                                ISO-4217 code of a currency Roqqett can take
                                payments in: GBP over Faster Payments, EUR over
                                SEPA Instant.
                              example: GBP
                          required:
                            - amount
                            - currencyCode
                          description: >-
                            Total completed since 00:00 UTC 29 days before
                            today: today plus the previous 29 days, 30 days in
                            all.
                      required:
                        - currencyCode
                        - today
                        - last7Days
                        - last30Days
                      description: >-
                        Totals in one currency of COMPLETED payment records in
                        which the merchant is the payee, bucketed by
                        `completedAt`, the time the payment was confirmed.
                        Refunds are not deducted.
                    description: >-
                      One row per currency the merchant has taken a completed
                      payment in. `null` unless requested with
                      `include=paymentsSummary`.
                  createdAt:
                    type:
                      - string
                    format: date-time
                    description: >-
                      The date the Resource was initially created. ISO 8601
                      format without milliseconds.
                  updatedAt:
                    type:
                      - string
                    format: date-time
                    description: >-
                      The date the Resource was last modified. ISO 8601 format
                      without milliseconds.
                required:
                  - accountId
                  - name
                  - status
                  - logoUrl
                  - returnPolicyUrl
                  - branding
                  - brandingPermissions
                  - canCreateTopUpCheckouts
                  - reconciliation
                  - paymentsSummary
                  - createdAt
                  - updatedAt
                example:
                  accountId: F50091
                  name: Example Shop
                  status: ACTIVE
                  logoUrl: >-
                    https://pay.roqqett.com/api/assets-management/avatar-image/e9293471-5eb3-4dbc-916c-dbaf9e2deefd
                  returnPolicyUrl: https://shop.example.com/returns
                  branding:
                    primaryColour: '#1A2B3C'
                    contentOnPrimaryColour: '#1A2B3C'
                    secondaryColour: '#1A2B3C'
                    contentOnSecondaryColour: '#1A2B3C'
                    hideRoqqettLogo: true
                  brandingPermissions:
                    canCustomiseColours: true
                    canHideRoqqettLogo: true
                  canCreateTopUpCheckouts: false
                  reconciliation:
                    enabled: true
                  paymentsSummary:
                    - currencyCode: GBP
                      today:
                        amount: '10000.00'
                        currencyCode: GBP
                      last7Days:
                        amount: '10000.00'
                        currencyCode: GBP
                      last30Days:
                        amount: '10000.00'
                        currencyCode: GBP
                  createdAt: '2019-08-24T14:15:22Z'
                  updatedAt: '2019-08-24T14:15:22Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  message:
                    type:
                      - string
                    maxLength: 1024
                    description: Human-readable error description.
                    example: Checkout session not found.
                  errors:
                    type:
                      - array
                    items:
                      type:
                        - object
                      properties:
                        path:
                          type:
                            - string
                          description: The location of the bad parameter.
                        message:
                          type:
                            - string
                          description: Description of why the validation failed.
                        errorCode:
                          type:
                            - string
                          description: Where the error occurred.
                      required:
                        - path
                        - message
                      description: An object containing details about one particular error.
                required:
                  - message
                  - errors
                example:
                  message: Checkout session not found.
                  errors:
                    - path: string
                      message: string
                      errorCode: string
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  message:
                    type:
                      - string
                    maxLength: 1024
                    description: Human-readable error description.
                    example: Checkout session not found.
                  errors:
                    type:
                      - array
                    items:
                      type:
                        - object
                      properties:
                        path:
                          type:
                            - string
                          description: The location of the bad parameter.
                        message:
                          type:
                            - string
                          description: Description of why the validation failed.
                        errorCode:
                          type:
                            - string
                          description: Where the error occurred.
                      required:
                        - path
                        - message
                      description: An object containing details about one particular error.
                required:
                  - message
                  - errors
                example:
                  message: Checkout session not found.
                  errors:
                    - path: string
                      message: string
                      errorCode: string
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  message:
                    type:
                      - string
                    maxLength: 1024
                    description: Human-readable error description.
                    example: Checkout session not found.
                  errors:
                    type:
                      - array
                    items:
                      type:
                        - object
                      properties:
                        path:
                          type:
                            - string
                          description: The location of the bad parameter.
                        message:
                          type:
                            - string
                          description: Description of why the validation failed.
                        errorCode:
                          type:
                            - string
                          description: Where the error occurred.
                      required:
                        - path
                        - message
                      description: An object containing details about one particular error.
                required:
                  - message
                  - errors
                example:
                  message: Checkout session not found.
                  errors:
                    - path: string
                      message: string
                      errorCode: string
        '413':
          description: Content Too Large
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  message:
                    type:
                      - string
                    maxLength: 1024
                    description: Human-readable error description.
                    example: Checkout session not found.
                  errors:
                    type:
                      - array
                    items:
                      type:
                        - object
                      properties:
                        path:
                          type:
                            - string
                          description: The location of the bad parameter.
                        message:
                          type:
                            - string
                          description: Description of why the validation failed.
                        errorCode:
                          type:
                            - string
                          description: Where the error occurred.
                      required:
                        - path
                        - message
                      description: An object containing details about one particular error.
                required:
                  - message
                  - errors
                example:
                  message: Checkout session not found.
                  errors:
                    - path: string
                      message: string
                      errorCode: string
        '415':
          description: Unsupported Media Type
          content:
            application/json:
              schema:
                type:
                  - object
                properties:
                  message:
                    type:
                      - string
                    maxLength: 1024
                    description: Human-readable error description.
                    example: Checkout session not found.
                  errors:
                    type:
                      - array
                    items:
                      type:
                        - object
                      properties:
                        path:
                          type:
                            - string
                          description: The location of the bad parameter.
                        message:
                          type:
                            - string
                          description: Description of why the validation failed.
                        errorCode:
                          type:
                            - string
                          description: Where the error occurred.
                      required:
                        - path
                        - message
                      description: An object containing details about one particular error.
                required:
                  - message
                  - errors
                example:
                  message: Checkout session not found.
                  errors:
                    - path: string
                      message: string
                      errorCode: string
      security:
        - CommonAuth:
            - roqqett:merchant:update:any
      x-codeSamples:
        - lang: Shell
          label: cURL
          source: |-
            curl --request PATCH \
              --url 'https://api.equalsmoney.com/v2/roqqett/merchant/logo?accountId={{accountId}}' \
              --header 'Authorization: <api-key>'
components:
  securitySchemes:
    CommonAuth:
      type: apiKey
      in: header
      name: Authorization

````