Register an External Transfer made External to Violet

Register a External Transfer made External to Violet

post

Header parameters

X-Violet-TokenstringRequired

X-Violet-App-SecretstringRequired

X-Violet-App-Idinteger · int32Required

Body

merchant_idinteger · int32Optional

Unique identifier of the merchant associated with this external transfer.

payment_providerstringOptional

Name of the payment provider (e.g. STRIPE, PAYPAL) associated with this external transfer.

payment_provider_idstringOptional

Unique identifier of transfer to the merchant in the payment provider system.

related_distributionsinteger · int32[]Optional

List of Distribution IDs associated with this pending transfer response. The total pending transfer amount equals the sum of all related pending distributions.

Responses

default

default response

application/json

post

HTTPcURLJavaScriptPython

POST /v1/payments/transfers/register HTTP/1.1
Host: sandbox-api.violet.io
X-Violet-Token: text
X-Violet-App-Secret: text
X-Violet-App-Id: 1
Content-Type: application/json
Accept: */*
Content-Length: 142

{
  "merchant_id": 1,
  "payment_provider": "text",
  "payment_provider_id": "text",
  "related_distributions": [
    1
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

default

default response

{
  "transfer_id": 1,
  "merchant_id": 1,
  "payment_provider": "text",
  "payment_provider_id": "text",
  "successful_distributions": [
    1
  ],
  "failed_distributions": [
    1
  ],
  "metadata": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "date_created": "2025-07-10T00:54:41.997Z",
  "error_details": [
    {
      "distribution_id": 1,
      "reason": "text"
    }
  ]
}