| Requires any of the roles: | Admin, TeamAdmin, MobileApp | Required permission: | Tickets.Add |
| POST | /GiftCard/Purchase |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| GiftCardTypeId | body | int | No | |
| AmountMinor | body | int | No | |
| PurchasePaymentReference | body | string | No | |
| PurchaseOwnerId | body | int? | No | |
| BuyerName | body | string | No | |
| BuyerPhone | body | string | No | |
| BuyerEmail | body | string | No | |
| RecipientName | body | string | No | |
| IdempotencyKey | body | string | No | |
| PaymentMethodId | body | string | No | |
| PaymentId | body | string | No | |
| CardInfo | body | PaymentRequestCreditCard | No | |
| Borgun3DFinalInfo | body | Borgun3DFinalRequest | No | |
| ApplePayInfo | body | BorgunApplePayFinalInfo | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentMethod | form | PaymentMethodCreditCardInfo | No | |
| Amount | form | decimal | No | |
| Currency | form | string | No | |
| OrderId | form | string | No | |
| TransActionDate | form | DateTime | No | |
| SaveCardToToken | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentType | form | string | No | |
| Token | form | string | No | |
| PAN | form | string | No | |
| ExpYear | form | string | No | |
| ExpMonth | form | string | No | |
| CVC | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| TransactionType | form | string | No | |
| Amount | form | int | No | |
| Currency | form | string | No | |
| TransactionDate | form | DateTime? | No | |
| OrderId | form | string | No | |
| PaymentMethod | form | Borgun3DFinalPaymentMethodInfo | No | |
| ThreeDSecure | form | Borgun3DFinal3DSecureInfo | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PaymentType | form | string | No | |
| Token | form | string | No | |
| VirtualNumber | form | string | No | |
| ExpYear | form | string | No | |
| ExpMonth | form | string | No | |
| PanLastFour | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DataType | form | string | No | |
| MpiToken | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| OrderId | form | string | No | |
| ThreeDSecure | form | BorgunApplePayThreeDSecureInfo | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DataType | form | string | No | |
| SecurityLevelInd | form | string | No | |
| CAVV | form | string | No | |
| UCAF | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Success | form | bool | No | |
| GiftCardId | form | int? | No | |
| Code | form | string | No | |
| CodeLast4 | form | string | No | |
| Status | form | string | No | |
| ExpiresAt | form | DateTime? | No | |
| PaymentId | form | string | No | |
| StatusCode | form | int | No | |
| Message | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /GiftCard/Purchase HTTP/1.1
Host: stubbur-app.azurewebsites.net
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"giftCardTypeId":0,"amountMinor":0,"purchasePaymentReference":"String","purchaseOwnerId":0,"buyerName":"String","buyerPhone":"String","buyerEmail":"String","recipientName":"String","idempotencyKey":"String","paymentMethodId":"String","paymentId":"String","cardInfo":{"paymentMethod":{"paymentType":"String","token":"String","pan":"String","expYear":"String","expMonth":"String","cvc":"String"},"amount":0,"currency":"String","orderId":"String","transActionDate":"0001-01-01T00:00:00.0000000","saveCardToToken":false},"borgun3DFinalInfo":{"transactionType":"String","amount":0,"currency":"String","transactionDate":"0001-01-01T00:00:00.0000000","orderId":"String","paymentMethod":{"paymentType":"String","token":"String","virtualNumber":"String","expYear":"String","expMonth":"String","panLastFour":"String"},"threeDSecure":{"dataType":"String","mpiToken":"String"}},"applePayInfo":{"orderId":"String","threeDSecure":{"dataType":"String","securityLevelInd":"String","cavv":"String","ucaf":"String"}}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"success":false,"giftCardId":0,"code":"String","codeLast4":"String","status":"String","expiresAt":"0001-01-01T00:00:00.0000000","paymentId":"String","statusCode":0,"message":"String"}