Chargebacks

The charges object represents charges against transactions raised by a merchant acquirer. This includes details such as the amount, status, and reason for the chargeback.

Chargeback Model

Properties

Name
transaction
Type
object
Description
The transaction model that the chargeback relates to.
Name
received_date
Type
date
Description
The date the chargeback was received by the merchant acquirer.
Name
status
Type
string
Description
The status of the chargeback.
Name
reason
Type
string
Description
The reason why the chargeback was raised.
Name
amount
Type
integer
Description
The amount (in pence) that the chargeback is for.
Name
currency
Type
string
Description
The currency of the chargeback. See the currency documentation for more inforamtion.
Name
due_date
Type
date
Description
The due date for the chargeback.
Name
posting_date
Type
date
Description
The date the chargeback was posted by the customer.
Name
created_at
Type
datetime
Description
The datetime the chargeback was received by our systems.

{
  "transaction": {
    "id": "fb826843-9a37-45d5-9efd-7afd24a8037b",
    "amount": 47900,
    "status": "COMPLETE",
    "method": "MOTO_OTHER",
    "type": "CARD",
    "created_at": "2022-03-25T11:24:10.915Z",
    "completed_at": "2022-03-25T11:24:10.915Z",
    "organisation": {
      "id": "T9304",
      "name": "TTA Travel",
      "image": "organisation/t9304.png"
    }
  },
  "received_date": "2022-07-05",
  "status": "Unknown",
  "reason": "Cardholder Dispute - Defective/Not as described",
  "amount": 47900,
  "currency": "GBX",
  "due_date": null,
  "posting_date": "2022-07-05",
  "created_at": "2022-07-06T11:00:35.919Z"
}

POST/agent/chargebacks

Fetch All

This endpoint retrieves all chargebacks raised via an organisation's merchant acquirers.

Parameters

Name
organisationrequired
Type
string
Description
The organisation ID that you want to fetch chargebacks for. You can find the organisation that you have access to by using the List all organisations method.
Name
skip
Type
integer
Description
Pagination offset. See the pagination section for details.
Name
take
Type
integer
Description
Number of records to return. See the pagination section for details.
Name
show-child-organisations
Type
boolean
Description
Whether to also show chargebacks for any of the requested organisation's child organisations.
Name
type
Type
string
Description
Can be 'csv' or 'json', defaults to 'json'.

Returns

Returns an array of Chargeback Models

Request

POST

/agent/chargebacks

import axios from 'axios';

const response = await axios.post(
  'https://api.felloh.com/agent/chargebacks',
  {
    organisation: 'X9876',
    skip: 10,
    take: 20
  },
  {
    headers: { 'Content-Type': 'application/json', 'Authorization': `Bearer <YOUR TOKEN HERE>` }
  }
);

Response (set using type parameter)

{
  "data": [
    {
      "transaction": {
        "id": "fb826843-9a37-45d5-9efd-7afd24a8037b",
        "amount": 47900,
        "currency": "GBX",
        "status": "COMPLETE",
        "method": "MOTO_OTHER",
        "type": "CARD",
        "created_at": "2022-03-25T11:24:10.915Z",
        "completed_at": "2022-03-25T11:24:10.915Z",
        "organisation": {
          "id": "X9876",
          "name": "Felloh"
        }
      },
      "received_date": "2022-07-05",
      "status": "Unknown",
      "reason": "Cardholder Dispute - Defective/Not as described",
      "amount": 47900,
      "due_date": null,
      "posting_date": "2022-07-05",
      "created_at": "2022-07-06T11:00:35.919Z"
    },
    {
      "transaction": {
        "id": "4d54d5ae-5b78-4d31-8892-55422b27f713",
        "amount": 47900,
        "currency": "GBX",
        "status": "COMPLETE",
        "method": "MOTO_OTHER",
        "type": "CARD",
        "created_at": "2022-03-25T11:24:10.915Z",
        "completed_at": "2022-03-25T11:24:10.915Z",
        "organisation": {
          "id": "X9876",
          "name": "Felloh"
        }
      },
      "received_date": "2022-07-05",
      "status": "Unknown",
      "reason": "Cardholder Dispute - Defective/Not as described",
      "amount": 47900,
      "currency": "GBX",
      "due_date": null,
      "posting_date": "2022-07-05",
      "created_at": "2022-07-06T11:00:35.919Z"
    }
  ],
  "errors": {},
  "meta": {
    "code": 200,
    "reason": "OK",
    "message": "The request was successful",
    "request_id": "cdd40f5c-9d82-44c2-92e3-b5d2cad364f6",
    "count": 2
  }
}