Sign in

v1

latestOpenAPI 3.1.02026-07-24180245513.9 KB
Files

Cancel file

Cancel a file in status created. Canceling a file updates its status to canceled. The payment orders, returns, or return requests included in the file are updated to their previous status.

post/files/{id}/cancel

Path parameters

idstring uuid required

The UUID of the file.

Response

200

idstring required

The UUID of the file.

object'file' required

Label used to identify this kind of object.

connected_account_idstring uuid required

The ID of the connected account used to send or receive the file.

connected_account_idsstring[] required

The IDs of the connected accounts used to send or receive the file.

direction'outgoing' | 'incoming' required

The transfer direction for the file_id: - outgoing for files sent or to be sent to the bank - incoming for files received from the bank

category'bank_file' | 'payment_file' | 'report_file' | 'return_request_file' | 'return_file' | 'account_report' | 'account_statement' | 'account_notification' | 'inquiry_category' | 'denied_inquiry_file' | 'denied_return_request_file' | 'error_file_format' | 'unknown_file_format' | 'forwarded_message' required

The category of the file.

formatstring required

The format of the file.

filenamestring required

The name of the file.

sizeinteger required

The size of the file, expressed in bytes.

summaryobject required

A summary of the file, depending on its content.

status'created' | 'approved' | 'canceled' | 'sent' | 'rejected' | 'processed' | 'received' required

The status of the file.

status_detailsstring required

The details of the status of this file, such as the rejection reason for instance.

created_atstring date-time required

The UTC timestamp of the creation of the file.

Example response

{
  "id": "3ad331b9-12b2-48fd-ad35-203fe8b5e78e",
  "object": "file",
  "connected_account_ids": [
    "6669205e-e306-4b44-bf40-0475899eeb60"
  ],
  "direction": "outgoing",
  "format": "pain.001",
  "filename": "SFPP30X40.3ad331b9-12b2-48fd-ad35-203fe8b5e78e.1659349967",
  "size": 2234,
  "bank_data": {
    "message_ids": [
      "211012231391882"
    ]
  },
  "status_details": "generated on 2022-08-01",
  "created_at": "2022-08-01T06:00:05Z"
}