Skip to main content
GET
Retrieve a refund
Payments and refunds are in beta. Contact Vori Support to enable them for your account. Until they are enabled, these endpoints answer 403 Forbidden.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

A refund of a card payment taken through the Vori API. One refund is one attempt to give money back, and a refund is never edited once the processor has answered.

id
string
required

Unique identifier for the record.

amount
string<positive-monetary>
required

Amount returned to the card, in dollars.

Pattern: ^[0-9]+(\.[0-9]+)?$
Example:

"199.99"

created_at
string<date-time>
required

When the record was created.

idempotency_key
string
required

Your own key for the refund, unique within the banner and mode. Sending the same key again returns the refund already made rather than refunding twice. Up to 255 characters.

metadata
object | null
required

Your own key/value pairs, exactly as supplied when the refund was made.

Example:
mode
enum<string>
required

Whether money moves for real or not: test refunds in the payment processor's test environment and never moves money, and live makes an actual refund. It is always the mode of the payment being refunded.

Available options:
live,
test
payment_id
string
required

ID of the payment being refunded.

processor
enum<string>
required

The payment processor that handled the refund, which is the one that took the payment.

Available options:
datacap
status
enum<string>
required

Where the refund stands: captured once the money was given back, and failed when the processor refused it. A refund is never authorized. A refund the processor has not answered for yet is not served at all, and goes on holding that part of the payment until its outcome is known.

Available options:
authorized,
captured,
failed
store_id
string
required

ID of the store the refund was made for.

Pattern: ^[0-9]+$
type
enum<string>
required

How the money was given back: void cancels the charge before it settles, and return sends money back to the card. Vori picks whichever the payment still allows.

Available options:
return,
void
updated_at
string<date-time>
required

When the record was last changed.