Upload image payment link

PATCH/payment-links/upload-image/{paymentLinkId}

Add an image to the payment link.

⚠️ Note: File upload may not work here due to documentation limitations. Try using Postman or curl to test it properly.

⚠️ Note: It will not be possible to update the image if there is a sale on the payment link

Request

curl --request PATCH \
  --url 'https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/payment-links/upload-image/PAYMENT_LINK_ID' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'x-api-secret: YOUR_API_SECRET' \
  --header 'business-id: YOUR_BUSINESS_ID' \
  --form 'picture=@/path/to/picture'

Generated from the schema

import { openAsBlob } from 'node:fs';

const form = new FormData();
form.append('picture', await openAsBlob('/path/to/picture'));

const response = await fetch('https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/payment-links/upload-image/PAYMENT_LINK_ID', {
  method: 'PATCH',
  headers: {
    'x-api-key': 'YOUR_API_KEY',
    'x-api-secret': 'YOUR_API_SECRET',
    'business-id': 'YOUR_BUSINESS_ID',
  },
  body: form,
});

const data = await response.json();
console.log(data);

Generated from the schema

import requests

url = "https://9iq81tsdy4.execute-api.sa-east-1.amazonaws.com/payment-links/upload-image/PAYMENT_LINK_ID"
headers = {
    "x-api-key": "YOUR_API_KEY",
    "x-api-secret": "YOUR_API_SECRET",
    "business-id": "YOUR_BUSINESS_ID",
}
files = {
    "picture": open("/path/to/picture", "rb"),
}

response = requests.patch(url, headers=headers, files=files)
print(response.json())

Generated from the schema

Response

{
  "statusCode": 200,
  "data": {
    "image": {
      "name": "cover.jpg",
      "path": "payment-link/2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d",
      "url": "https://example.com/payment-link/2a3b4c5d-6e7f-4a8b-9c0d-1e2f3a4b5c6d/cover.jpg",
      "isPublic": true,
      "extension": "jpg"
    }
  }
}

{
  "message": "Invalid param: []",
  "error": "Bad Request",
  "statusCode": 400,
  "errorCode": "string"
}

Generated from the schema

{
  "message": "Unauthorized",
  "error": "Unauthorized",
  "statusCode": 401
}

Generated from the schema

{
  "message": "Forbidden resource",
  "error": "Forbidden",
  "statusCode": 403
}

Generated from the schema

{
  "statusCode": 422,
  "message": "Unprocessable Entity",
  "error": "Unprocessable Entity"
}

{
  "statusCode": 500,
  "message": "Internal Server Error"
}

Generated from the schema

Headers

x-api-keystringrequired
Api key provided on integrations tab in Easyflow platform.
x-api-secretstringrequired
Api Secret provided on integrations tab in Easyflow platform.
business-idstringrequired
Business Identifier

Path parameters

paymentLinkIdstringrequired

Request body

Content typemultipart/form-dataobject

picturestring · binaryrequired
Image file to upload. The file name must end in .png, .jpg or .jpeg and the file can have up to 5,000,000 bytes. Otherwise the API returns 422.