POST
/
refunds
/
list
curl --request POST \
  --url https://api.staging.bnplx.io/refunds/list \
  --header 'Content-Type: application/json' \
  --header 'api-key: <api-key>' \
  --data '{
  "start_time": "2023-11-07T05:31:56Z",
  "end_time": "2023-11-07T05:31:56Z",
  "payment_id": "<string>",
  "refund_id": "<string>",
  "profile_id": "<string>",
  "limit": 123,
  "offset": 123,
  "amount_filter": {
    "start_amount": 123,
    "end_amount": 123
  },
  "connector": [
    "<string>"
  ],
  "merchant_connector_id": [
    "<string>"
  ],
  "currency": [
    "AED"
  ],
  "refund_status": [
    "succeeded"
  ]
}'
{
  "count": 1,
  "total_count": 123,
  "data": [
    {
      "refund_id": "<string>",
      "payment_id": "<string>",
      "amount": 6540,
      "currency": "<string>",
      "status": "succeeded",
      "reason": "<string>",
      "metadata": {},
      "error_message": "<string>",
      "error_code": "<string>",
      "unified_code": "<string>",
      "unified_message": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "connector": "stripe",
      "profile_id": "<string>",
      "merchant_connector_id": "<string>",
      "split_refunds": {
        "stripe_split_refund": {
          "revert_platform_fee": true,
          "revert_transfer": true
        }
      }
    }
  ]
}

Authorizations

​
api-key
string
header
required

Use the API key created under your merchant account from the GreenBanana dashboard. API key is used to authenticate API requests from your merchant server only. Don't expose this key on a website or embed it in a mobile application.

Body

application/json

A type representing a range of time for filtering, including a mandatory start time and an optional end time.

Response

200 - application/json
List of refunds

The response is of type object.