Advance a sandbox ACH sale to a chosen settlement outcome.

Example request

Each example below is one request, shown in every language. Choose an example and a language, then 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

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.

cURL

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

$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

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": "SettlementSucceeded"
});

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": "SettlementSucceeded"
  }),
});

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": "SettlementSucceeded"
    }
    """);

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": "SettlementSucceeded"
    }
    """, 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": "SettlementSucceeded"
    })
    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": "SettlementSucceeded"
}

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

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

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

$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

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": "SettlementRolledBack",
  "nachaReturnCode": "R01",
  "nachaReturnReason": "Insufficient funds"
});

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": "SettlementRolledBack",
    "nachaReturnCode": "R01",
    "nachaReturnReason": "Insufficient funds"
  }),
});

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": "SettlementRolledBack",
      "nachaReturnCode": "R01",
      "nachaReturnReason": "Insufficient funds"
    }
    """);

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": "SettlementRolledBack",
      "nachaReturnCode": "R01",
      "nachaReturnReason": "Insufficient funds"
    }
    """, 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": "SettlementRolledBack",
      "nachaReturnCode": "R01",
      "nachaReturnReason": "Insufficient funds"
    })
    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": "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()

Parameters

Name In Type Description

id required

path

string (uuid)

The loopback ACH sale to advance. Must belong to the calling key's merchant.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

suppressNulls required

query

boolean

If true, omit properties with null values.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Request body

application/json , required

Field Type Description

targetStatus required

SandboxAchTargetStatus 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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

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

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This request body has no documented fields.

Responses

200 OK

OK

Body: SandboxAchStatusAdvanceResultDto SandboxAchStatusAdvanceResultDto Each item has these fields.

Field Type Description

transactionId required

string (uuid)

The transaction that was advanced.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

previousStatus required

string

The settlement status the transaction held before the advance, by its literal name. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

newStatus required

string

The settlement status the transaction now holds, by its literal name. nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

isLateReturn required

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.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

achStatusChangedPublished required

boolean

Whether the `Transaction.AchStatusChanged` event was published.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

returnedPublished required

boolean

Whether the `Transaction.Returned` event was published. Only a return publishes it.

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

429 Too Many Requests

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.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This response has no documented body fields.

Errors 400 401 403 404 500 501 default

400 Bad Request Bad request. The request was malformed or failed validation. When validation rejected it, `error.validationErrors` names each member at fault and why.
401 Unauthorized Unauthorized. The request carried no API key or signed-in session, or the key it carried is invalid, revoked or expired.
403 Forbidden Forbidden. The API key lacks the scope this operation needs, the signed-in user lacks the permission, or a business rule refused the request. The error code in the body names the reason.
404 Not Found Not found. The resource the request names does not exist or is not visible to the caller: a resource that belongs to a merchant or tenant outside the caller's scope is reported as not found.
500 Internal Server Error Internal server error. The platform failed unexpectedly while handling the request. If it keeps failing, contact support and quote the correlation id, which the response carries in the `X-Correlation-Id` header and as `error.data.correlationId`.
501 Not Implemented Not implemented. The operation is declared but has no implementation on this deployment, so no request to it can succeed. Retrying does not help.
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 lists the values `error.code` can take.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 lists the values `error.code` can take.

Body: RemoteServiceErrorResponse RemoteServiceErrorResponse Each item has these fields.

Field Type Description

error required

RemoteServiceErrorInfo RemoteServiceErrorInfo

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

Fields of RemoteServiceErrorInfo:

Field Type Description

code required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

message required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

details required

string

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

data required

object

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

validationErrors required

array of RemoteServiceValidationErrorInfo array of RemoteServiceValidationErrorInfo

nullable

Values: Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.

This body has no documented fields.

This response has no documented body fields.

Errors

A failed request returns the platform error envelope. The error reference lists every value error.code can carry and shows the four response shapes.

Codes declared by

Authentication

ApiKey with scopes

The API reference isn't available right now

No such operation

This reference may be out of date

Advance a sandbox ACH sale to a chosen settlement outcome.

Example request

Parameters

Request body

Responses

Errors

Authentication