Skip to main content
GET
Estimate refund

Authorizations

Authorization
string
header
required

API key for /api/v1/* endpoints

Path Parameters

reference
string
required

Session reference (CS_xxxxx) or invoice reference (INV_xxxxx)

Query Parameters

entity
enum<string>
required

Whether the reference is for a session or invoice

Available options:
session
feePaidBy
enum<string>

Who will pay the network fee

Available options:
merchant,
customer

Response

Refund estimate calculated successfully.