Retrieve attachment

Browse API reference

GET/attachments/{attachmentId}getAttachment

Use this method to retrieve the details of an attachment.

To retrieve the details of an attachment you need its attachmentId. Our gateway returned the attachmentId in the response of the Upload Attachment to Processing Account method.

Our gateway returns information about the attachment, including its upload status and the entity that the attachment is linked to. Our gateway doesn't return the file that you uploaded.

Parameters

Name	In	Type	Description
`attachmentId`Required	path	`string`	Unique identifier of the attachment.

Responses

Successful request. Returns the attachment.

200 OK · application/json

{
  "attachmentId": "15387",
  "contentType": "application/pdf",
  "createdDate": "2025-09-18T10:19:18.522Z",
  "description": "Passport for Jane Doe",
  "entity": {
    "id": "2585",
    "type": "processingAccount"
  },
  "fileName": "JaneDoePassport.pdf",
  "lastModifiedDate": "2025-09-18T10:19:18.522Z",
  "metadata": {
    "passportId": "123456789"
  },
  "type": "personalIdentification",
  "uploadStatus": "accepted"
}

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

Invalid request

400 Bad Request · application/problem+json

{
  "detail": "One or more validation errors occurred, see error section for more info",
  "errors": [
    {
      "detail": "invalid date",
      "message": "Expected time, got '' for start_time",
      "parameter": "start_time"
    }
  ],
  "status": 400,
  "title": "Bad request",
  "type": "https://docs.payroc.com/api/errors#bad-request"
}

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

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