Cancel or refund a card transfer

Reverses a card transfer by initiating a cancellation or refund depending on the transaction status. Read our reversals guide to learn more.

To access this endpoint using a token you'll need to specify the /accounts/{accountID}/transfers.write scope.

POST
/accounts/{accountID}/transfers/{transferID}/reversals
cURL Go TypeScript PHP Java Python Ruby .NET
curl -X POST "https://api.moov.io/accounts/{accountID}/transfers/{transferID}/reversals" \
  -H "Authorization: Bearer {token}" \
  -H "X-Moov-Version: v2026.01.00" \
  -d '{
  "amount": 1000
}'
mc, _ := moov.NewClient()

var accountID string // Partner account
var transferID string
// Idempotency Key is a unique identifier for this Transfer request
// Using the github.com/google/uuid library:
idempotencyKey := moov.WithReversalsIdempotencyKey(uuid.New())

mc.ReverseTransfer(ctx, accountID, transferID, moov.CreateReversal{
  Amount: 1000,
}, idempotencyKey)
import { Moov } from "@moovio/sdk";

const moov = new Moov({
  security: {
    username: "",
    password: "",
  },
});

async function run() {
  const result = await moov.transfers.createReversal({
    xIdempotencyKey: "b91d00b2-4ecb-4eb4-a67f-d6f76c0b7ad8",
    accountID: "f225b49d-911b-440b-baed-6065968b69cb",
    transferID: "a17b29e2-4af6-4c9d-ad3a-dd0ded2966ad",
    createReversal: {
      amount: 1000,
    },
  });

  console.log(result);
}

run();
declare(strict_types=1);

require 'vendor/autoload.php';

use Moov\MoovPhp;
use Moov\MoovPhp\Models\Components;

$sdk = MoovPhp\Moov::builder()
    ->setSecurity(
        new Components\Security(
            username: '',
            password: '',
        )
    )
    ->build();

$createReversal = new Components\CreateReversal(
    amount: 1000,
);

$response = $sdk->transfers->createReversal(
    xIdempotencyKey: 'b91d00b2-4ecb-4eb4-a67f-d6f76c0b7ad8',
    accountID: 'f225b49d-911b-440b-baed-6065968b69cb',
    transferID: 'a17b29e2-4af6-4c9d-ad3a-dd0ded2966ad',
    createReversal: $createReversal

);

if ($response->reversal !== null) {
    // handle response
}
package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.*;
import io.moov.sdk.models.errors.GenericError;
import io.moov.sdk.models.errors.ReversalValidationError;
import io.moov.sdk.models.operations.CreateReversalResponse;
import java.lang.Exception;
import java.lang.Object;

public class Application {

    public static void main(String[] args) throws GenericError, ReversalValidationError, Exception {

        Moov sdk = Moov.builder()
                .security(Security.builder()
                    .username("")
                    .password("")
                    .build())
            .build();

        CreateReversalResponse res = sdk.transfers().createReversal()
                .xIdempotencyKey("b91d00b2-4ecb-4eb4-a67f-d6f76c0b7ad8")
                .accountID("f225b49d-911b-440b-baed-6065968b69cb")
                .transferID("a17b29e2-4af6-4c9d-ad3a-dd0ded2966ad")
                .createReversal(CreateReversal.builder()
                    .amount(1000L)
                    .build())
                .call();

        if (res.reversal().isPresent()) {
            Reversal unionValue = res.reversal().get();
            Object raw = unionValue.value();
            if (raw instanceof ReversedWithCancellation) {
                ReversedWithCancellation reversedWithCancellationValue = (ReversedWithCancellation) raw;
                // Handle reversedWithCancellation variant
            } else if (raw instanceof ReversedWithRefund) {
                ReversedWithRefund reversedWithRefundValue = (ReversedWithRefund) raw;
                // Handle reversedWithRefund variant
            } else {
                // Unknown or unsupported variant
            }
        }
    }
}
from moovio_sdk import Moov
from moovio_sdk.models import components


with Moov(
    security=components.Security(
        username="",
        password="",
    ),
) as moov:

    res = moov.transfers.create_reversal(x_idempotency_key="b91d00b2-4ecb-4eb4-a67f-d6f76c0b7ad8", account_id="f225b49d-911b-440b-baed-6065968b69cb", transfer_id="a17b29e2-4af6-4c9d-ad3a-dd0ded2966ad", amount=1000)

    # Handle response
    print(res)
require 'moov_ruby'

Models = ::Moov::Models
s = ::Moov::Client.new(
  security: Models::Components::Security.new(
    username: '',
    password: ''
  )
)
res = s.transfers.create_reversal(x_idempotency_key: 'b91d00b2-4ecb-4eb4-a67f-d6f76c0b7ad8', account_id: 'f225b49d-911b-440b-baed-6065968b69cb', transfer_id: 'a17b29e2-4af6-4c9d-ad3a-dd0ded2966ad', create_reversal: Models::Components::CreateReversal.new(
  amount: 1000
))

