# 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. Requires API key scope: `transactions:write` 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`](https://devportal.demo.winkpg.io/docs/api/models/SandboxAchStatusAdvanceRequestDto.md) Properties: - `targetStatus` ([SandboxAchTargetStatus](https://devportal.demo.winkpg.io/docs/api/models/SandboxAchTargetStatus.md)) 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. (nullable) Values: - `SettlementSucceeded`: The debit cleared and the money moved. The ordinary success case. - `SettlementRolledBack`: The receiving bank returned the debit. Requires a NACHA return code and reason. Arriving after SettlementSucceeded makes it a late return, which the resulting Transaction.Returned event flags. - `NotEligible`: The entry was voided on the processor's side before it reached the ACH network. - `SettlementFailed`: The processor reported an error on the entry rather than accepting it. - `Accepted`: The processor accepted the entry and queued it for the next origination window. The first intermediate status. - `Verifying`: The processor is verifying the account before origination. Follows Accepted. - `Originated`: The entry was originated onto the ACH network and is in flight. Follows Verifying. - `PartiallySettled`: Part of the amount has settled. The last intermediate status; follows Originated. - `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. (nullable) - `nachaReturnReason` (string): The return reason to record, for example `Insufficient funds`. Required alongside `nachaReturnCode`, and rejected on any other outcome for the same reason. (nullable, max length 120) _Example: Settle a sandbox ACH debit_ Moves a sandbox ACH sale to SettlementSucceeded and publishes the same Transaction.AchStatusChanged event a real settlement produces. Put the sale's id in the route. Sandbox keys only. ```json { "targetStatus": "SettlementSucceeded" } ``` _Example: Return a sandbox ACH debit for insufficient funds_ Moves a sandbox ACH sale to SettlementRolledBack with a NACHA return code and reason, and publishes the Transaction.Returned event a real return produces. A return needs both the code (R followed by two digits) and the reason; every other outcome takes neither. ```json { "targetStatus": "SettlementRolledBack", "nachaReturnCode": "R01", "nachaReturnReason": "Insufficient funds" } ``` **Content type:** `text/json` Schema: [`SandboxAchStatusAdvanceRequestDto`](https://devportal.demo.winkpg.io/docs/api/models/SandboxAchStatusAdvanceRequestDto.md) Properties: - `targetStatus` ([SandboxAchTargetStatus](https://devportal.demo.winkpg.io/docs/api/models/SandboxAchTargetStatus.md)) 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. (nullable) Values: - `SettlementSucceeded`: The debit cleared and the money moved. The ordinary success case. - `SettlementRolledBack`: The receiving bank returned the debit. Requires a NACHA return code and reason. Arriving after SettlementSucceeded makes it a late return, which the resulting Transaction.Returned event flags. - `NotEligible`: The entry was voided on the processor's side before it reached the ACH network. - `SettlementFailed`: The processor reported an error on the entry rather than accepting it. - `Accepted`: The processor accepted the entry and queued it for the next origination window. The first intermediate status. - `Verifying`: The processor is verifying the account before origination. Follows Accepted. - `Originated`: The entry was originated onto the ACH network and is in flight. Follows Verifying. - `PartiallySettled`: Part of the amount has settled. The last intermediate status; follows Originated. - `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. (nullable) - `nachaReturnReason` (string): The return reason to record, for example `Insufficient funds`. Required alongside `nachaReturnCode`, and rejected on any other outcome for the same reason. (nullable, max length 120) _Example: Settle a sandbox ACH debit_ Moves a sandbox ACH sale to SettlementSucceeded and publishes the same Transaction.AchStatusChanged event a real settlement produces. Put the sale's id in the route. Sandbox keys only. ```json { "targetStatus": "SettlementSucceeded" } ``` _Example: Return a sandbox ACH debit for insufficient funds_ Moves a sandbox ACH sale to SettlementRolledBack with a NACHA return code and reason, and publishes the Transaction.Returned event a real return produces. A return needs both the code (R followed by two digits) and the reason; every other outcome takes neither. ```json { "targetStatus": "SettlementRolledBack", "nachaReturnCode": "R01", "nachaReturnReason": "Insufficient funds" } ``` **Content type:** `application/*+json` Schema: [`SandboxAchStatusAdvanceRequestDto`](https://devportal.demo.winkpg.io/docs/api/models/SandboxAchStatusAdvanceRequestDto.md) Properties: - `targetStatus` ([SandboxAchTargetStatus](https://devportal.demo.winkpg.io/docs/api/models/SandboxAchTargetStatus.md)) 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. (nullable) Values: - `SettlementSucceeded`: The debit cleared and the money moved. The ordinary success case. - `SettlementRolledBack`: The receiving bank returned the debit. Requires a NACHA return code and reason. Arriving after SettlementSucceeded makes it a late return, which the resulting Transaction.Returned event flags. - `NotEligible`: The entry was voided on the processor's side before it reached the ACH network. - `SettlementFailed`: The processor reported an error on the entry rather than accepting it. - `Accepted`: The processor accepted the entry and queued it for the next origination window. The first intermediate status. - `Verifying`: The processor is verifying the account before origination. Follows Accepted. - `Originated`: The entry was originated onto the ACH network and is in flight. Follows Verifying. - `PartiallySettled`: Part of the amount has settled. The last intermediate status; follows Originated. - `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. (nullable) - `nachaReturnReason` (string): The return reason to record, for example `Insufficient funds`. Required alongside `nachaReturnCode`, and rejected on any other outcome for the same reason. (nullable, max length 120) _Example: Settle a sandbox ACH debit_ Moves a sandbox ACH sale to SettlementSucceeded and publishes the same Transaction.AchStatusChanged event a real settlement produces. Put the sale's id in the route. Sandbox keys only. ```json { "targetStatus": "SettlementSucceeded" } ``` _Example: Return a sandbox ACH debit for insufficient funds_ Moves a sandbox ACH sale to SettlementRolledBack with a NACHA return code and reason, and publishes the Transaction.Returned event a real return produces. A return needs both the code (R followed by two digits) and the reason; every other outcome takes neither. ```json { "targetStatus": "SettlementRolledBack", "nachaReturnCode": "R01", "nachaReturnReason": "Insufficient funds" } ``` ## Responses ### 200 OK **Content type:** `application/json` Schema: [`SandboxAchStatusAdvanceResultDto`](https://devportal.demo.winkpg.io/docs/api/models/SandboxAchStatusAdvanceResultDto.md) Properties: - `transactionId` (string(uuid)): The transaction that was advanced. - `previousStatus` (string): The settlement status the transaction held before the advance, by its literal name. (nullable) - `newStatus` (string): The settlement status the transaction now holds, by its literal name. (nullable) - `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`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 401 Unauthorized **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 400 Bad Request **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Request failed validation_ One or more fields were rejected before any rule ran. error.code is null on the envelope and the causes are in validationErrors, one entry per failure. An entry carries code when the validator declared a publishable one, and memberPaths when the full path says more than members does (an element inside a collection, for example). Both keys are omitted when they would add nothing. ```json { "error": { "code": "null", "message": "Your request is not valid!", "details": "The following errors were detected during validation.", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": [ { "message": "'Amount' must be greater than 0.", "members": [ "amount" ] }, { "message": "The card has expired.", "members": [ "expirationDate" ], "code": "CardData:CardExpired" }, { "message": "'Value' must not be empty.", "members": [ "value" ], "memberPaths": [ "customFields[2].value" ] } ] } } ``` ### 404 Not Found **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Resource not found_ The id in the path names no record the caller can see. Most resources answer with a null error.code and a message naming the resource type and the id; a resource that publishes a not-found code in the catalog above carries it in error.code instead, so check for one before matching on the message. ```json { "error": { "code": "null", "message": "There is no entity Transaction with id = 7d1f3a52-0c4e-4b8a-9e21-5a6b7c8d9e00!", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 501 Not Implemented **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 500 Internal Server Error **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ### 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. The [error reference](https://devportal.demo.winkpg.io/docs/errors.md) lists the values `error.code` can take. **Content type:** `application/json` Schema: [`RemoteServiceErrorResponse`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) _Example: Business rule refused the request_ The request was understood and rejected by a platform rule. This is the shape that carries a code from the catalog above, so branch on error.code rather than on the message text. The HTTP status is the one listed against the code. ```json { "error": { "code": "Transactions:OperationNotAllowed", "message": "The operation 'Void' is not allowed on a Sale transaction with result 'Approved' and settlement state 'Settled'.", "details": "null", "data": { "correlationId": "0123456789abcdef0123456789abcdef" }, "validationErrors": "null" } } ``` ### 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`](https://devportal.demo.winkpg.io/docs/api/models/RateLimitProblemDetails.md) 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. (nullable) - `title` (string) required: A short, human-readable summary of the problem type. (nullable) - `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. (nullable) - `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`](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorResponse.md) Properties: - `error` ([RemoteServiceErrorInfo](https://devportal.demo.winkpg.io/docs/api/models/RemoteServiceErrorInfo.md)) ## 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. These blocks send the Settle a sandbox ACH debit example. The other examples follow under Other request examples. Moves a sandbox ACH sale to SettlementSucceeded and publishes the same Transaction.AchStatusChanged event a real settlement produces. Put the sale's id in the route. Sandbox keys only. ### 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": "SettlementSucceeded" }' ``` ### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "targetStatus": "SettlementSucceeded" } '@ $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": "SettlementSucceeded" }); ``` ### 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": "SettlementSucceeded" }), }); 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(""" { "targetStatus": "SettlementSucceeded" } """); 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": "SettlementSucceeded" } """, 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": "SettlementSucceeded" }) 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": "SettlementSucceeded" } response = requests.request( "POST", "{{BASE_URL}}/api/transactions/{id}/sandbox/ach-status", headers=headers, json=body, ) response.raise_for_status() data = response.json() ``` ## Other request examples Each example below is one request, shown in every language with the same placeholders. ### Return a sandbox ACH debit for insufficient funds Moves a sandbox ACH sale to SettlementRolledBack with a NACHA return code and reason, and publishes the Transaction.Returned event a real return produces. A return needs both the code (R followed by two digits) and the reason; every other outcome takes neither. #### 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": "SettlementRolledBack", "nachaReturnCode": "R01", "nachaReturnReason": "Insufficient funds" }' ``` #### PowerShell ```powershell $headers = @{ 'api-key' = '{{API_KEY}}' } $body = @' { "targetStatus": "SettlementRolledBack", "nachaReturnCode": "R01", "nachaReturnReason": "Insufficient funds" } '@ $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": "SettlementRolledBack", "nachaReturnCode": "R01", "nachaReturnReason": "Insufficient funds" }); ``` #### 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": "SettlementRolledBack", "nachaReturnCode": "R01", "nachaReturnReason": "Insufficient funds" }), }); 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(""" { "targetStatus": "SettlementRolledBack", "nachaReturnCode": "R01", "nachaReturnReason": "Insufficient funds" } """); 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": "SettlementRolledBack", "nachaReturnCode": "R01", "nachaReturnReason": "Insufficient funds" } """, 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": "SettlementRolledBack", "nachaReturnCode": "R01", "nachaReturnReason": "Insufficient funds" }) 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": "SettlementRolledBack", "nachaReturnCode": "R01", "nachaReturnReason": "Insufficient funds" } 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.demo.winkpg.io/llms.txt): the machine-readable index of every public page on this site.