# Initiate Payout

Creates a new payout with the provided request details.  

- On success, the response includes:  
  * payoutId – Unique identifier for the initiated payout. This ID must be used for subsequent operations (e.g., status checks, cancellation).  
  * payoutStatus – Will return "ACCP" if the payout request is received successfully.  

This endpoint is the entry point for executing a payment or transfer, and serves as the foundation for all subsequent payout lifecycle operations.

Endpoint: POST /v2/payouts
Version: 1.1.0

## Request fields (application/json):

  - `sender` (object, required)

  - `sender.firstName` (string, required)

  - `sender.middleName` (string)

  - `sender.lastName` (string, required)

  - `sender.lastName2` (string)

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

  - `sender.dateOfBirth` (string)

  - `sender.countryOfBirth` (string)

  - `sender.idNumber` (string)

  - `sender.idType` (string)

  - `sender.passportNumber` (string)

  - `sender.accountNumber` (string)

  - `sender.nationality` (string)

  - `sender.occupation` (string)

  - `sender.phone` (string)

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

  - `sender.address` (object)

  - `sender.address.address2` (string)

  - `sender.address.externalNumber` (string)

  - `sender.address.internalNumber` (string)

  - `sender.address.city` (string)

  - `sender.address.suburb` (string)

  - `sender.address.county` (string)

  - `sender.address.state` (string)

  - `sender.address.postalCode` (string)

  - `sender.address.street` (string)

  - `sender.address.country` (string)

  - `sender.countryCode` (string)

  - `sender.companyName` (string)

  - `sender.companyTradingName` (string)

  - `sender.companyRegistrationNumber` (string)

  - `sender.companyRegistrationCountry` (string)

  - `beneficiary` (object, required)

  - `beneficiary.stateOfBirth` (string)

  - `beneficiary.mailAddress` (string)

  - `beneficiary.accountName` (string)

  - `beneficiary.accountType` (string)

  - `beneficiary.transferNumber` (string)

  - `beneficiary.idIssueState` (string)

  - `beneficiary.idIssueCountry` (string)

  - `beneficiary.pixType` (string)

  - `beneficiary.pixKey` (string)

  - `beneficiary.taxId` (string)

  - `beneficiary.idExpiryDate` (string)

  - `beneficiary.idIssueDate` (string)

  - `beneficiary.type` (string)

  - `beneficiary.residencyType` (string)

  - `beneficiary.branchNumber` (string)

  - `complianceInfo` (object)

  - `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"

  - `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"

  - `complianceInfo.other` (string)

  - `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"

  - `sourceMemberPayoutId` (string, required)

  - `destinationCcy` (string, required)

  - `payoutAmt` (number, required)

  - `payoutProviderId` (string, required)

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

 CASH_PICKUP: Cash pickup service,

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

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

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

## Response 201 fields (application/json):

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

  - `sourceMemberPayoutId` (string)

  - `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"

  - `destinationCcy` (string)

  - `payoutAmt` (number)

  - `transferFee` (number)

  - `expiryTime` (string)

  - `beneficiaryName` (string)

  - `links` (object)

  - `links.process` (string)
    The link to process the payout created in initiation request.
    Example: "/v2/payouts/cc04ef71-085e-468e-87bd-2881d8a03a5d/process"

  - `links.status` (string)
    The link to retrieve the status of the payout.
    Example: "/v2/payouts/cc04ef71-085e-468e-87bd-2881d8a03a5d/status"

  - `links.details` (string)
    'The link to the payout initiation resource details created by this request.
    Example: "/v2/payouts/cc04ef71-085e-468e-87bd-2881d8a03a5d"

## Response 400 fields (application/json):

  - `code` (string)

  - `message` (string)

  - `detail` (string)

## Response 404 fields (application/json):

  - `code` (string)

  - `message` (string)

  - `detail` (string)