Sign in
attachments

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

post/processing-accounts/{processingAccountId}/attachments

Path parameters

processingAccountIdstring required

Unique identifier that we assigned to the processing account.

Headers

Authorizationstring required

Bearer authentication

Idempotency-Keystring uuid required

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.

Response

Successful request. We received 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

No recorded changes to this endpoint across all 1 revision of this API.