Skip to content
Developerhome
Product homepage
Payments Out Service

Upload a company logo

  Less than to read

You can upload a logo for your company in 2 steps:

  • Create an upload URL
  • Upload company logo

This only applies to cloud applications.

Create an upload URL

Send a POST request with the following headers.

The body of your request should be empty. The JSON response you receive will include the URL to upload your company logo.

Headers

POST /auth-v1/companies/{companyId}/logourl HTTP/1.1
Host: api-money.sage.com
Authorization: Bearer {access token}

Where:

  • POST /auth-v1/companies/{companyId}/logourl is the Payments Out Service endpoint where you send your request. Replace {companyId} with the unique ID of the company whose logo you want to upload. For example: POST /auth-v1/companies/b6657102-31d9-45ff-8eab-d637426ea040/logourl.

  • api-money.sage.com is your request’s base URL.

  • Bearer {access token} is the authorisation string for your request, where {access token} is a valid access token, created using the companyId of the company you want to upload a logo for.

For more information about this REST resource and its parameters, go to the Onboarding and authentication API reference.

Example response

{
    "logoId": "1edc7e66-5581-4dd1-87c7-ce7b9d54a1a9",
    "logoUploadUrl": "https://wpb-logoupload-quarantine-qa.s3.eu-west-1.amazonaws.com/images/logo/1edc7e66-5581-4dd1-87c7-ce7b9d54a1a9?X-Amz-Security-Token=FQoGZXIvYXdzEMv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDIl3EVhsKlMbdc%2FvbSKSBLGw4%2FgPbvyt2gFX9%2BYcKOOkexJNbHUQYsqttCluSJUq6y5W9u7irtdgmzR5yzyDdYUtAFzh8qwKODlwCWCZP4nZ8TsEkUtEXrFfrF%2BkM4JyJnDLBBU9pVpFjlIe%2BmdgDzej5%2FuyYNEaZxSXOu5j0fccp0y00VXzpqbVe90bkQo5BV9weqj2roJWpxW2UYh0GTE5kgva75YdZLOZbxO%2FAS0NU1fdX7YIWIb%2Fn3zrUmO1mlLDGCKxUKOq3EJZfWhveuK0inJ5kQEz96bsSkP81DUVcnhi0XNbfz3eWPSamSniZd0oHO53rDK7MTsA%2FJdXD3IGS8r%2BZ36lSH69r9kd5maNxeX%2Fiai0vI5DCHvIqzpMq0LmqGbid2RTO3gbAuWhPLIlEgDJTJtk0Z5zXaVFrwgivQSqPMTofDW8gPztSP0Yc8b0tALU9AarayP7N%2BrA6yYKQbZWlgOeTkYP4E1khSpZCtnEcZZBweD84854pOumxTyJPfY4CV%2FtYa57Fpp2YFIleE2ItuDzbBMZzFZSuYVAbAaWCWBcZ9bD6yVQD97LhkJchHTjevBZkxKNWl0puk1Dei4M2pvv2z6DAqMx44JnbtWmkby7GC3HiWuLYk2ZZ7KB4esMGtGVIsHZBKqDyrcMcMfjmY3vq3bxXVwUj0fV0ZpMzgwIHxhxT2rZNkiPEEFrERC7DHKH2QTXReZy8aRsKMbvquYF&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Date=20190502T102142Z&X-Amz-SignedHeaders=host&X-Amz-Expires=599&X-Amz-Credential=ASIATDC45PLYUP4J26V5%2F20190502%2Feu-west-1%2Fs3%2Faws4_request&X-Amz-Signature=5bcfa7f5670a0b75d41f13f0ebf8daab68ebdb550b4c87ec863cfedd3b89ae59"
}

In this response:

  • logoId contains the ID that is used to identify the uploaded logo file.
  • logoUploadUrl contains the URL to upload your company logo. The upload URL remains valid for a limited amount of time.

Send a PUT request with the following headers and body using the URL you received in the 1st step.

The logo file is uploaded to a quarantine bucket for checking. If the logo file passes the checks, it is moved to a content bucket.

If the checks fail, an email is sent to the company administrator email address. The email explains why the checks failed.

Headers

PUT {URI} HTTP/1.1
Host: {base URL}
Content-Type: {file type}

Where:

  • {URI} is the URI to upload the logo. This was provided in the response you received in the 1st step.

  • {base URL} is the base URL for uploading the logo. This was provided in the response you received in the 1st step.

  • {file type} is the logo file type. Payments Out Service supports the following file types:

    • .jpeg (image/jpeg)
    • .png (image/png)
    • .gif (image/gif)

Body

{Add the company logo file here}

Example request

PUT /images/logo/afd166bf-bdd5-4b9a-ba1e-3cfec95c6fc6?X-Amz-Security-Token=FQoawevYXdzEMv%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEaDIl3EVhsKlMbdc%2FvbSKSBLGw4%2FgPbvyt2gFX9%2BYcKOOkexJNbHUQYsqttCluSJUq6y5W9u7irtdgmzR5yzyDdYUtAFzh8qwKODlwCWCZP4nZ8TsEkUtEXrFfrF%2BkM4JyJnDLBBU9pVpFjlIe%2BmdgDzej5%2FuyYNEaZxSXOu5j0fccp0y00VXzpqbVe90bkQo5BV9weqj2roJWpxWerwgty5YdZLOZbxO%2FAS0NU1fdX7YIWIb%2Fn3zrUmO1mlLDGCKxUKOq3EJZfWhveuK0inJ5kQEz96bsSkP81DUVcnhi0XNbfz3eWPSamSniZd0oHO53rDK7MTsA%2FJdXD3IGS8r%2BZ36lSH69r9kd5maNxeX%2Fiai0vI5DCHvIqzpMq0LmqGbid2RTO3gbAuWhPLIlEgDJTJtk0Z5zXaVFrwgivQSqPMTofDW8gPztSP0Yc8b0tALU9AarayP7N%2BrA6yYKQbZWlgOeTkYP4E1khSpZCtnEcZZBweD84854pOumxTyJPfY4CV%2FtYa57Fpp2YFIleE2ItuDzbBMZzFZSuYVAbAaWCWBcZ9bD6yVQD97LhkJchHTjevBZkxKNWl0puk1Dei4M2pvv2z6DAqMx44JnbtWmkby7GC3HiWuLYk2ZZ7KB4esMGtGVIsHZBKqDyrcMcMfjmY3vq3bxXVwUj0fV0ZpMzgwIHxhxT2rZNkiPEEFrERC7DHKH2QTXReZy8aRsKMbvquYF& X-Amz-Algorithm=AWS4-HMAC-SHA256& X-Amz-Date=20190502T115719Z& X-Amz-SignedHeaders=host& X-Amz-Expires=599& X-Amz-Credential=ASaAfaaLYUP4J26V5%2F20190502%2Feu-west-1%2Fs3%2Faws4_request& X-Amz-Signature=fcwfyf6c7702b8dcd4cg2e7b656f4383ab167etywqe86b55540378e HTTP/1.1
Host: wpb-logoupload-quarantine-qa.s3.eu-west-1.amazonaws.com
Content-Type: image/png

CompanyLogo.png