# Get Payouts

Get payouts with filter and pagination support.

Example Request:

GET /v2/payouts?page=0&size=10&payoutStatus=ACCP&senderCountry=US&beneficiaryCountry=PH


Query Parameters:
- page - Page number (default: 0)
- size - Number of records per page (default: 10)
- sortField - Field to sort by
- sortDirection - Sort direction (ASC/DESC)
- sourceMemberPayoutId - Filter by source member payout ID (your unique payout identifier)
- payoutId - Filter by system payout ID (UUID format)
- creationTime - Filter by creation date (YYYY-MM-DD)
- completionTime - Filter by completion date (YYYY-MM-DD)
- senderName - Filter by sender name
- senderCountry - Filter by sender country code
- beneficiaryName - Filter by beneficiary name
- beneficiaryCountry - Filter by beneficiary country code
- payoutProviderId - Filter by payout provider id
- payoutStatus - Filter by payout status (ACCP, PNDG, PRCD, etc.)

Endpoint: GET /v2/payouts
Version: 1.1.0

## Query parameters:

  - `page` (integer)
    page number

  - `size` (integer)
    page size. default is 10

  - `sortField` (string)
    Payout sort field
    Enum: "sourceMemberPayoutId", "payoutId", "creationTime", "completionTime", "senderName", "senderCountry", "beneficiaryName", "beneficiaryCountry", "payoutProviderId", "payoutStatus"

  - `sortDirection` (string)
    sort direction
    Enum: "asc", "desc"

  - `sourceMemberPayoutId` (string)
    Filter by source member payout ID (your unique payout identifier)

  - `payoutId` (string)
    Filter by system payout ID (UUID format)

  - `creationTime` (string)

  - `completionTime` (string)

  - `senderName` (string)

  - `senderCountry` (string)

  - `beneficiaryName` (string)

  - `beneficiaryCountry` (integer)

  - `payoutProviderId` (string)

  - `payoutStatus` (string)

