Ask Moov Beta
Generative AI is experimental and can make mistakes.
Guides Dashboard Use cases API Changelog
  1. API reference
  2. Money movement
  3. Refunds

Create a refund

Initiate a refund for a card transfer.

Use the Cancel or refund a card transfer endpoint for more comprehensive cancel and refund options.
See the reversals guide for more information.

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

POST
/accounts/{accountID}/transfers/{transferID}/refunds
cURL Go Java PHP Python TypeScript 
1
2
3
4

curl -X POST "https://api.moov.io/accounts/{accountID}/transfers/{transferID}/refunds" \
  -H "Authorization: Bearer {token}" \
  -H "X-Idempotency-Key: UUID" \
  -H "X-Wait-For: rail-response" \

1
2
3
4
5
6
7
8

mc, _ := moov.NewClient()

var accountID string
var transferID string

mc.RefundTransfer(ctx, accountID, transferID, moov.CreateRefund{
    Amount: 1700,
})

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

package hello.world;

import io.moov.sdk.Moov;
import io.moov.sdk.models.components.CreateRefund;
import io.moov.sdk.models.components.Security;
import io.moov.sdk.models.errors.*;
import io.moov.sdk.models.operations.InitiateRefundRequest;
import io.moov.sdk.models.operations.InitiateRefundResponse;
import java.lang.Exception;

public class Application {

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

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

        InitiateRefundRequest req = InitiateRefundRequest.builder()
                .xIdempotencyKey("bdfa6a76-31f8-4cdf-a007-3d8aac713b91")
                .accountID("9b1350b2-a5be-41e3-92be-61f5cf4372a8")
                .transferID("7390ad29-1a0d-4a0c-8c17-da1708ee9ac2")
                .createRefund(CreateRefund.builder()
                    .amount(1000L)
                    .build())
                .build();

        InitiateRefundResponse res = sdk.transfers().initiateRefund()
                .request(req)
                .call();

        if (res.createRefundResponse().isPresent()) {
            // handle response
        }
    }
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33

declare(strict_types=1);

require 'vendor/autoload.php';

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

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

$request = new Operations\InitiateRefundRequest(
    xIdempotencyKey: '9b1350b2-a5be-41e3-92be-61f5cf4372a8',
    accountID: '7390ad29-1a0d-4a0c-8c17-da1708ee9ac2',
    transferID: 'bdfa6a76-31f8-4cdf-a007-3d8aac713b91',
    createRefund: new Components\CreateRefund(
        amount: 1000,
    ),
);

$response = $sdk->transfers->initiateRefund(
    request: $request
);

if ($response->createRefundResponse !== null) {
    // handle response
}
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15

from moovio_sdk import Moov
from moovio_sdk.models import components


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

    res = moov.transfers.initiate_refund(x_idempotency_key="bdfa6a76-31f8-4cdf-a007-3d8aac713b91", account_id="9b1350b2-a5be-41e3-92be-61f5cf4372a8", transfer_id="7390ad29-1a0d-4a0c-8c17-da1708ee9ac2", amount=1000)

    # Handle response
    print(res)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

import { Moov } from "@moovio/sdk";

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

async function run() {
  const result = await moov.transfers.initiateRefund({
    xIdempotencyKey: "bdfa6a76-31f8-4cdf-a007-3d8aac713b91",
    accountID: "9b1350b2-a5be-41e3-92be-61f5cf4372a8",
    transferID: "7390ad29-1a0d-4a0c-8c17-da1708ee9ac2",
    createRefund: {
      amount: 1000,
    },
  });

  // Handle the result
  console.log(result);
}

