Upload attachment to processing account

Browse API reference

POST/processing-accounts/{processingAccountId}/attachmentscreateProcessingAccountAttachment

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 50MB 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.

Parameters

Name	In	Type	Description
`Idempotency-Key`Required	header	`string`	Unique identifier that you generate for each request. You must use the UUID v4 format for the identifier. For more information about the idempotency key, go to Idempotency.
`processingAccountId`Required	path	`string`	Unique identifier that we assigned to the processing account.

Request body

multipart/form-data · required

Field Edit request inputs →

attachmentobjectrequired
Object that contains details about the attachment.
- descriptionstring
  Short description of the attachment.≤ 250 chars
- metadataobject
  Object that you can send to include custom metadata in the request.
- typestringrequired
  Type of attachment.5–25 charsbankingEvidencequestionnairesAndLicensesmerchantStatementstaxDocumentsmpaOrAmendmentproofOfBusinessfinancialStatementspersonalIdentification+1 more
filestringbinaryrequired
File that you want to upload.

Responses

Successful request. We received the attachment.

201 Created · application/json

{
  "attachmentId": "2587",
  "contentType": "application/pdf",
  "createdDate": "2024-07-02T12:00:00.000Z",
  "description": "Passport as identification for lease agreement",
  "entity": {
    "id": "38765",
    "type": "processingAccount"
  },
  "fileName": "JaneDoePassport.pdf",
  "lastModifiedDate": "2024-07-02T12:00:00.000Z",
  "metadata": {
    "documentId": "2345"
  },
  "type": "personalIdentification",
  "uploadStatus": "pending"
}

Response schema · 12 fields

attachmentIdstringrequired
Unique identifier that our gateway assigned to the attachment.
contentTypestringrequired
Content type of the file.≤ 76 chars
createdDatestringdate-timerequired
Date and time that we received your request to upload the attachment.
descriptionstring
Short description of the attachment.≤ 250 chars
entityobjectrequired
Object that contains information about the entity that the attachment is linked to.
- idstringrequired
  Unique identifier of the entity that the attachment is linked to.≤ 50 chars
- typestringrequired
  Type of entity that the attachment is linked to.≤ 17 charsprocessingAccount
fileNamestringrequired
Name of the file.≤ 150 chars
lastModifiedDatestringdate-timerequired
Date and time the attachment was last modified.
metadataobject
Object that you can send to include custom metadata in the request.
typestringrequired
Type of attachment.5–22 charsbankingEvidencequestionnairesAndLicensesmerchantStatementstaxDocumentsmpaOrAmendmentproofOfBusinessfinancialStatementspersonalIdentification+1 more
uploadStatusstringrequired
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.≤ 8 charspendingacceptedrejected

Validation error

400 Bad Request · application/problem+json

{
  "detail": "'Idempotency-Key' is already in use against a different request",
  "status": 409,
  "title": "Idempotency-Key in use",
  "type": "https://docs.payroc.com/api/errors#idempotency-key-in-use"
}

Response schema · 8 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Identity could not be verified

401 Unauthorized · application/problem+json

{
  "detail": "Your identity could not be verified",
  "status": 401,
  "title": "Not Authorized",
  "type": "https://docs.payroc.com/api/errors#not-authorized"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Do not have permissions to perform this action

403 Forbidden · application/problem+json

{
  "detail": "You do not have the required permissions to perform this action",
  "instance": "https://api.payroc.com/v1/exampleResource/3",
  "resource": "exampleResource",
  "status": 403,
  "title": "Forbidden",
  "type": "https://docs.payroc.com/api/errors#forbidden"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Resource not found

404 Not Found · application/problem+json

{
  "detail": "Resource not found",
  "resource": "(The Type of the Resource)",
  "status": 404,
  "title": "Not found",
  "type": "https://docs.payroc.com/api/errors#not-found"
}

Response schema · 5 fields

detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Not acceptable

406 Not Acceptable · application/problem+json

{
  "detail": "Resource does not support the representation requested",
  "status": 406,
  "title": "Not acceptable",
  "type": "https://docs.payroc.com/api/errors#not-acceptable"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Conflict

409 Conflict · application/problem+json

{
  "detail": "The resource you attempted to create already exists",
  "instance": "https://api.payroc.com/v1/merchant/12345",
  "status": 409,
  "title": "Resource already exists",
  "type": "https://docs.payroc.com/api/errors#resource-already-exists"
}

Response schema · 13 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- detailstring
  Short detail of the validation errors
- messagestring
  Error message
- parameterstring
  The parameter or field causing the issues
instancestring
Resource path to the existing resource
linkobject
Object that contains HATEOAS links for the resource.
- hrefstringrequired
  URL of the target resource.
- methodstringrequired
  HTTP method that you need to use with the target resource.
- relstringrequired
  Indicates the relationship between the current resource and the target resource.
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Payload too large

413 Payload Too Large · application/problem+json

{
  "detail": "The payload submitted is too large",
  "status": 413,
  "title": "Payload too large",
  "type": "https://docs.payroc.com/api/errors#payload-too-large"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Unsupported media type

415 Unsupported Media Type · application/problem+json

{
  "detail": "You submitted a payload in an unsupported format",
  "status": 415,
  "title": "Unsupported media type",
  "type": "https://docs.payroc.com/api/errors#unsupported-media-type"
}

Response schema · 4 fields

detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

An error has occured

500 Internal Server Error · application/problem+json

{
  "detail": "We are unable to process your request at this time",
  "errors": [
    {
      "message": "Service offline"
    }
  ],
  "status": 500,
  "title": "Api error",
  "type": "https://docs.payroc.com/api/errors#api-error"
}

Response schema · 6 fields

detailstringrequired
Explanation of the problem
errorsobject[]
- messagestring
  Error message
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type

Used in workflows

add-attachment

Upload attachment to processing account

Browse API reference

Parameters

Request body

Responses

Used in workflows

Menu

Sign out

Talk to an engineer