unless res.reversal.nil?
  # handle response
end
using Moov.Sdk;
using Moov.Sdk.Models.Components;

var sdk = new MoovClient(security: new Security() {
    Username = "",
    Password = "",
});

var res = await sdk.Transfers.CreateReversalAsync(
    xIdempotencyKey: "b91d00b2-4ecb-4eb4-a67f-d6f76c0b7ad8",
    accountID: "f225b49d-911b-440b-baed-6065968b69cb",
    transferID: "a17b29e2-4af6-4c9d-ad3a-dd0ded2966ad",
    body: new CreateReversal() {
        Amount = 1000,
    }
);

// handle response
200 202 400 401 403 404 409 422 429 500 504
Successfully initiated a reversal.
application/json
{
  "cancellation": {
    "cancellationID": "89ca7f54-13ba-4714-b9af-17163eae2057",
    "createdOn": "2025-01-19T03:02:43.255309588Z",
    "status": "completed"
  }
}
{
  "refund": {
    "amount": {
      "currency": "USD",
      "value": 1938
    },
    "cardDetails": {
      "confirmedOn": "2025-01-19T03:07:26.602114307Z",
      "status": "confirmed"
    },
    "createdOn": "2025-01-19T03:07:26.001024809Z",
    "refundID": "89ca7f54-13ba-4714-b9af-17163eae2057",
    "status": "pending",
    "updatedOn": "2025-01-19T03:07:26.602114307Z"
  }
}

x-request-id

string required
A unique identifier used to trace requests.
Successfully initiated a reversal but an error occurred while waiting for a synchronous response.
application/json
Contains either a cancellation or refund, depending on the method used to reverse the transfer.
{
  "cancellation": {
    "cancellationID": "string",
    "status": "pending",
    "createdOn": "2019-08-24T14:15:22Z"
  }
}

x-request-id

string required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
application/json
{
  "error": "string"
}

x-request-id

string required
A unique identifier used to trace requests.
The request contained missing or expired authentication.

x-request-id

string required
A unique identifier used to trace requests.
The user is not authorized to make the request.

x-request-id

string required
A unique identifier used to trace requests.
The requested resource was not found.

x-request-id

string required
A unique identifier used to trace requests.
The request conflicted with the current state of the target resource.
application/json
{
  "error": "string"
}

x-request-id

string required
A unique identifier used to trace requests.
The request was well-formed, but the contents failed validation. Check the request for missing or invalid fields.
application/json
{
  "amount": "string"
}

x-request-id

string required
A unique identifier used to trace requests.
Request was refused due to rate limiting.

x-request-id

string required
A unique identifier used to trace requests.
The request failed due to an unexpected error.

x-request-id

string required
A unique identifier used to trace requests.
The request failed because a downstream service failed to respond.

x-request-id

string required
A unique identifier used to trace requests.

Headers

X-Moov-Version

string
Set this header to v2026.01.00 to use the API described in this specification. When omitted, the server defaults to v2024.01.00, which may not match the behavior documented here.
Possible values: v2026.01.00

x-idempotency-key

string required
Prevents duplicate reversals from being created.

Path parameters

accountID

string required
The Moov account ID.

transferID

string required
The transfer ID to reverse.

Body

application/json

amount

integer<int64> required
Amount to reverse in cents. Partial amounts will automatically trigger a refund instead of a cancellation.

Response

application/json
Contains either a cancellation or refund, depending on the method used to reverse the transfer.
Canceled Refunded

cancellation

object
Show child attributes

cancellationID

string required

createdOn

string<date-time> required

status

string<enum> required
Possible values: pending, completed, failed

refund

object
Details of a card refund.
Show child attributes

amount

object required
Show child attributes

currency

string required Pattern
A 3-letter ISO 4217 currency code.

value

integer<int64> required

Quantity in the smallest unit of the specified currency.

In USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.

createdOn

string<date-time> required

refundID

string required
Identifier for the refund.

status

string<enum> required
Possible values: created, pending, completed, failed

updatedOn

string<date-time> required

cardDetails

object
Show child attributes

status

string<enum> required
Possible values: initiated, confirmed, settled, failed, completed

completedOn

string<date-time>

confirmedOn

string<date-time>

failedOn

string<date-time>

failureCode

string<enum>
Possible values: call-issuer, do-not-honor, processing-error, invalid-transaction, invalid-amount, no-such-issuer, reenter-transaction, cvv-mismatch, lost-or-stolen, insufficient-funds, invalid-card-number, invalid-merchant, expired-card, incorrect-pin, transaction-not-allowed, suspected-fraud, amount-limit-exceeded, velocity-limit-exceeded, revocation-of-authorization, card-not-activated, issuer-not-available, could-not-route, cardholder-account-closed, unknown-issue, duplicate-transaction

initiatedOn

string<date-time>

settledOn

string<date-time>