run();
200 202 400 404 409 422 429 500 504
The request completed successfully.
examples
{
  "Successful async refund": {
    "summary": "Successful async refund",
    "value": {
      "amount": {
        "currency": "USD",
        "value": 1204
      },
      "createdOn": "2023-09-09T14:15:22Z",
      "refundID": "d4963079-5b35-4d17-981e-8f851753f786"
    }
  },
  "Successful sync refund": {
    "summary": "Successful sync refund",
    "value": {
      "amount": {
        "currency": "USD",
        "value": 1204
      },
      "cardDetails": {
        "confirmedOn": "2023-09-09T14:17:41Z",
        "initiatedOn": "2023-09-09T14:16:22Z",
        "status": "confirmed"
      },
      "createdOn": "2023-09-09T14:15:22Z",
      "refundID": "d4963079-5b35-4d17-981e-8f851753f786",
      "status": "pending",
      "updatedOn": "2023-09-09T14:17:41Z"
    }
  }
}
schema
{
  "oneOf": [
    {
      "description": "Details of a card refund.",
      "properties": {
        "amount": {
          "properties": {
            "currency": {
              "description": "A 3-letter ISO 4217 currency code.",
              "example": "USD",
              "pattern": "^[A-Za-z]{3}$",
              "type": "string"
            },
            "value": {
              "description": "Quantity in the smallest unit of the specified currency. \n\nIn USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.",
              "example": 1204,
              "format": "int64",
              "type": "integer"
            }
          },
          "required": [
            "currency",
            "value"
          ],
          "type": "object"
        },
        "cardDetails": {
          "properties": {
            "completedOn": {
              "format": "date-time",
              "type": "string"
            },
            "confirmedOn": {
              "format": "date-time",
              "type": "string"
            },
            "failedOn": {
              "format": "date-time",
              "type": "string"
            },
            "failureCode": {
              "enum": [
                "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"
              ],
              "type": "string"
            },
            "initiatedOn": {
              "format": "date-time",
              "type": "string"
            },
            "settledOn": {
              "format": "date-time",
              "type": "string"
            },
            "status": {
              "enum": [
                "initiated",
                "confirmed",
                "settled",
                "failed",
                "completed"
              ],
              "type": "string"
            }
          },
          "required": [
            "status"
          ],
          "type": "object"
        },
        "createdOn": {
          "format": "date-time",
          "type": "string"
        },
        "refundID": {
          "description": "Identifier for the refund.",
          "format": "uuid",
          "type": "string"
        },
        "status": {
          "enum": [
            "created",
            "pending",
            "completed",
            "failed"
          ],
          "type": "string"
        },
        "updatedOn": {
          "format": "date-time",
          "type": "string"
        }
      },
      "required": [
        "refundID",
        "createdOn",
        "updatedOn",
        "status",
        "amount"
      ],
      "title": "Sync",
      "type": "object"
    },
    {
      "description": "Asynchronous refund response",
      "properties": {
        "amount": {
          "properties": {
            "currency": {
              "description": "A 3-letter ISO 4217 currency code.",
              "example": "USD",
              "pattern": "^[A-Za-z]{3}$",
              "type": "string"
            },
            "value": {
              "description": "Quantity in the smallest unit of the specified currency. \n\nIn USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.",
              "example": 1204,
              "format": "int64",
              "type": "integer"
            }
          },
          "required": [
            "currency",
            "value"
          ],
          "type": "object"
        },
        "createdOn": {
          "format": "date-time",
          "type": "string"
        },
        "refundID": {
          "format": "uuid",
          "type": "string"
        }
      },
      "required": [
        "refundID",
        "createdOn",
        "amount"
      ],
      "title": "Async",
      "type": "object"
    }
  ]
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
A refund was successfully created but an error occurred while waiting for a synchronous response.
schema
{
  "description": "Details of a card refund.",
  "properties": {
    "amount": {
      "properties": {
        "currency": {
          "description": "A 3-letter ISO 4217 currency code.",
          "example": "USD",
          "pattern": "^[A-Za-z]{3}$",
          "type": "string"
        },
        "value": {
          "description": "Quantity in the smallest unit of the specified currency. \n\nIn USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.",
          "example": 1204,
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "currency",
        "value"
      ],
      "type": "object"
    },
    "cardDetails": {
      "properties": {
        "completedOn": {
          "format": "date-time",
          "type": "string"
        },
        "confirmedOn": {
          "format": "date-time",
          "type": "string"
        },
        "failedOn": {
          "format": "date-time",
          "type": "string"
        },
        "failureCode": {
          "enum": [
            "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"
          ],
          "type": "string"
        },
        "initiatedOn": {
          "format": "date-time",
          "type": "string"
        },
        "settledOn": {
          "format": "date-time",
          "type": "string"
        },
        "status": {
          "enum": [
            "initiated",
            "confirmed",
            "settled",
            "failed",
            "completed"
          ],
          "type": "string"
        }
      },
      "required": [
        "status"
      ],
      "type": "object"
    },
    "createdOn": {
      "format": "date-time",
      "type": "string"
    },
    "refundID": {
      "description": "Identifier for the refund.",
      "format": "uuid",
      "type": "string"
    },
    "status": {
      "enum": [
        "created",
        "pending",
        "completed",
        "failed"
      ],
      "type": "string"
    },
    "updatedOn": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "refundID",
    "createdOn",
    "updatedOn",
    "status",
    "amount"
  ],
  "title": "Sync",
  "type": "object"
}

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
The server could not understand the request due to invalid syntax.
schema
{
  "properties": {
    "error": {
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}

Response headers

x-request-id

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

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.
Attempted to create a refund using a duplicate X-Idempotency-Key header.
schema
{
  "description": "Details of a card refund.",
  "properties": {
    "amount": {
      "properties": {
        "currency": {
          "description": "A 3-letter ISO 4217 currency code.",
          "example": "USD",
          "pattern": "^[A-Za-z]{3}$",
          "type": "string"
        },
        "value": {
          "description": "Quantity in the smallest unit of the specified currency. \n\nIn USD this is cents, for example, $12.04 is 1204 and $0.99 is 99.",
          "example": 1204,
          "format": "int64",
          "type": "integer"
        }
      },
      "required": [
        "currency",
        "value"
      ],
      "type": "object"
    },
    "cardDetails": {
      "properties": {
        "completedOn": {
          "format": "date-time",
          "type": "string"
        },
        "confirmedOn": {
          "format": "date-time",
          "type": "string"
        },
        "failedOn": {
          "format": "date-time",
          "type": "string"
        },
        "failureCode": {
          "enum": [
            "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"
          ],
          "type": "string"
        },
        "initiatedOn": {
          "format": "date-time",
          "type": "string"
        },
        "settledOn": {
          "format": "date-time",
          "type": "string"
        },
        "status": {
          "enum": [
            "initiated",
            "confirmed",
            "settled",
            "failed",
            "completed"
          ],
          "type": "string"
        }
      },
      "required": [
        "status"
      ],
      "type": "object"
    },
    "createdOn": {
      "format": "date-time",
      "type": "string"
    },
    "refundID": {
      "description": "Identifier for the refund.",
      "format": "uuid",
      "type": "string"
    },
    "status": {
      "enum": [
        "created",
        "pending",
        "completed",
        "failed"
      ],
      "type": "string"
    },
    "updatedOn": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "refundID",
    "createdOn",
    "updatedOn",
    "status",
    "amount"
  ],
  "title": "Sync",
  "type": "object"
}

Response headers

x-request-id

string <uuid> 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.
schema
{
  "properties": {
    "amount": {
      "type": "string"
    },
    "error": {
      "description": "Used for generic errors when invalid request data isn't attributed to a single request field.",
      "type": "string"
    }
  },
  "type": "object"
}

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

x-request-id

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

Response headers

x-request-id

string <uuid> required
A unique identifier used to trace requests.

Headers

x-moov-version

string
API version

Specify an API version.

API versioning follows the format vYYYY.QQ.BB, where

  • YYYY is the year
  • QQ is the two-digit month for the first month of the quarter (e.g., 01, 04, 07, 10)
  • BB is the build number, starting at .01, for subsequent builds in the same quarter.
    • For example, v2024.01.00 is the initial release of the first quarter of 2024.

The latest version represents the most recent development state. It may include breaking changes and should be treated as a beta release.

Default: v2024.01.00

x-idempotency-key

string <uuid> required
Prevents duplicate refunds from being created.

x-wait-for

string
Optional header that indicates whether to return a synchronous response that includes full transfer and rail-specific details or an asynchronous response indicating the transfer was created (this is the default response if the header is omitted). A timeout will occur after 15 seconds.
Possible values: rail-response

Path parameters

accountID

string <uuid> required
The merchant's Moov account ID.

transferID

string <uuid> required
Identifier for the transfer.

Body

application/json

Specifies a partial amount to refund.

This request body is optional, an empty body will issue a refund for the full amount of the original transfer.

amount

integer<int64>
Amount to refund in cents. If null, the original transfer's full amount will be refunded.

Response

application/json
Sync Async
Details of a card refund.

amount

object
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.

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>

createdOn

string<date-time>

refundID

string<uuid>
Identifier for the refund.

status

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

updatedOn

string<date-time>
Asynchronous refund response

amount

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

refundID

string<uuid>
OSZAR »