Transfers
Register a External Transfer made External to Violet
Overview
Login
- Access
Merchants
- Merchant
- Configuration
- Onboarding
- Explore
Catalog
- Offers
- SKUs
- Categories
- Collections
- Currencies
Orders & Checkout
- Carts
- Cart Items
- Cart Customer
- Cart Discounts
- Cart Shipping
- Cart Pricing
- Cart Payment
- Cart Completion
- Orders
- Order Refunds
- Order Cancellations
- Transfers
Payments
- Payout Accounts
- Distributions
- Transfers
Events
- Webhooks
- Webhook Events
- Wekbhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Transfers
Register a External Transfer made External to Violet
POST
/
payments
/
transfers
/
register
curl --request POST \
--url https://sandbox-api.violet.io/v1/payments/transfers/register \
--header 'Content-Type: application/json' \
--data '{
"merchant_id": 123,
"payment_provider": "<string>",
"payment_provider_id": "<string>",
"related_distributions": [
123
],
"metadata": {}
}'
{
"transfer_id": 123,
"merchant_id": 123,
"payment_provider": "<string>",
"payment_provider_id": "<string>",
"successful_distributions": [
123
],
"failed_distributions": [
123
],
"metadata": {},
"date_created": "2023-11-07T05:31:56Z",
"error_details": [
{
"distribution_id": 123,
"reason": "<string>"
}
]
}
Body
application/json
Response
default - application/json
default response
The response is of type object
.
Was this page helpful?
curl --request POST \
--url https://sandbox-api.violet.io/v1/payments/transfers/register \
--header 'Content-Type: application/json' \
--data '{
"merchant_id": 123,
"payment_provider": "<string>",
"payment_provider_id": "<string>",
"related_distributions": [
123
],
"metadata": {}
}'
{
"transfer_id": 123,
"merchant_id": 123,
"payment_provider": "<string>",
"payment_provider_id": "<string>",
"successful_distributions": [
123
],
"failed_distributions": [
123
],
"metadata": {},
"date_created": "2023-11-07T05:31:56Z",
"error_details": [
{
"distribution_id": 123,
"reason": "<string>"
}
]
}