TransfersInternal transfers

Transfer funds between two merchants

post/api/v1/transfer/internal

Moves amount from the source merchant's balance to the destination merchant's balance. Both merchants must be enabled for internal transfers and be in the same country.

The transfer is processed asynchronously: the response only confirms it was accepted. Datman then sends a transfer succeeded or transfer failed webhook to webhook_url.

Endpoint destination URL

https://sandbox-payments.datmanpay.com/rest/api/v1/transfer/internal

Authorization

ApiTokenAuth
headerapi_token<token>

API token issued by Datman.

Request Parameters

Request Body

application/json
  1. body
source_merchant_id*string

The merchant the funds come from, as a string of digits.

Match^[0-9]+$
destination_merchant_id*string

The merchant the funds go to, as a string of digits.

Match^[0-9]+$
amount*integer

The amount in minor units (e.g. 350 is £3.50).

Range1 <= value
transfer_category_code*integer

The category of the transfer, as agreed with Datman.

Range1 <= value
description*string
reference*string

Your reference for the transfer. It is returned in the webhook.

webhook_url*string

Where Datman sends the transfer result. Use HTTPS.

Formaturi
Lengthlength <= 2048
order_id?|

The order the transfer relates to, if any.

Response parameters & Errors

Response Body

The transfer was accepted and is being processed.

application/json
  1. response
request_id*string

Datman's id for the transfer. It is returned in the webhook.

reference*string
status*string