Advance a sandbox ACH sale to a chosen settlement outcome.

POST /api/transactions/{id}/sandbox/ach-status deprecated

Requires: Transactions.Settlement.Trigger, merchant scope.

Moves the transaction to the requested outcome and publishes the same `Transaction.AchStatusChanged` and `Transaction.Returned` events a real ACH lifecycle produces, so an ACH webhook can be proven in one session instead of over several days. Sandbox only: a key stamped for the live world is refused, so is a caller carrying no environment stamp, and so is any transaction the simulator did not answer. Advancing the same transaction to the same outcome twice delivers nothing the second time, because repeat deliveries of one event id are dropped per destination.

Try this in the console

Example request

Every block below sends the same request. Replace {{BASE_URL}} with the address of the API you are calling and {{API_KEY}} with your own key.

The request body is a SandboxAchStatusAdvanceRequestDto. See the Request body section below for its fields.

cURL PowerShell TypeScript C# Python

cURL

curl -X POST "{{BASE_URL}}/api/transactions/{id}/sandbox/ach-status" \
  -H "api-key: {{API_KEY}}" \
  -H "Content-Type: application/json" \
  -d '{
  "targetStatus": {}
}'

PowerShell

$headers = @{
    'api-key' = '{{API_KEY}}'
}

$body = @'
{
  "targetStatus": {}
}
'@

$response = Invoke-RestMethod -Method POST -Uri '{{BASE_URL}}/api/transactions/{id}/sandbox/ach-status' `
    -Headers $headers -ContentType 'application/json' -Body $body

npm install @winkpg/winkpg-api

TypeScript (SDK)

import { Configuration, SandboxAchStatusApi } from '@winkpg/winkpg-api';

const api = new SandboxAchStatusApi(new Configuration({
  basePath: '{{BASE_URL}}',
  apiKey: '{{API_KEY}}',
}));

const { data } = await api.sandboxAchStatusAdvanceAchStatus("3fa85f64-5717-4562-b3fc-2c963f66afa6", {
  "targetStatus": {}
});

TypeScript (raw HTTP)

const response = await fetch('{{BASE_URL}}/api/transactions/{id}/sandbox/ach-status', {
  method: 'POST',
  headers: {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "targetStatus": {}
  }),
});

const data = await response.json();

dotnet add package WinkPg.Api.Client

C# (SDK)

using WinkPg.Api.Client.Api;
using WinkPg.Api.Client.Client;
using System.Text.Json;

var config = new Configuration { BasePath = "{{BASE_URL}}" };
config.AddApiKey("api-key", "{{API_KEY}}");

var api = new SandboxAchStatusApi(config);
var body = JsonSerializer.Deserialize<SandboxAchStatusAdvanceRequestDto>("""
    {
      "targetStatus": {}
    }
    """);

var result = await api.SandboxAchStatusAdvanceAchStatusAsync(Guid.Parse("3fa85f64-5717-4562-b3fc-2c963f66afa6"), body);

C# (raw HTTP)

using System.Text;

using var http = new HttpClient { BaseAddress = new Uri("{{BASE_URL}}") };

var request = new HttpRequestMessage(new HttpMethod("POST"), "/api/transactions/{id}/sandbox/ach-status");
request.Headers.Add("api-key", "{{API_KEY}}");

request.Content = new StringContent("""
    {
      "targetStatus": {}
    }
    """, Encoding.UTF8, "application/json");

var response = await http.SendAsync(request);
response.EnsureSuccessStatusCode();
var json = await response.Content.ReadAsStringAsync();

pip install winkpg-api

Python (SDK)

import winkpg_api

configuration = winkpg_api.Configuration(host="{{BASE_URL}}")
configuration.api_key["ApiKey"] = "{{API_KEY}}"

with winkpg_api.ApiClient(configuration) as client:
    api = winkpg_api.SandboxAchStatusApi(client)
    body = winkpg_api.SandboxAchStatusAdvanceRequestDto.from_dict({
      "targetStatus": {}
    })
    result = api.sandbox_ach_status_advance_ach_status("3fa85f64-5717-4562-b3fc-2c963f66afa6", body)

pip install requests

Python (raw HTTP)

import requests

headers = {
    "api-key": "{{API_KEY}}",
    "Content-Type": "application/json",
}

body = {
  "targetStatus": {}
}

response = requests.request(
    "POST",
    "{{BASE_URL}}/api/transactions/{id}/sandbox/ach-status",
    headers=headers,
    json=body,
)
response.raise_for_status()
data = response.json()

Parameters

Name	In	Type	Description
`id` required	path	string (uuid)	The loopback ACH sale to advance. Must belong to the calling key's merchant.
`suppressNulls` required	query	boolean	If true, omit properties with null values.

Request body

application/json , required

Field	Type	Description
`targetStatus` required	all of SandboxAchTargetStatus	The settlement status to drive the transaction to: a terminal outcome, or one of the intermediate statuses a debit passes through on the way to one. Required. nullable
`nachaReturnCode` required	string	The NACHA return code to record, for example `R01`. Required when `targetStatus` is `SettlementRolledBack`, and rejected otherwise: a code on a settlement would be persisted and then published as part of an event that says the debit cleared. nullable
`nachaReturnReason` required	string	The return reason to record, for example `Insufficient funds`. Required alongside `nachaReturnCode`, and rejected on any other outcome for the same reason. nullablemax length 120

This request body has no documented fields.