Create lost transaction

This request will allow you to create transaction search requests in our system.

Create new lost transaction

post

Either order_id or custom_transaction_id must be set.

Authorizations
Query parameters
project_idnumberRequired

Project ID in the A-Pay system

Example: 1234567
Body
filestring · binaryRequired

Supported file formats: jpg, png, heic, jpeg, pdf.

order_idstring · min: 16 · max: 16Optional

Deposit ID in the A-Pay system

Example: 0123456789abcdefPattern: ^[0-9a-f]+$
custom_transaction_idstring · min: 1 · max: 200Optional

Transaction ID in the client's system

Default: nullExample: test_custom_id123
descriptionstring · min: 1 · max: 100000Optional

Description of a lost transaction

Default: nullExample: Some description of a lost transaction
Responses
200
Success
application/json
post
POST /Remotes/create-lost-transaction?project_id=1 HTTP/1.1
Host: <domain>
apikey: YOUR_API_KEY
Content-Type: multipart/form-data
Accept: */*
Content-Length: 146

{
  "file": "binary",
  "order_id": "0123456789abcdef",
  "custom_transaction_id": "test_custom_id123",
  "description": "Some description of a lost transaction"
}
{
  "success": true,
  "status": "Pending",
  "order_id": "0123456789abcdef",
  "custom_transaction_id": "test_custom_id123",
  "message": "Transaction successfully created"
}

⚠️ Error Handling Guide

The following section describes possible error responses for the POST /Remotes/create-lost-transaction endpoint and how you can resolve them by yourself.

400 Bad Request – Validation Errors

When it happens:

  • order_id or custom_transaction_id is missing or has an invalid format

  • Field values do not meet length or pattern requirements

How to resolve it:

The response body contains detailed information about what went wrong. Make sure to inspect the following fields in the JSON response:

Field
Description

target

Indicates which part of the request failed (e.g. "form_data", "query")

errors[].message

Description of what exactly is wrong (e.g., “ensure this value has at least 16 characters”)

errors[].location

Path to the field that caused the error (e.g., ["order_id"])

400 Bad Request – Duplicate Request

When it happens:

A lost transaction issue has already been created for the same ID.

How to resolve it:

Use GET /lost-transaction-info to check existing issue status

401 Unauthorized

When it happens:

Missing or incorrect API key in the request.

How to resolve it:

  • Include the header: Authorization: Bearer YOUR_API_KEY

  • Check that your key is valid and linked to the correct project_id

404 Not Found

When it happens:

The provided order_id or custom_transaction_id does not match any transaction.

How to resolve it:

  • Check that you’re sending the correct ID

  • Confirm the transaction exists in your system

  • Contact our support team if you're certain the payment was made

422 Unprocessable Entity – File Upload Issues

When it happens:

Issues with the uploaded file field:

  • Missing file

  • Unsupported file format

  • File size too large

  • Too many files

How to resolve it:

  • Make sure the uploaded file is in one of the supported formats: jpg, png, heic, jpeg, pdf

  • Ensure the file size does not exceed 20 MB

  • Attach no more than 16 files in a single request

Last updated