🚧 This project is currently in active development. A sandbox environment will be made available soon for testing and exploration. Stay tuned!

Datman API's

Internal Transfer

Testing

GET

https://ws2-payments.datmanpay.com/antar/api/v1/transfers/{transfer_id}

Get Transfer Details API

Overview

This API retrieves the details of a specific fund transfer by its transferId. It is used to fetch the status and metadata of a previously initiated transfer between merchant accounts.

The API returns information such as the transfer amount, currency, source and destination merchant IDs, reference ID, status, and description.

This is helpful for reconciliation, tracking, and verifying the outcome of a transfer.

How It Works

The client makes a GET request with the transferId as a path or query parameter.

The API responds with the full details of the transfer if it exists.

Useful for checking if a transfer was successfully booked or still pending.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://ws2-payments.datmanpay.com/antar/api/v1/transfers/TRFJXQMYT8MVYKV' \
--header 'api_token: ' \
--header 'Content-Type: application/json'

Response Example

200 - Success

{
  "transfer_id": "TRFKXQMYA8MVYKW",
  "amount": 120,
  "currency": "GBP",
  "description": "split-transfer-refund-907993",
  "merchant_reference": "528698590",
  "source_merchant_id": 663208112,
  "destination_merchant_id": 663208112,
  "status": "success",
  "reason": "Transfer successfully processed",
  "created_at": "2025-03-08T12:34:56Z",
  "processed_at": "2025-03-08T12:36:00Z"
}

Request

Path Params

transfer_id

string

required

Example:

TRFJXQMYT8MVYKV

Header Params

api_token

string

required

Example:

Content-Type

string

required

Example:

application/json

Responses

🟢200Success

application/json

Body

transfer_id

string

required

Unique identifier for the transfer transaction

amount

integer

required

Amount transferred

currency

string

required

Currency of the transfer

description

string

required

Description or label for the transfer

merchant_reference

string

required

Reference ID for tracking purposes

source_merchant_id

integer

required

Merchant ID from which funds were debited

destination_merchant_id

integer

required

Merchant ID to which funds were credited

status

string

required

Status of the transfer (e.g., accepted/success/failed)

reason

string

required

additional information

created_at

string

required

is an ISO 8601 timestamp in UTC

processed_at

string

required

is an ISO 8601 timestamp in UTC

🟠404Record Not Found

🟠401Unauthorized

Internal Transfer

Schedule Payout

Internal Transfer

Get Transfer Details API#

Overview#

How It Works#

Request

Responses

Get Transfer Details API

Overview

How It Works