API Reference
Log in
API Reference

Refund

Event List

Event NameEvent Type​​Trigger Condition​​Data Structure
Refund Succeededrefunds.succeededWhen a refund is successfully processed.Refund
Refund Failedrefunds.failedWhen an attempt to process a refund fails.Refund

Event Object

Field Name

Type

Description

access_no

string

Access number assigned to your platform by Subotiz

merchant_id

string

Merchant ID for your platform

refund_id

string

Refund order ID

trade_id

string

Trade order ID

currency

string

Currency of the refund amount

reason

string

Reason for initiating the refund

refund_amount

string

Amount refunded

refund_status

string

Status of the refund:

  • pending: Processing
  • failed: Refund failed
  • succeeded: Refund succeeded

metadata

map<string, string>

Passthrough metadata. Key length must not exceed 40 bytes, value length must not exceed 500 bytes. Total size after JSON encoding must be ≤ 1024 bytes.

failure_reason

string

Reason for the failure refund

ref_arn

string

Acquirer Reference Number (ARN) returned by the card issuer's bank, serving as proof of refund credential on the issuer side.

finished_at

string

Refund completed time