Search Transfer Reversals
Query parameters
sizeinteger · int32OptionalDefault:
20
pageinteger · int32OptionalDefault:
1
app_idinteger · int32Optional
Header parameters
X-Violet-TokenstringRequired
X-Violet-App-SecretstringRequired
X-Violet-App-Idinteger · int32Required
Body
Parameters used to filter and retrieve transfer reversals based on criteria such as transfer ID, merchant, status, and creation date.
transfer_idinteger · int64Optional
Filter reversals related to a specific transfer.
order_idinteger · int64Optional
Filter reversals for transfers associated with a specific order.
bag_idinteger · int64Optional
Filter reversals for transfers associated with a specific bag.
merchant_idinteger · int32Optional
Filter reversals for transfers related to a specific merchant.
payout_account_idinteger · int32Optional
Filter reversals for transfers directed to a specific payout account.
statusstring · enumOptionalPossible values:
Filter reversals based on the current transfer status.
created_afterstring · date-timeOptional
Return reversals for transfers created on or after this timestamp (inclusive).
created_beforestring · date-timeOptional
Return reversals for transfers created before this timestamp (exclusive).
Responses
default
default response
application/json
post
POST /v1/payments/transfers/reversals 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: 185
{
"transfer_id": 1,
"order_id": 1,
"bag_id": 1,
"merchant_id": 1,
"payout_account_id": 1,
"status": "PENDING",
"created_after": "2025-07-10T00:35:26.511Z",
"created_before": "2025-07-10T00:35:26.511Z"
}
default
default response
{
"totalPages": 1,
"totalElements": 1,
"first": true,
"size": 1,
"content": [
{
"id": 1,
"object": "text",
"transfer": 1,
"status": "PENDING",
"amount": 1,
"currency": "text",
"paypro": "STRIPE",
"paypro_data": {
"ANY_ADDITIONAL_PROPERTY": {}
},
"errors": [
{
"id": 1,
"error_code": 1,
"error_message": "text",
"resolved": true,
"date_resolved": "2025-07-10T00:35:26.511Z",
"date_created": "2025-07-10T00:35:26.511Z",
"transfer_reversal_id": 1
}
],
"date_created": "2025-07-10T00:35:26.511Z",
"date_last_modified": "2025-07-10T00:35:26.511Z"
}
],
"number": 1,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"numberOfElements": 1,
"pageable": {
"offset": 1,
"sort": {
"empty": true,
"sorted": true,
"unsorted": true
},
"paged": true,
"unpaged": true,
"pageNumber": 1,
"pageSize": 1
},
"last": true,
"empty": true
}
Last updated
Was this helpful?