v1

latestOpenAPI 3.0.32026-07-2476126451.9 KB
v1.4

Create a settlement file

Creates a new settlement file and returns a presigned URL for uploading. After uploading the file to the presigned URL, the client must call the confirm upload endpoint to confirm that the file has been uploaded and is ready to be processed.

post/api/v1.4/reconciliations/settlement-files/

Request body

idstring

File id - Returned after creating the settlement file instance, used for confirming the upload

template_type'CHECKOUTCOM' | 'PAYFORT_MAGNATI' | 'TAP_CHARGE' | 'TAP_REFUND' | 'PEACH_PAYMENTS' required

Type of the settlement file being uploaded. This determines the expected format of the file and how it will be processed. Supported types are: CHECKOUTCOM, PAYFORT_MAGNATI, TAP_CHARGE, TAP_REFUND, PEACH_PAYMENTS

  • CHECKOUTCOM - CHECKOUTCOM
  • PAYFORT_MAGNATI - PAYFORT_MAGNATI
  • TAP_CHARGE - TAP_CHARGE
  • TAP_REFUND - TAP_REFUND
  • PEACH_PAYMENTS - PEACH_PAYMENTS
file_namestring required

Name of the settlement file being uploaded, including extension.

upload_urlstring required

Presigned URL to which the settlement file should be uploaded. This is returned after creating the settlement file instance.

Response

idstring

File id - Returned after creating the settlement file instance, used for confirming the upload

template_type'CHECKOUTCOM' | 'PAYFORT_MAGNATI' | 'TAP_CHARGE' | 'TAP_REFUND' | 'PEACH_PAYMENTS' required

Type of the settlement file being uploaded. This determines the expected format of the file and how it will be processed. Supported types are: CHECKOUTCOM, PAYFORT_MAGNATI, TAP_CHARGE, TAP_REFUND, PEACH_PAYMENTS

  • CHECKOUTCOM - CHECKOUTCOM
  • PAYFORT_MAGNATI - PAYFORT_MAGNATI
  • TAP_CHARGE - TAP_CHARGE
  • TAP_REFUND - TAP_REFUND
  • PEACH_PAYMENTS - PEACH_PAYMENTS
file_namestring required

Name of the settlement file being uploaded, including extension.

upload_urlstring required

Presigned URL to which the settlement file should be uploaded. This is returned after creating the settlement file instance.