Contact Us
Dashboard
Dashboard

Refund

Create multiple Refunds

Guides

API Reference

Webhooks

Ivy Docs home page

Getting Started

Introduction
Authentication
Metadata
Errors

Bank

POST
List banks
POST
Search a Bank
POST
Retrieve a bank

Checkout

POST
Create a Checkout Session
POST
Retrieve a Checkout Session
POST
Expire a Checkout Session

Customer

POST
Create a new customer
POST
Retrieve the customer by id

Order

POST
Retrieve an order
POST
Update an order

Charge

POST
Create a Charge

Mandate

POST
Revoke a Mandate
POST
Retrieve a Mandate
POST
Lookup a Mandate

Capabilities

POST
Retrieve your Capabilities

Subaccount

POST
Create a Subaccount
POST
Retrieve a Subaccount

Refund

POST
Create multiple Refunds
POST
Create one Refund

Payout Report

POST
Create a Payout Report
POST
Download a Payout Report
POST
Retrieve a Payout Report status

Balance

POST
Retrieve Account Balance

Customer Payout

POST
Create a Customer Payout
POST
List Customer Payouts
POST
Retrieve a Customer Payout

Refund

Create multiple Refunds

Initiates a batch refund for all provided orders. The orders can be specified either by Ivy’s internal id (“orderId”) or by id provided by the merchant (“referenceId”). If only a partial amount should be refunded the desired amount can be set with the “amount” parameter. Additional information regarding the refund can be provided through the “description” parameter.

POST

api

service

merchant

payment

refund

batch

Authorizations

X-Ivy-Api-Key

string

header

required

Body

application/json

requestedRefunds

object[]

required

An array of refunds to be triggered.

requestedRefunds.amount

number

The amount to refund in decimals, e.g. 10.23 for EUR 10.23. If not specified, the full order amount will be refunded.

requestedRefunds.description

string

A description for the refund. This will be retrievable in the API and in the Ivy dashboard.

requestedRefunds.displayedPaymentReference

string

An optional custom text that will be shown on the customer's payment reference. Input has to be maximum 16 alpha-numeric characters. If not provided, a default Ivy refund referenceId will be shown.

requestedRefunds.email

string

The email of the customer. If provided, Ivy may use this email to contact the customer directly in case of issues or need for clarification regarding the refund. If not provided, Ivy will contact the merchant in such cases. However, this is a rare occurrence.

requestedRefunds.orderId

string

The internal Ivy id of the order.

requestedRefunds.referenceId

string

The external id set by the merchant during checkout creation.

Maximum length: 200

Response

200 - application/json

requestedRefunds

object[]

required

An array of refund responses.

requestedRefunds.orderId

string

required

The Ivy id of the corresponding order.

requestedRefunds.orderStatus

enum<string>

required

The order status. This status symbolises the state of the user's payment attempt. See the guide for more information.

Available options:

failed,

canceled,

processing,

in_handshake,

waiting_for_payment,

paid,

in_refund,

refunded,

refund_failed,

partially_refunded,

in_dispute,

disputed,

refused

requestedRefunds.referenceId

string

required

A unique identifier for the newly created refund. You can use this id to retrieve the refund from the order object.

Maximum length: 200

requestedRefunds.refundStatus

enum<string>

required

The status of the refund. Always use the status of the order as your source of truth to trigger actions in your dashboard.

Available options:

pending,

succeeded,

failed,

requires_action,

partially_refunded

requestedRefunds.error

string

The error message why the refund failed.

Retrieve a Subaccount Create one Refund

website linkedin