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

Advance a sandbox ACH sale to a chosen settlement outcome.

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.

**Operation ID:** `sandboxAchStatusAdvanceAchStatus`

## Authorization

Requires: Transactions.Settlement.Trigger, merchant scope.

Required permissions:
- `Transactions.Settlement.Trigger`

## Parameters

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

## Request Body

The outcome to drive to, plus the return code and reason when it is a return.

**Content type:** `application/json`

Schema: `SandboxAchStatusAdvanceRequestDto`

Properties:
- `targetStatus` (object) required: 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.
- `nachaReturnCode` (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.
- `nachaReturnReason` (string): The return reason to record, for example `Insufficient funds`. Required alongside  `nachaReturnCode`, and rejected on any other outcome for the same reason.

**Content type:** `text/json`

Schema: `SandboxAchStatusAdvanceRequestDto`

Properties:
- `targetStatus` (object) required: 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.
- `nachaReturnCode` (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.
- `nachaReturnReason` (string): The return reason to record, for example `Insufficient funds`. Required alongside  `nachaReturnCode`, and rejected on any other outcome for the same reason.

**Content type:** `application/*+json`

Schema: `SandboxAchStatusAdvanceRequestDto`

Properties:
- `targetStatus` (object) required: 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.
- `nachaReturnCode` (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.
- `nachaReturnReason` (string): The return reason to record, for example `Insufficient funds`. Required alongside  `nachaReturnCode`, and rejected on any other outcome for the same reason.

## Responses

### 200

OK

**Content type:** `application/json`

Schema: `SandboxAchStatusAdvanceResultDto`

Properties:
- `transactionId` (string(uuid)): The transaction that was advanced.
- `previousStatus` (string): The settlement status the transaction held before the advance, by its literal name.
- `newStatus` (string): The settlement status the transaction now holds, by its literal name.
- `isLateReturn` (boolean): Whether this return arrived after the debit had already settled. Always `false`  for an outcome that is not a return. Derived from the status the transaction actually held, not  from anything the request said.
- `achStatusChangedPublished` (boolean): Whether the `Transaction.AchStatusChanged` event was published.
- `returnedPublished` (boolean): Whether the `Transaction.Returned` event was published. Only a return publishes it.

### 403

Forbidden

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 401

Unauthorized

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 400

Bad Request

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 404

Not Found

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 501

Not Implemented

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 500

Internal Server Error

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

### 429

The request was refused because a rate limit was exceeded, or because something a later retry can clear stopped it. A rate limit refusal carries an `application/problem+json` body: wait at least the interval `Retry-After` names before retrying, then back off. Limits are tuned per deployment, so read the allowance from the response headers rather than assuming a fixed ceiling. Any other refusal carries the standard error envelope as `application/json`, and its `error.code` names the cause.

**Content type:** `application/problem+json`

Schema: `RateLimitProblemDetails`

Properties:
- `type` (string) required: The problem type identifier. Always the same value: the failure is the status code itself,  so there is no sub-type for a caller to branch on.
- `title` (string) required: A short, human-readable summary of the problem type.
- `status` (integer(int32)) required: The HTTP status code, repeated in the body as the problem-details format defines.
- `detail` (string) required: A human-readable explanation of this occurrence of the problem.
- `retryAfterSeconds` (integer(int32)) required: How long to wait before retrying, in whole seconds, carrying the same figure as the  `Retry-After` header. Always at least one: a value of zero would invite an immediate  retry that is certain to be rejected again.

**Content type:** `application/json`

Schema: `RemoteServiceErrorResponse`

Properties:
- `error` (RemoteServiceErrorInfo)

## 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

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

### PowerShell

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

### TypeScript (SDK)

```bash
npm install @winkpg/winkpg-api
```

```typescript
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)

```typescript
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();
```

### C# (SDK)

```bash
dotnet add package WinkPg.Api.Client
```

```csharp
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)

```csharp
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();
```

### Python (SDK)

```bash
pip install winkpg-api
```

```python
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)
```

### Python (raw HTTP)

```bash
pip install requests
```

```python
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()
```

## See also

- [All documentation](https://devportal-simpay-sbx.winkpg.io/llms.txt): the machine-readable index of every public page on this site.