Skip to main content
GET
/
v1
/
refunds
List all refunds
curl --request GET \
  --url https://api.yorlet.com/v1/refunds \
  --header 'Authorization: <api-key>'
{
  "count": 1,
  "has_more": false,
  "object": "list",
  "data": [
    {
      "id": "<string>",
      "created": 123,
      "object": "refund",
      "amount": 123,
      "balance_transaction": {
        "id": "<string>",
        "created": 123,
        "object": "balance_transaction",
        "amount": 123,
        "available_on": 123,
        "currency": "<string>",
        "description": "<string>",
        "fee": 123,
        "fee_details": [
          {
            "amount": 123,
            "description": "<string>",
            "tax": 123,
            "tax_percent": 123,
            "type": "<string>"
          }
        ],
        "net": 123,
        "payout": "<string>",
        "source": "<string>",
        "source_object": "<string>",
        "type": "adjustment",
        "account": "<string>",
        "deleted": false
      },
      "currency": "<string>",
      "customer": {
        "id": "<string>",
        "created": 123,
        "object": "customer",
        "address": {
          "line1": "<string>",
          "line2": "<string>",
          "city": "<string>",
          "country": "<string>",
          "postal_code": "<string>",
          "state": "<string>"
        },
        "default_payment_method": "<string>",
        "delinquent": true,
        "description": "<string>",
        "email": "[email protected]",
        "invoice_prefix": "<string>",
        "invoicing": {
          "arrears_emails": true,
          "email_cc": [
            "[email protected]"
          ],
          "email_to": "[email protected]"
        },
        "legal": {
          "dob": {
            "day": 16,
            "month": 6.5,
            "year": 5949.5
          },
          "first_name": "<string>",
          "last_name": "<string>"
        },
        "name": "<string>",
        "phone": "<string>",
        "radar": {
          "message": "<string>",
          "reason": "<string>",
          "risk_level": "<string>"
        },
        "account": "<string>",
        "deleted": false,
        "metadata": {}
      },
      "description": "<string>",
      "reason": "<string>",
      "reason_description": "<string>",
      "reverse_transfer": true,
      "status": "<string>",
      "transaction": "<string>",
      "account": "<string>",
      "deleted": false,
      "metadata": {}
    }
  ]
}

Authorizations

Authorization
string
header
required

API Key authentication. Use "Bearer YOUR_API_KEY".

Response

200 - application/json

A dictionary with a data property that contains an array of up to limit refunds. Each entry in the array is a separate refund object. If no more refunds are available, the resulting array will be empty.

count
number
required

Total number of items in the list.

Example:

1

has_more
boolean
required

Whether more items are available.

Example:

false

object
enum<string>
required
Available options:
list
data
object[]
required