Payment refund.
Attribute | Type | Description |
---|---|---|
reason | string | Generic reason for why the refund was intiated. Possible values: ["duplicate", "fraudulent", "requested_by_customer"] |
status | string | Current status of the refund. Possible values: ["created", "failed_charge_for_pending_refund_disputed", "failed_expired_or_cancelled", "failed_lost_or_stolen", "failed_unknown", "succeeded"] |
location.uid | string | Podium unique identifier for location. |
amount | integer | Amount refunded to the customer, represented in cents. |
uid | string | Podium unique identifier for refund. |
createdAt | string | When the refund was initiated. |
cardBrand | string | Brand of the card that is to receive the credited refund. |
cardLast4 | string | Last four digits of the card that is to receive the credited refund. |
notes | array[string] | Detailed note for why the refund was initiated. |
settledAt | string | When the refund was fully completed. Refunds can take 5-10 days to appear in the customer’s bank account. |
{
"reason": "duplicate",
"status": "created",
"location": {
"uid": "00000000-0000-0000-0000-000000000000"
},
"amount": 100,
"uid": "00000000-0000-0000-0000-000000000000",
"createdAt": "2015-01-23T23:50:07Z",
"cardBrand": "visa",
"cardLast4": "4242",
"notes": [
"The product did not function properly."
],
"settledAt": "2015-01-23T23:50:07Z"
}