Refuns

The Refund object

Attributes

idstring · uuidOptional

payment_idstring · uuidOptional

booking_idstring · uuidOptional

payment_gateway_idintegerOptional

currencystring · iso-4217Optional

3 letter currency code as defined by ISO-4217

Example: EUR

amountnumber · floatOptionalExample: 100

surchargenumber · floatOptionalExample: 0

statusstring · enumOptionalPossible values:

status_messagestringOptional

transaction_referencestringOptional

ip_addressstringOptional

foreign_currencystring · iso-4217Optional

3 letter currency code as defined by ISO-4217

Example: EUR

foreign_amountnumber · floatOptionalExample: 100

commentstringOptional

metadataobject · jsonOptional

gift_certificate_idstring · uuidOptional

user_idstring · uuidOptional

refund_atstring · date-timeOptional

deleted_atstring · date-time · nullableOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

The Refund object

{
  "surcharge": 0,
  "status_message": "status_message",
  "amount": 100,
  "metadata": "{}",
  "created_at": "2000-01-23T04:56:07.000+00:00",
  "ip_address": "ip_address",
  "foreign_currency": "EUR",
  "deleted_at": "2000-01-23T04:56:07.000+00:00",
  "booking_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "foreign_amount": 100,
  "updated_at": "2000-01-23T04:56:07.000+00:00",
  "user_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "refund_at": "2000-01-23T04:56:07.000+00:00",
  "payment_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "currency": "EUR",
  "comment": "comment",
  "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "transaction_reference": "transaction_reference",
  "gift_certificate_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "payment_gateway_id": 0,
  "status": "ok"
}

List refunds

get

List all refunds

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

payment_idstring · uuid[]Optional

ID(s) of the payment to filter refunds by

payment_gateway_idintegerOptional

Filter refunds by payment gateway

user_idstring · uuid[]Optional

ID(s) of the user to filter refunds by

currencystring · iso-4217[]Optional

Filter refunds by currency

Example: ["EUR","USD"]

amountstringOptional

Filter refunds by amount

Example: 100,200Pattern: ^\d+,\d+$

statusstring · enumOptional

Filter refunds by status

Possible values:

refund_atstringOptional

Filter refunds by refund date

Example: 2021-01-01,2021-12-31Pattern: ^\d{4}-\d{2}-\d{2},\d{4}-\d{2}-\d{2}$

payment_paid_atstringOptional

Filter refunds by payment paid date

Example: 2021-01-01,2021-12-31Pattern: ^\d{4}-\d{2}-\d{2},\d{4}-\d{2}-\d{2}$

booking_location_idinteger[]Optional

Filter refunds by booking location ID(s)

booking_check_instringOptional

Filter refunds by booking check-in date

Example: 2021-01-01,2021-12-31Pattern: ^\d{4}-\d{2}-\d{2},\d{4}-\d{2}-\d{2}$

booking_check_outstringOptional

Filter refunds by booking check-out date

Example: 2021-01-01,2021-12-31Pattern: ^\d{4}-\d{2}-\d{2},\d{4}-\d{2}-\d{2}$

limitinteger · int32 · min: 1 · max: 100Optional

Number of refunds to return

Default: 10

pageinteger · int32 · min: 1Optional

Page number

Responses

200

A list of refunds

application/json

get

/refunds

HTTPcURLJavaScriptPython

GET /private/refunds HTTP/1.1
Host: api.bookinglayer.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

A list of refunds

[
  {
    "surcharge": 0,
    "status_message": "status_message",
    "amount": 100,
    "metadata": "{}",
    "created_at": "2000-01-23T04:56:07.000+00:00",
    "ip_address": "ip_address",
    "foreign_currency": "EUR",
    "deleted_at": "2000-01-23T04:56:07.000+00:00",
    "booking_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "foreign_amount": 100,
    "updated_at": "2000-01-23T04:56:07.000+00:00",
    "user_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "refund_at": "2000-01-23T04:56:07.000+00:00",
    "payment_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "currency": "EUR",
    "comment": "comment",
    "id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "transaction_reference": "transaction_reference",
    "gift_certificate_id": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "payment_gateway_id": 0,
    "status": "ok"
  }
]