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
- Transfer Reversals
Events
- Webhooks
- Webhook Events
- Webhook Headers
Apps
- Merchant/App Installs
- Commission Rates
Operations
- Connection
Relay
- Shipping
Ecom Syncs
- Offers
Transfers
Search Transfers
POST
https://sandbox-api.violet.io/v1
/
payments
/
transfers
curl --request POST \
--url https://sandbox-api.violet.io/v1/payments/transfers \
--header 'Content-Type: application/json' \
--data '{
"order_id": 123,
"bag_id": 123,
"merchant_id": 123,
"payout_account_id": 123,
"payout_id": 123,
"paypro_transfer_id": 123,
"status": "SENT",
"created_after": "2023-11-07T05:31:56Z",
"created_before": "2023-11-07T05:31:56Z"
}'
{
"totalPages": 123,
"totalElements": 123,
"first": true,
"size": 123,
"content": [
{
"id": 123,
"payment_transaction": 123,
"payout_id": 123,
"payment_provider_id": "<string>",
"payment_provider_payout_id": "<string>",
"payout_account_id": 123,
"bag_amount": 123,
"bag_currency": "<string>",
"amount": 123,
"currency": "<string>",
"status": "SENT",
"payment_provider": "STRIPE",
"related_orders": [
"<string>"
],
"related_bags": [
"<string>"
],
"related_distributions": [
"<string>"
],
"transfer_reversals": [
"<string>"
],
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"errors": [
{
"id": 123,
"error_code": 123,
"error_message": "<string>",
"resolved": true,
"date_resolved": "2023-11-07T05:31:56Z",
"date_created": "2023-11-07T05:31:56Z",
"payout_transfer_id": 123
}
],
"payoutExternalId": "<string>",
"paymentService": "STRIPE",
"externalId": "<string>"
}
],
"number": 123,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"numberOfElements": 123,
"pageable": {
"offset": 123,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"paged": true,
"unpaged": true,
"pageNumber": 123,
"pageSize": 123
},
"last": true,
"empty": true
}
Body
application/json
Parameters used to filter and retrieve payout transfers based on criteria such as order, merchant, status, and creation date.
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 \
--header 'Content-Type: application/json' \
--data '{
"order_id": 123,
"bag_id": 123,
"merchant_id": 123,
"payout_account_id": 123,
"payout_id": 123,
"paypro_transfer_id": 123,
"status": "SENT",
"created_after": "2023-11-07T05:31:56Z",
"created_before": "2023-11-07T05:31:56Z"
}'
{
"totalPages": 123,
"totalElements": 123,
"first": true,
"size": 123,
"content": [
{
"id": 123,
"payment_transaction": 123,
"payout_id": 123,
"payment_provider_id": "<string>",
"payment_provider_payout_id": "<string>",
"payout_account_id": 123,
"bag_amount": 123,
"bag_currency": "<string>",
"amount": 123,
"currency": "<string>",
"status": "SENT",
"payment_provider": "STRIPE",
"related_orders": [
"<string>"
],
"related_bags": [
"<string>"
],
"related_distributions": [
"<string>"
],
"transfer_reversals": [
"<string>"
],
"date_created": "2023-11-07T05:31:56Z",
"date_last_modified": "2023-11-07T05:31:56Z",
"errors": [
{
"id": 123,
"error_code": 123,
"error_message": "<string>",
"resolved": true,
"date_resolved": "2023-11-07T05:31:56Z",
"date_created": "2023-11-07T05:31:56Z",
"payout_transfer_id": 123
}
],
"payoutExternalId": "<string>",
"paymentService": "STRIPE",
"externalId": "<string>"
}
],
"number": 123,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"numberOfElements": 123,
"pageable": {
"offset": 123,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"paged": true,
"unpaged": true,
"pageNumber": 123,
"pageSize": 123
},
"last": true,
"empty": true
}
Assistant
Responses are generated using AI and may contain mistakes.