Skip to content

File uploader

Last updated: 6th July 2022

Our file uploader allows you to upload files to Checkout.com. You can then use these to provide evidence in a dispute.


Upload a file

Upload a file to use as evidence in a dispute. Your request must be multipart/form-data and the file must be in either JPEG/JPG, PNG or PDF format, and no larger than 4MB.

Endpoints

For the full specification, as well as complete request and response examples, see our API reference.

    post

    https://api.checkout.com/files

    Request example

      1
      2
      3
      4
      curl https://api.sandbox.checkout.com/files
      -H "Authorization: sk_11111111-2222-3333-4444-555555555555"
      -F "file=@/path/receipt.png;type=image/png"
      -F "purpose=dispute_evidence"

      Response example

      If the response returns a file id, your request was successful. Take a look at the example response below.

      1
      2
      3
      4
      5
      6
      7
      8
      {
      "id": "file_6lbss42ezvoufcb2beo76rvwly",
      "_links": {
      "self": {
      "href": "https://api.sandbox.checkout.com/files/file_6lbss42ezvoufcb2beo76rvwly"
      }
      }
      }

      Get file information

      Use the following endpoint to retrieve information about a file that you've uploaded.

      Endpoints

      For the full specification, as well as complete request and response examples, see our API reference.

        get

        https://api.checkout.com/files/{file_id}

        Request example

        1
        2
        curl https://api.sandbox.checkout.com/files/file_6lbss42ezvoufcb2beo76rvwly
        -H "Authorization: sk_11111111-2222-3333-4444-555555555555"

        Response example

        If the response returns a file id, your request was successful.

        1
        2
        3
        4
        5
        6
        7
        8
        9
        10
        11
        12
        13
        14
        15
        {
        "id": "file_6lbss42ezvoufcb2beo76rvwly",
        "filename": "receipt.png",
        "purpose": "dispute_evidence",
        "size": 1024,
        "uploaded_on": "2016-05-17T16:48:52.000Z",
        "_links": {
        "self": {
        "href": "https://api.sandbox.checkout.com/files/file_6lbss42ezvoufcb2beo76rvwly"
        },
        "download": {
        "href": "https://checkout-file-upload.s3.eu-west-2.amazonaws.com/ucdac/ucdac/6lbss42ezvoufcb2beo76rvwly?X-Amz-Expires=3600&x-amz-security-token=FQoDYXdzENL%2F%2F%2F%2F%2F%2F%2F%2F%2F%2FwEa"
        }
        }
        }