v1

latestOpenAPI 3.0.02026-07-14866188.2 KB

Payouts

Debit wallet to process unpaid transaction.

post/v0.2.4/payouts/process

Request body

subAccountstring

Subaccount (Wallet Account) to payout from, if any.

issueIDstring required

issueID of the transaction to process.

collectionPaymentIssueIDstring

issue ID for the payment payout initiated.

Response

Success.

statusstring

Status of the request.

messagestring

Message describing the outcome.

Example response

{
  "status": "success",
  "message": "Payout completed successfully",
  "data": {
    "paymentLink": "http://localhost:4000/pay/?issueID=eaabe2eb-e774-4f81-8ba9-ede2ea2d0058_5_1726576015710",
    "data": [
      {
        "id": "nR3gq5GXbq83tU3IpTPq",
        "valueInUSD": 5,
        "chimoney": 5000,
        "issueID": "eaabe2eb-e774-4f81-8ba9-ede2ea2d0058_5_1726576015710",
        "type": "api-payment",
        "subAccount": "eaabe2eb-e774-4f81-8ba9-ede2ea2d0058",
        "issuer": "eaabe2eb-e774-4f81-8ba9-ede2ea2d0058",
        "t_id": 600542,
        "chiRef": "2c3875a1-f674-43d4-b37a-a9554ab79afd",
        "meta": {},
        "integration": {
          "appID": "TyGlLVepVqfOj3635qrC"
        },
        "issueDate": "2024-09-17T12:26:57.129Z",
        "payerEmail": "favour@chimoney.io",
        "redirect_url": "https://test.com",
        "redeemData": {
          "walletID": "6ShqiB470pYLLgFE1Duc"
        },
        "initiatedBy": "1d812de4-b5e3-474b-9572-19667eb985f3",
        "redeemLink": "http://localhost:4000/redeem/?chi=2c3875a1-f674-43d4-b37a-a9554ab79afd"
      }
    ],
    "error": "None"
  }
}