| Requires any of the roles: | Admin, TeamAdmin | Requires the permission: | Tickets.Add |
| POST | /OwnerCards/{Id}/refund |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Id | path | int | No | |
| OwnerId | body | int | No | |
| Reason | body | string | No | |
| UserId | body | int? | No | |
| IdempotencyKey | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| StatusCode | form | int | No | |
| Message | form | string | No | |
| Result | form | string | No | |
| OwnerCardId | form | int | No | |
| OwnerId | form | int | No | |
| OrderReference | form | string | No | |
| PaymentReference | form | string | No | |
| PreviousPaymentStatus | form | string | No | |
| PaymentStatus | form | string | No | |
| CardRefundAmount | form | int | No | |
| GiftCreditAmount | form | int | No | |
| GiftCreditPendingAmount | form | int | No | |
| TotalRefunded | form | int | No | |
| DonationAmountNotRefunded | form | int | No | |
| BorgunRefunded | form | bool | No | |
| BorgunPartial | form | bool | No | |
| BorgunRefundTransactionId | form | string | No | |
| MerchantCredentials | form | string | No | |
| Replayed | form | bool | No | |
| RefundId | form | int | No | |
| RefundedUTC | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /OwnerCards/{Id}/refund HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
id: 0,
ownerId: 0,
reason: String,
userId: 0,
idempotencyKey: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
success: False,
statusCode: 0,
message: String,
result: String,
ownerCardId: 0,
ownerId: 0,
orderReference: String,
paymentReference: String,
previousPaymentStatus: String,
paymentStatus: String,
cardRefundAmount: 0,
giftCreditAmount: 0,
giftCreditPendingAmount: 0,
totalRefunded: 0,
donationAmountNotRefunded: 0,
borgunRefunded: False,
borgunPartial: False,
borgunRefundTransactionId: String,
merchantCredentials: String,
replayed: False,
refundId: 0,
refundedUTC: 0001-01-01
}