Skip to main content
GET
/
transactions
/
org
/
{org_id}
List org loans / payouts (admin, org-admin)
curl --request GET \
  --url https://api.pcxpay.com/v1/transactions/org/{org_id} \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "transaction_id": "<string>",
      "user_id": "<string>",
      "beneficiary_id": "<string>",
      "amount": 123,
      "currency": "<string>",
      "type": "inbound",
      "status": "initiated",
      "payment_method": "bank_transfer",
      "payment_id": "<string>",
      "payout_id": "<string>",
      "org_id": "<string>",
      "country": "<string>",
      "entity_type": "<string>",
      "target_amount": 123,
      "target_currency": "<string>",
      "metadata": {},
      "beneficiary_details": {},
      "compound_amount": 123,
      "duration": 123,
      "installment_amount": 123,
      "total_installments": 123,
      "installments_completed": 123,
      "amount_paid": 123,
      "outstanding_balance": 123,
      "next_due_date": "2023-11-07T05:31:56Z",
      "start_date": "2023-11-07T05:31:56Z",
      "frequency": "weekly",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextToken": "<string>",
    "pageSize": 123
  },
  "metrics": {}
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org_id
string
required

Query Parameters

type
enum<string>

Filter to a specific transaction type.

Available options:
loan,
payout
currency
string
limit
integer
default:10
nextToken
string
includeMetrics
boolean
default:false
query
string

Free-text search query.

Response

Loan/payout transactions

data
object[]
pagination
object
metrics
object

Present only when includeMetrics=true.