Skip to main content
Een Refund is een volledige of gedeeltelijke terugboeking van een betaling, uitgevoerd met Refund Payment. Het legt vast hoeveel er is overgemaakt, via welke provider en of het is gelukt. Gebruik de Refunds API om de terugbetalingen van een betaling of van een volledig account weer te geven, en om één terugbetaling op te halen.

Endpoints

Attributen

string
vereist
Refund-ID, met prefix rf_.
string | null
vereist
Het account dat de terugbetaling heeft uitgevoerd, met prefix biz_.
object | null
vereist
Het terugbetaalde bedrag zoals het is verrekend, in de afrekeningsvaluta van de betaling, zodat pagina’s met terugbetalingen kunnen worden verrekend met refunded_amount van de betaling. Omgerekend tegen de koers die gold toen de terugbetaling werd uitgevoerd, niet tegen de oorspronkelijke koers van de betaling. Alleen null als er geen wisselkoers is vastgelegd voor een verouderde betaling in meerdere valuta.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string
vereist
Wanneer de terugbetaling is aangevraagd, als ISO 8601-tijdstempel.
string | null
vereist
Een uitleg voor de verkoper over waarom de terugbetaling is mislukt, in de taal van het verzoek. Null tenzij de terugbetaling is mislukt of geannuleerd.
string | null
vereist
Waarom de terugbetaling is mislukt, genormaliseerd over providers heen. Null tenzij de terugbetaling is mislukt of geannuleerd.Beschikbare opties: bank_declined, expired_or_canceled_card, lost_or_stolen_card, insufficient_funds, charge_disputed, not_refundable, merchant_request, unknown
object | null
vereist
Je eigen key-value-gegevens die bij het aanvragen van de terugbetaling zijn toegevoegd.
object
vereist
Het terugbetaalde bedrag in de valuta die de verwerker heeft overgemaakt.

Eigenschappen

string
vereist
Het bedrag in hoofdeenheden, als exacte decimale string. "10.00" is bijvoorbeeld tien dollar. Het is een string zodat geen float het onderweg afrondt.
string
vereist
Valutacode volgens ISO 4217 van drie letters, in kleine letters.
integer
vereist
Hoeveel decimalen het bedrag heeft. Dit is de precisie waarmee de betaling zelf wordt uitgevoerd.
integer
vereist
Hoeveel decimalen je moet TONEN. Meestal gelijk aan decimals, en bewust niet altijd: COP wordt in centavos afgerekend maar in hele peso’s geschreven, dus het is 2 en 0. Formatteer het getal hiermee in je eigen locale.
string
vereist
De betaling die deze terugbetaling terugdraait, met prefix pay_.
string
vereist
De betaalprovider die de terugbetaling heeft verwerkt, zoals paypal of coinbase.
string | null
vereist
Wanneer de provider de terugbetaling heeft aangemaakt, als ISO 8601-tijdstempel.
string | null
vereist
Waarom de terugbetaling is uitgevoerd, indien vastgelegd.Beschikbare opties: duplicate, fraudulent, requested_by_customer, expired_uncaptured_charge, dispute_alert
string | null
vereist
Of er een trackingreferentie van het bankennetwerk beschikbaar is voor deze terugbetaling.Beschikbare opties: available, pending, unavailable
string | null
vereist
Het soort trackingreferentie, zoals een acquirer reference number.Beschikbare opties: acquirer_reference_number, retrieval_reference_number, system_trace_audit_number
string | null
vereist
De trackingreferentie waarmee de bank van de koper de terugbetaling kan traceren.
string
vereist
Waar de terugbetaling bij de verwerker staat: pending, requires_action, succeeded, failed of canceled.Beschikbare opties: pending, requires_action, succeeded, failed, canceled
string
vereist
Wanneer de terugbetaling voor het laatst is gewijzigd, als ISO 8601-tijdstempel.
boolean
vereist
True als het kaartnetwerk de terugbetaling heeft gestart via Rapid Dispute Resolution.
Refund