LogoLogo
  • Overview
  • Authentication
  • Error Codes
  • Payout API
    • Receiver
      • Create New Receiver
      • KYC Verification for Payout
      • Add Receiver Account
        • International
          • Virtual Card
        • Australia (AUD)
          • Direct Entry
        • Canada (CAD)
          • EFT
          • Digital Payment
        • Europe (EUR)
          • SEPA
        • New Zealand (NZD)
          • Direct Credit
        • United States of America (USD)
          • ACH
      • Get Receiver
      • Get Receiver Bank Account
      • Webhooks
    • Payout
      • Create a Payout Transaction
      • Get Payout
      • Webhooks
      • Sandbox Test Helper
    • Balance
      • Get Account Balance
    • Account
      • Get Current Account
      • Webhooks
    • Batch
      • Webhooks
Powered by GitBook
LogoLogo

© 2025 Ipay Technologies Pty Ltd

On this page
Export as PDF
  1. Payout API
  2. Payout

Sandbox Test Helper

Utils API for Sandbox testing

Sandbox Update a Payout status

POST /api/test-helpers/status

Headers

Name
Value

x-api-key

<token>

signature

<token>

Body

Name
Type
Description

id*

string

Payout ID or Batch ID to update status.

type*

string

Type to update.

payout to make update a payout

or batch to make update all payout in batch.

status*

string

Status of payout to update. success or fail

* is mandatory parameter

Example body request

{
    "id": "c111f9ee-5a42-496c-94ad-9645ebd2004b", // payout_id or batch_id
    "type": "payout", // payout or batch
    "status": "success" // success or fail
}

Response

{
    "statusCode": 200,
    "message": "Test helper: Update payout status is successful"
}
PreviousWebhooksNextBalance

Last updated 1 month ago