Go to home page
Docs API Reference

Media Uploads

Media Upload Model

Attributes

  • id

    string

    The Media Upload's unique identifier.

  • file

    object

    A file to upload. Make sure that the specifications follow RFC 2388 , which defines file transfers for the multipart/form-data protocol.

  • purpose

    string

    The purpose of the Media Upload.

  • createdAt

    timestamp

    When the Media Upload was created.

  • createdBy

    crn

    The User or API Key that created the Media Upload.

  • updatedAt

    timestamp

    When the Media Upload was updated.

  • updatedBy

    crn

    The User or API Key that updated the Media Upload.

Purpose

Each valid purpose has specific file format and size requirements.

PurposeDescriptionSupported MIME TypesMax Size
business-onboardingA file used to onboard Businesses so that they can accept payments.CSV50KB
branding-logoA logo used for any branding including Tokens and Businesses .JPEG, PNG512KB

Create a Media Upload experimental

This endpoint allows you to upload a file to Centrapay.

Attributes

  • file

    object required

    A file to upload. Make sure that the specifications follow RFC 2388 , which defines file transfers for the multipart/form-data protocol.

  • purpose

    string required

    The purpose of the Media Upload.

Errors

  • FILE_TYPE_INVALID

    403

    Invalid file extension or mime type provided for the purpose.

  • FILE_TOO_LARGE

    403

    File size exceeds the allowed threshold.

Request
curl -X POST \
 https://service.centrapay.com/api/media-uploads \
 -H 'content-type: multipart/form-data' \
 -H 'x-api-key: <TOKEN>' \
 -F purpose=branding-logo \
 -F file=@/path/to/a/file.png
Response
{
  "id": "DKTs3U38hdhfEqwF1JKoT2"
}

Get Media Upload Location experimental

This endpoint allows you to retrieve the upload location of a media file.

Request
curl -X GET \
 https://service.centrapay.com/api/media-uploads/DKTs3U38hdhfEqwF1JKoT2/location \
 -H 'x-api-key: <TOKEN>'
Response
{
  "url": "https://media-upload.centrapay.com/image.png?jhbdsfau67ewejshb=487hsdjhbdgs743"
}