POST
/
payments
/
transfers
/
reversals
curl --request POST \
  --url https://sandbox-api.violet.io/v1/payments/transfers/reversals \
  --header 'Content-Type: application/json' \
  --header 'X-Violet-App-Id: <x-violet-app-id>' \
  --header 'X-Violet-App-Secret: <x-violet-app-secret>' \
  --header 'X-Violet-Token: <x-violet-token>' \
  --data '{
  "transfer_id": 123,
  "order_id": 123,
  "bag_id": 123,
  "merchant_id": 123,
  "payout_account_id": 123,
  "status": "PENDING",
  "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,
      "object": "<string>",
      "transfer": 123,
      "status": "PENDING",
      "amount": 123,
      "currency": "<string>",
      "paypro": "STRIPE",
      "paypro_data": {},
      "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",
          "transfer_reversal_id": 123
        }
      ],
      "date_created": "2023-11-07T05:31:56Z",
      "date_last_modified": "2023-11-07T05:31:56Z"
    }
  ],
  "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
}

Headers

​
X-Violet-Token
string
required
​
X-Violet-App-Secret
string
required
​
X-Violet-App-Id
integer
required

Query Parameters

​
size
integer
default:20
​
page
integer
default:1
​
app_id
integer

Body

application/json

Parameters used to filter and retrieve transfer reversals based on criteria such as transfer ID, merchant, status, and creation date.

Response

default - application/json

default response

The response is of type object.