attachments

Retrieve attachment

Changed on

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.

get/attachments/{attachmentId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/attachments/{attachmentId}
  • Auth
    HTTP bearer

Path parameters

attachmentIdstring required

Unique identifier of the attachment.

Response

Successful request. Returns the attachment.

attachmentIdstring required

Unique identifier that our gateway assigned to the attachment.

type'bankingEvidence' | 'questionnairesAndLicenses' | 'merchantStatements' | 'taxDocuments' | 'mpaOrAmendment' | 'proofOfBusiness' | 'financialStatements' | 'personalIdentification' | 'other' required

Type of attachment.

uploadStatus'pending' | 'accepted' | 'rejected' required

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.
fileNamestring required

Name of the file.

contentTypestring required

Content type of the file.

descriptionstring

Short description of the attachment.

createdDatestring date-time required

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

lastModifiedDatestring date-time required

Date and time the attachment was last modified.

metadataobject

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

Changes