Upload attachment to processing account

Before you upload an attachment, make sure that you follow local privacy regulations and get the merchant’s consent to process their information.

Note: You need the ID of the processing account before you can upload an attachment. If you don’t know the processingAccountId, go to the Retrieve a Merchant Platform method.

The attachment must be an uncompressed file under 30MB in one of the following formats:

.bmp, csv, .doc, .docx, .gif, .htm, .html, .jpg, .jpeg, .msg, .pdf, .png, .ppt, .pptx, .tif, .tiff, .txt, .xls, .xlsx

In the request, include the attachment that you want to upload and the following information about the attachment:

type - Type of attachment that you want to upload.
description - Short description of the attachment.

In the response, our gateway returns information about the attachment including its upload status and an attachmentId that you can use to Retrieve the details of the Attachment.

> Before you upload an attachment, make sure that you follow local privacy regulations and get the merchant's consent to process their information. **Note:** You need the ID of the processing account before you can upload an attachment. If you don't know the processingAccountId, go to the [Retrieve a Merchant Platform](https://docs.payroc.com/api/schema/boarding/merchant-platforms/retrieve) method. The attachment must be an uncompressed file under 30MB in one of the following formats: - .bmp, csv, .doc, .docx, .gif, .htm, .html, .jpg, .jpeg, .msg, .pdf, .png, .ppt, .pptx, .tif, .tiff, .txt, .xls, .xlsx In the request, include the attachment that you want to upload and the following information about the attachment: - **type** - Type of attachment that you want to upload. - **description** - Short description of the attachment. In the response, our gateway returns information about the attachment including its upload status and an attachmentId that you can use to [Retrieve the details of the Attachment](https://docs.payroc.com/api/schema/attachments/get-attachment).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

processingAccountIdstringRequired

Unique identifier that we assigned to the processing account.

Request

This endpoint expects a multipart form containing a file.

attachmentobjectRequired

Object that contains details about the attachment.

filefileRequired

File that you want to upload.

Response

Successful request. We received the attachment.

attachmentIdstring

Unique identifier that our gateway assigned to the attachment.

typeenum

Type of attachment.

uploadStatusenum

Upload status of the attachment. The value is one of the following:

pending - We have not yet uploaded the attachment.
accepted - We have uploaded the attachment.
rejected - We rejected the attachment.

Upload status of the attachment. The value is one of the following: - `pending` - We have not yet uploaded the attachment. - `accepted` - We have uploaded the attachment. - `rejected` - We rejected the attachment.

Allowed values:

fileNamestring<=150 characters

Name of the file.

contentTypestring<=76 characters

Content type of the file.

entityobject

Object that contains information about the entity that the attachment is linked to.

createdDatedatetime

Date and time that we received your request to upload the attachment.

lastModifiedDatedatetime

Date and time the attachment was last modified.

descriptionstring or null<=250 characters

Short description of the attachment.

metadatamap from strings to strings or null

Object that you can send to include custom metadata in the request.

1	var client = new RestClient("https://api.payroc.com/v1/processing-accounts/38765/attachments");
2	var request = new RestRequest(Method.POST);
3	request.AddHeader("Idempotency-Key", "8e03978e-40d5-43e8-bc93-6894a57f9324");
4	request.AddHeader("Authorization", "Bearer <token>");
5	request.AddParameter("undefined", "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"attachment\"\r\n\r\n{\n \"type\": \"personalIdentification\"\n}\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"file\"; filename=\"string\"\r\nContent-Type: application/octet-stream\r\n\r\n\r\n-----011000010111000001101001--\r\n", ParameterType.RequestBody);
6	IRestResponse response = client.Execute(request);

1	{
2	"attachmentId": "2587",
3	"type": "personalIdentification",
4	"uploadStatus": "pending",
5	"fileName": "JohnSmithPassport.pdf",
6	"contentType": "application/pdf",
7	"entity": {
8	"type": "processingAccount",
9	"id": "12667"
10	},
11	"createdDate": "2024-07-02T12:00:00.000Z",
12	"lastModifiedDate": "2024-07-02T12:00:00.000Z",
13	"description": "Passport as identification for lease agreement",
14	"metadata": {
15	"passportId": "123456789"
16	}
17	}

Authentication

Path parameters

Headers

Request

Response

Errors