Refunds & Reversals

After authorizing a payment, you can return funds to the customer using a refund or undo the transaction with a reversal. Your server initiates both operations.

Refund vs reversal

	Refund	Reversal
Customer visibility	Appears on the customer’s EBT account as a credit	Doesn’t appear on the customer’s account
Use case	Customer returns, order modifications, partial refunds	Same-day voids, error correction, duplicate charges
Partial amounts	Supported	Not supported (full transaction only)
API	`POST /v1/payment/refund`	`POST /v1/payment/reverse`

Refund a payment

Call POST /v1/payment/refund to credit funds back to the customer’s EBT account. You can refund the full amount or a partial amount.

Request

Field	Type	Required	Description
`amount`	integer	Yes	Refund amount in cents.
`paymentType`	string	Yes	`SNAP` or `EBT_CASH`.
`paymentMethodId`	string	Yes	The payment method used in the original payment.
`paymentIntentId`	string	No	The payment intent to refund.
`orderId`	string	No	Your identifier for the order.

Response

Field	Type	Description
`refundIntentId`	string	A unique identifier for the refund.

Idempotency

Pass an Idempotency-Key header to safely retry refund requests without processing the same refund twice. If the API has already processed a request with the same key, it returns the original response.

Node.js
Python
Kotlin
Java

const refund = await client.payment.refund(
  {
    amount: 1500,
    paymentType: "SNAP",
    paymentMethodId: "pm_12345",
    paymentIntentId: "pi_xxx",
  },
  {
    headers: { "Idempotency-Key": "refund_abc123" },
  },
);

console.log(refund.refundIntentId);

refund = client.payment.refund(
    amount=1500,
    payment_type="SNAP",
    payment_method_id="pm_12345",
    payment_intent_id="pi_xxx",
    extra_headers={"Idempotency-Key": "refund_abc123"},
)

print(refund.refund_intent_id)

val refund = client.payment().refund(
    PaymentRefundParams.builder()
        .amount(1500)
        .paymentType("SNAP")
        .paymentMethodId("pm_12345")
        .paymentIntentId("pi_xxx")
        .putAdditionalHeader("Idempotency-Key", "refund_abc123")
        .build()
)

println(refund.refundIntentId())

var refund = client.payment().refund(
    PaymentRefundParams.builder()
        .amount(1500)
        .paymentType("SNAP")
        .paymentMethodId("pm_12345")
        .paymentIntentId("pi_xxx")
        .putAdditionalHeader("Idempotency-Key", "refund_abc123")
        .build()
);

System.out.println(refund.refundIntentId());

Reverse a payment

Call POST /v1/payment/reverse to void a transaction. The reversal doesn’t appear on the customer’s EBT account. You can reverse a payment or a refund by providing the corresponding ID.

Request

Provide one of the following:

Field	Type	Required	Description
`paymentIntentId`	string	No	The payment intent to reverse.
`refundIntentId`	string	No	The refund to reverse.

Response

Field	Type	Description
`retrievalReferenceNumber`	string	A reference number for the reversal.

Node.js
Python
Kotlin
Java

// Reverse a payment
const reversal = await client.payment.reverse({
  paymentIntentId: "pi_xxx",
});

console.log(reversal.retrievalReferenceNumber);

// Reverse a refund
const refundReversal = await client.payment.reverse({
  refundIntentId: "ri_xxx",
});

# Reverse a payment
reversal = client.payment.reverse(
    payment_intent_id="pi_xxx",
)

print(reversal.retrieval_reference_number)

# Reverse a refund
refund_reversal = client.payment.reverse(
    refund_intent_id="ri_xxx",
)

// Reverse a payment
val reversal = client.payment().reverse(
    PaymentReverseParams.builder()
        .paymentIntentId("pi_xxx")
        .build()
)

println(reversal.retrievalReferenceNumber())

// Reverse a refund
val refundReversal = client.payment().reverse(
    PaymentReverseParams.builder()
        .refundIntentId("ri_xxx")
        .build()
)

// Reverse a payment
var reversal = client.payment().reverse(
    PaymentReverseParams.builder()
        .paymentIntentId("pi_xxx")
        .build()
);

System.out.println(reversal.retrievalReferenceNumber());

// Reverse a refund
var refundReversal = client.payment().reverse(
    PaymentReverseParams.builder()
        .refundIntentId("ri_xxx")
        .build()
);

Get Started

Hosted Checkout

Enterprise

Mobile SDKs

Testing

Refunds & Reversals

Refund vs reversal

Refund a payment

Request

Response

Idempotency

Reverse a payment

Request

Response

Get Started

Hosted Checkout

Enterprise

Mobile SDKs

Testing

​Refund vs reversal

​Refund a payment

​Request

​Response

​Idempotency

​Reverse a payment

​Request

​Response

Refund vs reversal

Refund a payment

Request

Response

Idempotency

Reverse a payment

Request

Response