POST/v2/sandbox/transaction/complete

Complete Transaction

Marks an authorized fiat payout as completed in the sandbox environment.

Supports domestic USA payouts (ACH, domestic wire, international wire) and cross-border payouts. Deposit transactions are not supported.

The payout must belong to the calling merchant and must already be fully authorized. If it does not belong to the merchant, returns 404 Transaction Not Found. If it is not fully authorized, returns 404 Transaction not authorized. Already-completed transactions return success.

Sandbox environment only — not available in production.

Headers

FieldTypeRequiredPossible valuesDescription
AuthorizationstringRequiredBearer {SessionToken}Session token from Get Session Token, sent as `Authorization: Bearer {SessionToken}`. Replace with the value from the `x-refresh-token` response header when present (typically within 2 minutes of expiry). Secured calls must use the same IP as the auth request.

Request body

FieldTypeRequiredPossible valuesDescription
TransactionNumberstringRequired{transactionNumber}Transaction number of the authorized sandbox payout to complete.

Example request

{
  "TransactionNumber": "{transactionNumber}"
}

Response

FieldTypePossible valuesDescription
ResponseCodeinteger200 | 201 | 204 | 400 | 401 | 403 | 404 | 410 | 422 | 500 | 301 | 503 | 422API result code in the response envelope. Indicates success or the error category (e.g. 200 success, 400 bad request, 401 unauthorized).
ResponseMessagestringSuccess | Created | NoContent | BadRequest | Unauthorized | Forbidden | NotFound | Gone | UnprocessableContent | ServerError | ResourceMoved | ServiceUnAvailable | UnProcessableEntityHuman-readable label paired with ResponseCode (e.g. Success, BadRequest, Unauthorized). Use with ResponseCode to interpret the outcome.
ResponseDataobjectPlease refer to below example for response bodyResult message for the completion attempt.

Example response

{
  "ResponseCode": 200,
  "ResponseMessage": "Success",
  "ResponseData": {
    "Message": "Transaction successfully completed"
  }
}

Error responses include 404 with "Transaction Not Found." (missing or not owned by the merchant) and 404 with "Transaction not authorized" (payout is not fully authorized, unless already completed).

Requires `Authorization: Bearer {SessionToken}` from Get Session Token. Refresh via `x-refresh-token` when supplied; use the same client IP as authentication.

Search guide books, endpoints, paths, or parameters

↑↓navigateopenEscclose