This site requires javascript to be enabled.

Results for

xxx

Retrieve File

GET https://{domainname}/files/v1/{merchantId}/files/{fileId}

Files

This REST service allows you to retrieve a file you uploaded previously using the fileId.

Request

Use this call to retrieve an uploaded file using its fileId. This fileId was returned to you in the response on the Upload File request. The request does not have any additional input parameters.

Request example

SDK: Ruby

This scenario you will probably use the most

  • client.v1.merchant('merchantId').files.get_file('fileId') do |headers, response_body|
        # Use the headers and response body
        # For instance:
        while chunk = response_body.read(8192)
          # do something with the chunk
        end
    end
    

Responses

Please find below an overview of the possible responses.

Response 200 - OK

An HTTP 200 response is returned with the file when the request was successful.

The response will have a Content-Type header that describes what type of file it is. It will also have a Content-Disposition header with type "attachment" and the file's name. If it is known, there will be a Content-Length header with the file's size.
For example:

* Content-Type: application/
* Content-Disposition: attachment; filename="examplefile"
* Content-Length: 1234

Response example

SDK: Ruby

This scenario you will probably use the most

  • <File content>
    

Response 404 - Not foundErrorResponse

No file was found for the given fileId.

Properties
Property Type Required Details
close

Description

Unique reference, for debugging purposes, of this error response
close

Description

List of one or more errors
close

Description

Contains detailed information on one single error.
  • SDK Object type
    APIError
close

Description

Category the error belongs to. The category should give an indication of the type of error you are dealing with. Possible values:
  • CONNECT_PLATFORM_ERROR - indicating that a functional error has occurred in the Connect platform.
  • PAYMENT_PLATFORM_ERROR - indicating that a functional error has occurred in the Payment platform.
  • IO_ERROR - indicating that a technical error has occurred within the Connect platform or between Connect and any of the payment platforms or third party systems.
close

Description

Error code
close

Description

HTTP status code for this error that can be used to determine the type of error
close

Description

ID of the error. This is a short human-readable message that briefly describes the error.
close

Description

Human-readable error message that is not meant to be relayed to customer as it might tip off people who are trying to commit fraud
close

Description

Returned only if the error relates to a value that was missing or incorrect.
Contains a location path to the value as a JSonata query.
Some common examples:
  • a.b selects the value of property b of root property a,
  • a[1] selects the first element of the array in root property a,
  • a[b='some value'] selects all elements of the array in root property a that have a property b with value 'some value'.
close

Description

ID of the request that can be used for debugging purposes

Response example

SDK: Ruby

This scenario you will probably use the most

  • {
        "errorId" : "5c3365733fd1b84ac4cfcd0cf9ee69e4",
        "errors" : [
            {
                "code" : "310400100",
                "id" : "DISPUTE_DATA_ERROR",
                "category" : "DISPUTE_SERVICE_ERROR",
                "httpStatusCode" : 404
            }
        ]
    }