Skip to main content

Simulate a payout outcome (Sandbox)

POST 
/v1/collections/simulate-payout

Moves the payout of a completed payment one step, the way a checker or the bank would. APPROVED and REJECTED act on a payout in PENDING_APPROVAL. PAID and FAILED act on a payout in INITIATED. A step that does not fit the payout's current status is refused with a 400 that names that status. Repeating an outcome the payout has already reached returns alreadyProcessed: true and queues no webhook. The payment request must have been created with payoutDetails and the payment must be COMPLETE. Available only in sandbox/test environments.

Request​

Responses​

OK

Response Headers
    X-Trace-Id

    Trace ID to provide when contacting Hubpay support