Listing bank withdrawals

GET /api/public/v1/transactions/bank_withdrawals

This endpoint returns a list of all bank withdrawal transactions.

Headers

Name	Value
Content-Type	application/vnd.api+json
Authorization	Bearer <api_key>

URL Parameters

Name	Description
order	Order in which the list of transactions should be returned. Can be created_at.
order_type	Order type. Can be either asc or desc.
page	Page for which you want to return transactions.
per_page	Number of transactions per page to return.

Response

HTTP 200

{
  "data": [
    {
      "id": "8ba506eb-0a5e-4518-9f64-9fcb399691aa",
      "type": "transactions",
      "attributes": {
        "createdAt": "2024-12-11T16:23:37.732Z",
        "simplifiedState": "completed",
        "transactionType": "BankWithdrawalTransaction",
        "amount": "-1.01",
        "reference": null
      },
      "relationships": {
        "account": {
          "meta": {
            "included": false
          }
        },
        "transactionDetails": {
          "data": {
            "type": "bank_withdrawal_transactions",
            "id": "8ba506eb-0a5e-4518-9f64-9fcb399691aa"
          }
        }
      }
    }
  ],
  "included": [
    {
      "id": "8ba506eb-0a5e-4518-9f64-9fcb399691aa",
      "type": "bank_withdrawal_transactions",
      "attributes": {
        "absorbFees": true,
        "createdAt": "2024-12-11T16:23:37.690Z",
        "updatedAt": "2024-12-11T16:23:37.690Z",
        "state": "completed",
        "iban": "LT563400023810000822",
        "beneficiaryName": "Acme",
        "reference": "Fiat payout from Txn to Acme",
        "paymentStatus": "created",
        "bankBic": "GUPULT22XXX",
        "bankName": "GURU PAY",
        "currency": "EUR",
        "amount": "1.01",
        "payAmount": "1.00",
        "fee": "0.01"
      },
      "relationships": {
        "bankAccount": {
          "data": {
            "type": "bank_accounts",
            "id": "a754cd82-74a0-4c1c-a832-e83445bce2c5"
          }
        },
        "account": {
          "data": {
            "type": "accounts",
            "id": "acd50522-de49-4aaa-a183-dc046ff27fd5"
          }
        }
      }
    },
    {
      "id": "a754cd82-74a0-4c1c-a832-e83445bce2c5",
      "type": "bank_accounts",
      "attributes": {
        "beneficiaryName": "Acme",
        "currencyCode": "EUR",
        "iban": "LT563400023810000822",
        "createdAt": "2024-12-07T11:42:27.571Z",
        "updatedAt": "2024-12-07T11:42:27.571Z",
        "bankBic": "GUPULT22XXX",
        "bankName": "GURU PAY"
      }
    },
    {
      "id": "acd50522-de49-4aaa-a183-dc046ff27fd5",
      "type": "accounts",
      "attributes": {
        "currencyCode": "EUR",
        "balance": "25609.70",
        "currencyType": "fiat"
      },
      "relationships": {
        "company": {
          "meta": {
            "included": false
          }
        },
        "networks": {
          "meta": {
            "included": false
          }
        }
      }
    }
  ],
  "meta": {
    "page": "1",
    "per_page": "1",
    "total": 34
  },
  "jsonapi": {
    "version": "1.0"
  }
}