Skip to main content
GET
/
api
/
v1
/
business
/
payouts
List payouts for the active business
curl --request GET \
  --url http://localhost:3001/api/v1/business/payouts \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": {
    "items": [
      {
        "id": "<string>",
        "partnerId": "<string>",
        "partnerEndUserId": "<string>",
        "amount": "100.00",
        "currency": "USDC",
        "destinationType": "<string>",
        "destinationDetails": {},
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "partnerWalletId": {},
        "failureReason": {}
      }
    ],
    "total": 123,
    "skip": 123,
    "take": 123
  }
}

Authorizations

Authorization
string
header
required

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

Headers

X-Axra-Business-Id
string

Active business context

Query Parameters

status
enum<string>
Available options:
CREATED,
SUBMITTED,
PENDING_REVIEW,
SETTLED,
FAILED,
CANCELLED
rail
enum<string>
Available options:
CRYPTO,
ACH,
WIRE,
SEPA,
SWIFT,
LOCAL_BANK,
LOCAL_MOMO
skip
number
default:0
take
number
default:20
Required range: x <= 100

Response

OK

success
boolean
required
Example:

true

data
object
required