## Response 200 fields (application/json):

  - `payouts` (array)

  - `payouts.payoutId` (string)
    Resource identification of the related payout initiation in UUID v04 format.

  - `payouts.sourceMemberPayoutId` (string)

  - `payouts.payoutStatus` (string)
    RCVD: Received,

 ACCP: Accepted, 

 PNDG: Pending,

 PRCD: Processed,

 RJCT: Rejected,

 CNCL: Cancelled,

 EXPD: Expired,

 FAIL: Failed,

 RVSD: Reversed
    Enum: "RCVD", "ACCP", "PNDG", "PRCD", "RJCT", "CNCL", "EXPD", "FAIL", "RVSD"

  - `payouts.cashoutStatus` (string)

  - `payouts.rejectReason` (string)

  - `payouts.destinationCcy` (string)

  - `payouts.payoutAmt` (number)

  - `payouts.transferFee` (number)

  - `payouts.expiryTime` (string)

  - `payouts.payoutProviderId` (string)

  - `payouts.segment` (string)
    C2C: From an individual to an individual,

 B2B: From a business to a business
    Enum: "C2C", "B2B"

  - `payouts.payoutMethod` (string)
    BANK_ACCOUNT: Bank Account service,

 CASH_PICKUP: Cash pickup service,

 WALLET: Wallet service
    Enum: "BANK_ACCOUNT", "CASH_PICKUP", "WALLET"

  - `payouts.sender` (object)

  - `payouts.sender.firstName` (string, required)

  - `payouts.sender.middleName` (string)

  - `payouts.sender.lastName` (string, required)

  - `payouts.sender.lastName2` (string)

  - `payouts.sender.gender` (string)
    Enum: "M", "F"

  - `payouts.sender.dateOfBirth` (string)

  - `payouts.sender.countryOfBirth` (string)

  - `payouts.sender.idNumber` (string)

  - `payouts.sender.idType` (string)

  - `payouts.sender.passportNumber` (string)

  - `payouts.sender.accountNumber` (string)

  - `payouts.sender.nationality` (string)

  - `payouts.sender.occupation` (string)

  - `payouts.sender.phone` (string)

  - `payouts.sender.email` (string)
    Example: "abc@example.com"

  - `payouts.sender.address` (object)

  - `payouts.sender.address.address2` (string)

  - `payouts.sender.address.externalNumber` (string)

  - `payouts.sender.address.internalNumber` (string)

  - `payouts.sender.address.city` (string)

  - `payouts.sender.address.suburb` (string)

  - `payouts.sender.address.county` (string)

  - `payouts.sender.address.state` (string)

  - `payouts.sender.address.postalCode` (string)

  - `payouts.sender.address.street` (string)

  - `payouts.sender.address.country` (string)

  - `payouts.sender.countryCode` (string)

  - `payouts.sender.companyName` (string)

  - `payouts.sender.companyTradingName` (string)

  - `payouts.sender.companyRegistrationNumber` (string)

  - `payouts.sender.companyRegistrationCountry` (string)

  - `payouts.beneficiary` (object)

  - `payouts.beneficiary.stateOfBirth` (string)

  - `payouts.beneficiary.mailAddress` (string)

  - `payouts.beneficiary.accountName` (string)

  - `payouts.beneficiary.accountType` (string)

  - `payouts.beneficiary.transferNumber` (string)

  - `payouts.beneficiary.idIssueState` (string)

  - `payouts.beneficiary.idIssueCountry` (string)

  - `payouts.beneficiary.pixType` (string)

  - `payouts.beneficiary.pixKey` (string)

  - `payouts.beneficiary.taxId` (string)

  - `payouts.beneficiary.idExpiryDate` (string)

  - `payouts.beneficiary.idIssueDate` (string)

  - `payouts.beneficiary.type` (string)

  - `payouts.beneficiary.residencyType` (string)

  - `payouts.beneficiary.branchNumber` (string)

  - `payouts.complianceInfo` (object)

  - `payouts.complianceInfo.sourceOfFunds` (string)
    Enum: "DONATIONS", "LOTTERY", "SALARY", "FREELANCE_INCOME", "RETIREMENT_FUND", "PROPERTY_SALE", "FOREX_GAINS", "PENSION", "FAMILY_INCOME", "FINANCIAL_SUPPORT_FROM_SPOUSE", "LOANS", "BUSINESS_INCOME", "COMMISSION", "PROPERTY_INVESTMENT", "SHARES_INVESTMENT", "SAVINGS", "BALANCE_FROM_TRAVELLING"

  - `payouts.complianceInfo.purpose` (string)
    Enum: "CONSTRUCTION", "SERVICES_PAYMENT", "EDUCATION", "MEDICAL", "FAMILY_MAINTENANCE", "PROPERTY_PURCHASE", "UTILITIES", "PERSONAL_EXPENSES", "INVESTMENT_GAINS", "SAVINGS", "SALARY", "LEGAL_SERVICES", "GRANTS", "GIFTS", "DONATIONS", "WEDDING", "RELIGIOUS_EXPENSES", "FREELANCE_PAYMENT"

  - `payouts.complianceInfo.other` (string)

  - `payouts.complianceInfo.relationship` (string)
    Enum: "FAMILY", "BUSINESS_PARTNER", "FRIEND", "FRIENDS_FAMILY", "EMPLOYEE", "SELF", "SIBLING", "PARENT", "SPOUSE", "CHILDREN", "SUPPLIER", "NOT_RELATED", "RELATIVE", "IN_LAWS", "SERVICE_PROVIDER", "SPOUSE_EMPLOYEE", "SPOUSE_EMPLOYEE_FAMILY", "CHARITY_RECIPIENT"

  - `payouts.creationTime` (string)

  - `payouts.initiateTime` (string)

  - `payouts.completionTime` (string)

  - `payouts.rejectionTime` (string)

  - `payouts.cancellationTime` (string)

  - `page` (integer)

  - `size` (integer)

  - `totalPages` (integer)

  - `totalRecords` (integer)

## Response 400 fields (application/json):

  - `code` (string)

  - `message` (string)

  - `detail` (string)