Documentation ¶
Index ¶
- type Client
- func (a *Client) CreatePaymentOrderByDedicated(params *CreatePaymentOrderByDedicatedParams, ...) (*CreatePaymentOrderByDedicatedCreated, ...)deprecated
- func (a *Client) CreatePaymentOrderByDedicatedShort(params *CreatePaymentOrderByDedicatedParams, ...) (*CreatePaymentOrderByDedicatedCreated, error)
- func (a *Client) RefundPaymentOrderByDedicated(params *RefundPaymentOrderByDedicatedParams, ...) (*RefundPaymentOrderByDedicatedOK, *RefundPaymentOrderByDedicatedNoContent, ...)deprecated
- func (a *Client) RefundPaymentOrderByDedicatedShort(params *RefundPaymentOrderByDedicatedParams, ...) (*RefundPaymentOrderByDedicatedOK, error)
- func (a *Client) SetTransport(transport runtime.ClientTransport)
- func (a *Client) SyncPaymentOrders(params *SyncPaymentOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncPaymentOrdersOK, error)deprecated
- func (a *Client) SyncPaymentOrdersShort(params *SyncPaymentOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncPaymentOrdersOK, error)
- type ClientService
- type CreatePaymentOrderByDedicatedBadRequest
- type CreatePaymentOrderByDedicatedConflict
- type CreatePaymentOrderByDedicatedCreated
- type CreatePaymentOrderByDedicatedForbidden
- type CreatePaymentOrderByDedicatedNotFound
- type CreatePaymentOrderByDedicatedParams
- func NewCreatePaymentOrderByDedicatedParams() *CreatePaymentOrderByDedicatedParams
- func NewCreatePaymentOrderByDedicatedParamsWithContext(ctx context.Context) *CreatePaymentOrderByDedicatedParams
- func NewCreatePaymentOrderByDedicatedParamsWithHTTPClient(client *http.Client) *CreatePaymentOrderByDedicatedParams
- func NewCreatePaymentOrderByDedicatedParamsWithTimeout(timeout time.Duration) *CreatePaymentOrderByDedicatedParams
- func (o *CreatePaymentOrderByDedicatedParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
- func (o *CreatePaymentOrderByDedicatedParams) SetBody(body *platformclientmodels.ExternalPaymentOrderCreate)
- func (o *CreatePaymentOrderByDedicatedParams) SetContext(ctx context.Context)
- func (o *CreatePaymentOrderByDedicatedParams) SetFlightId(flightId string)
- func (o *CreatePaymentOrderByDedicatedParams) SetHTTPClient(client *http.Client)
- func (o *CreatePaymentOrderByDedicatedParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
- func (o *CreatePaymentOrderByDedicatedParams) SetNamespace(namespace string)
- func (o *CreatePaymentOrderByDedicatedParams) SetTimeout(timeout time.Duration)
- func (o *CreatePaymentOrderByDedicatedParams) WithBody(body *platformclientmodels.ExternalPaymentOrderCreate) *CreatePaymentOrderByDedicatedParams
- func (o *CreatePaymentOrderByDedicatedParams) WithContext(ctx context.Context) *CreatePaymentOrderByDedicatedParams
- func (o *CreatePaymentOrderByDedicatedParams) WithHTTPClient(client *http.Client) *CreatePaymentOrderByDedicatedParams
- func (o *CreatePaymentOrderByDedicatedParams) WithNamespace(namespace string) *CreatePaymentOrderByDedicatedParams
- func (o *CreatePaymentOrderByDedicatedParams) WithTimeout(timeout time.Duration) *CreatePaymentOrderByDedicatedParams
- func (o *CreatePaymentOrderByDedicatedParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type CreatePaymentOrderByDedicatedReader
- type CreatePaymentOrderByDedicatedUnprocessableEntity
- type RefundPaymentOrderByDedicatedConflict
- type RefundPaymentOrderByDedicatedNoContent
- type RefundPaymentOrderByDedicatedNotFound
- type RefundPaymentOrderByDedicatedOK
- type RefundPaymentOrderByDedicatedParams
- func NewRefundPaymentOrderByDedicatedParams() *RefundPaymentOrderByDedicatedParams
- func NewRefundPaymentOrderByDedicatedParamsWithContext(ctx context.Context) *RefundPaymentOrderByDedicatedParams
- func NewRefundPaymentOrderByDedicatedParamsWithHTTPClient(client *http.Client) *RefundPaymentOrderByDedicatedParams
- func NewRefundPaymentOrderByDedicatedParamsWithTimeout(timeout time.Duration) *RefundPaymentOrderByDedicatedParams
- func (o *RefundPaymentOrderByDedicatedParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
- func (o *RefundPaymentOrderByDedicatedParams) SetBody(body *platformclientmodels.PaymentOrderRefund)
- func (o *RefundPaymentOrderByDedicatedParams) SetContext(ctx context.Context)
- func (o *RefundPaymentOrderByDedicatedParams) SetFlightId(flightId string)
- func (o *RefundPaymentOrderByDedicatedParams) SetHTTPClient(client *http.Client)
- func (o *RefundPaymentOrderByDedicatedParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
- func (o *RefundPaymentOrderByDedicatedParams) SetNamespace(namespace string)
- func (o *RefundPaymentOrderByDedicatedParams) SetPaymentOrderNo(paymentOrderNo string)
- func (o *RefundPaymentOrderByDedicatedParams) SetTimeout(timeout time.Duration)
- func (o *RefundPaymentOrderByDedicatedParams) WithBody(body *platformclientmodels.PaymentOrderRefund) *RefundPaymentOrderByDedicatedParams
- func (o *RefundPaymentOrderByDedicatedParams) WithContext(ctx context.Context) *RefundPaymentOrderByDedicatedParams
- func (o *RefundPaymentOrderByDedicatedParams) WithHTTPClient(client *http.Client) *RefundPaymentOrderByDedicatedParams
- func (o *RefundPaymentOrderByDedicatedParams) WithNamespace(namespace string) *RefundPaymentOrderByDedicatedParams
- func (o *RefundPaymentOrderByDedicatedParams) WithPaymentOrderNo(paymentOrderNo string) *RefundPaymentOrderByDedicatedParams
- func (o *RefundPaymentOrderByDedicatedParams) WithTimeout(timeout time.Duration) *RefundPaymentOrderByDedicatedParams
- func (o *RefundPaymentOrderByDedicatedParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type RefundPaymentOrderByDedicatedReader
- type RefundPaymentOrderByDedicatedUnprocessableEntity
- type SyncPaymentOrdersOK
- type SyncPaymentOrdersParams
- func NewSyncPaymentOrdersParams() *SyncPaymentOrdersParams
- func NewSyncPaymentOrdersParamsWithContext(ctx context.Context) *SyncPaymentOrdersParams
- func NewSyncPaymentOrdersParamsWithHTTPClient(client *http.Client) *SyncPaymentOrdersParams
- func NewSyncPaymentOrdersParamsWithTimeout(timeout time.Duration) *SyncPaymentOrdersParams
- func (o *SyncPaymentOrdersParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
- func (o *SyncPaymentOrdersParams) SetContext(ctx context.Context)
- func (o *SyncPaymentOrdersParams) SetEnd(end string)
- func (o *SyncPaymentOrdersParams) SetFlightId(flightId string)
- func (o *SyncPaymentOrdersParams) SetHTTPClient(client *http.Client)
- func (o *SyncPaymentOrdersParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
- func (o *SyncPaymentOrdersParams) SetNextEvaluatedKey(nextEvaluatedKey *string)
- func (o *SyncPaymentOrdersParams) SetStart(start string)
- func (o *SyncPaymentOrdersParams) SetTimeout(timeout time.Duration)
- func (o *SyncPaymentOrdersParams) WithContext(ctx context.Context) *SyncPaymentOrdersParams
- func (o *SyncPaymentOrdersParams) WithEnd(end string) *SyncPaymentOrdersParams
- func (o *SyncPaymentOrdersParams) WithHTTPClient(client *http.Client) *SyncPaymentOrdersParams
- func (o *SyncPaymentOrdersParams) WithNextEvaluatedKey(nextEvaluatedKey *string) *SyncPaymentOrdersParams
- func (o *SyncPaymentOrdersParams) WithStart(start string) *SyncPaymentOrdersParams
- func (o *SyncPaymentOrdersParams) WithTimeout(timeout time.Duration) *SyncPaymentOrdersParams
- func (o *SyncPaymentOrdersParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
- type SyncPaymentOrdersReader
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client for payment dedicated API
func (*Client) CreatePaymentOrderByDedicated
deprecated
func (a *Client) CreatePaymentOrderByDedicated(params *CreatePaymentOrderByDedicatedParams, authInfo runtime.ClientAuthInfoWriter) (*CreatePaymentOrderByDedicatedCreated, *CreatePaymentOrderByDedicatedBadRequest, *CreatePaymentOrderByDedicatedForbidden, *CreatePaymentOrderByDedicatedNotFound, *CreatePaymentOrderByDedicatedConflict, *CreatePaymentOrderByDedicatedUnprocessableEntity, error)
Deprecated: 2022-08-10 - Use CreatePaymentOrderByDedicatedShort instead.
CreatePaymentOrderByDedicated create payment order by dedicated server
[Not Supported Yet In Starter]
This API is used to create payment order from non justice service. e.g. from dedicated server, the result contains the payment station url.
Path Parameter: Parameter | Type | Required | Description -------------------------------------------------------------------|--------|----------|----------------------------------------------------------------------------------------------------------------- namespace | String | Yes | Namespace that payment order resides in, should be publisher namespace if it's a Steam like platform that share payment config cross namespaces, otherwise it's the game namespace Request Body Parameters: Parameter | Type | Required | Description ------------------|---------|----------|-------------------------------------------------------------------------------------------------- extOrderNo | String | Yes | External order number, it should be unique in invoker order system sku | String | No | Item identity targetNamespace | String | Yes | The game namespace targetUserId | String | Yes | User id for the order owner in game namespace extUserId | String | No | External user id, can be user character id price | int | Yes | price which should be greater than 0 title | String | Yes | Item title description | String | Yes | Item description currencyCode | String | No | Currency code, default is USD currencyNamespace | String | No | Currency namespace, default is publisher namespace region | String | No | Country of the user, will get from user info if not present language | String | No | Language of the user sandbox | Boolean | No | set to true will create sandbox order that not real paid for xsolla/alipay and will not validate price for wxpay. returnUrl | String | No | customized return url for redirect once payment finished, leave unset to use configuration in namespace notifyUrl | String | No | customized notify url for payment web hook, leave unset to use configuration in namespace customParameters | String | No | Custom parameters Request Body Example: { "extOrderNo": "123456789", "sku": "sku", "targetNamespace": "game1", "targetUserId": "94451623768940d58416ca33ca767ec3", "extUserId": "678", "title": "Frostmourne", "description": "Here was power. Here was despair", "price": 100, "region": "CN", "language": "zh-CN", "currencyCode": "USD", "currencyNamespace": "accelbyte" }
`
#### Payment Notification:
After user complete the payment, it will send notification to configured web hook, http status code should return 200 or 204 once you resolve notification successfully, otherwise payment system will retry notification in interval
Payment notification parameter: Parameter | Type | Required | Description -----------|--------|----------|------------------------------------------------ payload | String | Yes | Payment notification payload in json string sign | String | Yes | sha1 hex signature for payload and private key Payment notification parameter Example: { "payload": "{ "type": "payment", "nonceStr": "34c1dcf3eb58455eb161465bbfc0b590", "paymentOrderNo": "18081239088", "namespace": "accelbyte", "targetNamespace": "game1", "targetUserId": "94451623768940d58416ca33ca767ec3", "extOrderNo": "123456789", "sku": "sku", "extUserId": "678", "price": 100, "paymentProvider": "XSOLLA", "vat": 0, "salesTax": 0, "paymentProviderFee": 0, "paymentMethodFee": 0, "currency": { "currencyCode": "USD", "currencySymbol": "$", "currencyType": "REAL", "namespace": "accelbyte", "decimals": 2 }, "status": "CHARGED", "createdTime": "2018-07-28T00:39:16.274Z", "chargedTime": "2018-07-28T00:39:16.274Z" }", "sign":"e31fb92516cc9faaf50ad70343e1293acec6f3d5" }
`
Payment notification payload parameter list: Parameter | Type | Required | Description -------------------|----------|----------|-------------------------------------------------------------------------------------- type | String | Yes | Notification type: 'payment' paymentOrderNo | String | Yes | Payment system generated order number extOrderNo | String | No | External order number that passed by invoker namespace | String | Yes | Namespace that related payment order resides in targetNamespace | String | Yes | The game namespace targetUserId | String | Yes | The user id in game namespace sku | String | No | Item identify, it will return if pass it when create payment extUserId | String | No | External user id, can be character id, it will return if pass it when create payment price | int | Yes | Price of item paymentProvider | String | Yes | Payment provider, allowed values: xsolla/alipay/wxpay/wallet vat | int | Yes | Payment order VAT salesTax | int | Yes | Payment order sales tax paymentProviderFee | int | Yes | Payment provider fee paymentMethodFee | int | Yes | Payment method fee currency | Map | Yes | Payment order currency info status | String | Yes | Payment order status statusReason | String | No | Payment order status reason createdTime | Datetime | No | The time of the order created chargedTime | Datetime | No | The time of the order charged customParameters | Map | No | custom parameters, will return if pass it when create payment nonceStr | String | Yes | Random string, max length is 32, can be timestamp or uuid Currency info parameter list: Parameter | Type | Required | Description ---------------|--------|----------|----------------------------- currencyCode | String | Yes | Currency Code currencySymbol | String | Yes | Currency Symbol currencyType | String | Yes | Currency type(REAL/VIRTUAL) namespace | String | Yes | Currency namespace decimals | int | Yes | Currency decimals
#### Encryption Rule:
Concat payload json string and private key and then do sha1Hex.
#### Other detail info:
- Token type : client token
- Required permission : resource="ADMIN:NAMESPACE:{namespace}:PAYMENT", action=1 (CREATE)
- Optional permission(user with this permission will create sandbox order) : resource="SANDBOX", action=1 (CREATE)
- It will be forbidden while the target user is banned: PAYMENT_INITIATE or ORDER_AND_PAYMENT
- cross namespace allowed
- Returns : created payment order info
func (*Client) CreatePaymentOrderByDedicatedShort ¶ added in v0.8.0
func (a *Client) CreatePaymentOrderByDedicatedShort(params *CreatePaymentOrderByDedicatedParams, authInfo runtime.ClientAuthInfoWriter) (*CreatePaymentOrderByDedicatedCreated, error)
CreatePaymentOrderByDedicatedShort create payment order by dedicated server
[Not Supported Yet In Starter]
This API is used to create payment order from non justice service. e.g. from dedicated server, the result contains the payment station url.
Path Parameter: Parameter | Type | Required | Description -------------------------------------------------------------------|--------|----------|----------------------------------------------------------------------------------------------------------------- namespace | String | Yes | Namespace that payment order resides in, should be publisher namespace if it's a Steam like platform that share payment config cross namespaces, otherwise it's the game namespace Request Body Parameters: Parameter | Type | Required | Description ------------------|---------|----------|-------------------------------------------------------------------------------------------------- extOrderNo | String | Yes | External order number, it should be unique in invoker order system sku | String | No | Item identity targetNamespace | String | Yes | The game namespace targetUserId | String | Yes | User id for the order owner in game namespace extUserId | String | No | External user id, can be user character id price | int | Yes | price which should be greater than 0 title | String | Yes | Item title description | String | Yes | Item description currencyCode | String | No | Currency code, default is USD currencyNamespace | String | No | Currency namespace, default is publisher namespace region | String | No | Country of the user, will get from user info if not present language | String | No | Language of the user sandbox | Boolean | No | set to true will create sandbox order that not real paid for xsolla/alipay and will not validate price for wxpay. returnUrl | String | No | customized return url for redirect once payment finished, leave unset to use configuration in namespace notifyUrl | String | No | customized notify url for payment web hook, leave unset to use configuration in namespace customParameters | String | No | Custom parameters Request Body Example: { "extOrderNo": "123456789", "sku": "sku", "targetNamespace": "game1", "targetUserId": "94451623768940d58416ca33ca767ec3", "extUserId": "678", "title": "Frostmourne", "description": "Here was power. Here was despair", "price": 100, "region": "CN", "language": "zh-CN", "currencyCode": "USD", "currencyNamespace": "accelbyte" }
`
#### Payment Notification:
After user complete the payment, it will send notification to configured web hook, http status code should return 200 or 204 once you resolve notification successfully, otherwise payment system will retry notification in interval
Payment notification parameter: Parameter | Type | Required | Description -----------|--------|----------|------------------------------------------------ payload | String | Yes | Payment notification payload in json string sign | String | Yes | sha1 hex signature for payload and private key Payment notification parameter Example: { "payload": "{ "type": "payment", "nonceStr": "34c1dcf3eb58455eb161465bbfc0b590", "paymentOrderNo": "18081239088", "namespace": "accelbyte", "targetNamespace": "game1", "targetUserId": "94451623768940d58416ca33ca767ec3", "extOrderNo": "123456789", "sku": "sku", "extUserId": "678", "price": 100, "paymentProvider": "XSOLLA", "vat": 0, "salesTax": 0, "paymentProviderFee": 0, "paymentMethodFee": 0, "currency": { "currencyCode": "USD", "currencySymbol": "$", "currencyType": "REAL", "namespace": "accelbyte", "decimals": 2 }, "status": "CHARGED", "createdTime": "2018-07-28T00:39:16.274Z", "chargedTime": "2018-07-28T00:39:16.274Z" }", "sign":"e31fb92516cc9faaf50ad70343e1293acec6f3d5" }
`
Payment notification payload parameter list: Parameter | Type | Required | Description -------------------|----------|----------|-------------------------------------------------------------------------------------- type | String | Yes | Notification type: 'payment' paymentOrderNo | String | Yes | Payment system generated order number extOrderNo | String | No | External order number that passed by invoker namespace | String | Yes | Namespace that related payment order resides in targetNamespace | String | Yes | The game namespace targetUserId | String | Yes | The user id in game namespace sku | String | No | Item identify, it will return if pass it when create payment extUserId | String | No | External user id, can be character id, it will return if pass it when create payment price | int | Yes | Price of item paymentProvider | String | Yes | Payment provider, allowed values: xsolla/alipay/wxpay/wallet vat | int | Yes | Payment order VAT salesTax | int | Yes | Payment order sales tax paymentProviderFee | int | Yes | Payment provider fee paymentMethodFee | int | Yes | Payment method fee currency | Map | Yes | Payment order currency info status | String | Yes | Payment order status statusReason | String | No | Payment order status reason createdTime | Datetime | No | The time of the order created chargedTime | Datetime | No | The time of the order charged customParameters | Map | No | custom parameters, will return if pass it when create payment nonceStr | String | Yes | Random string, max length is 32, can be timestamp or uuid Currency info parameter list: Parameter | Type | Required | Description ---------------|--------|----------|----------------------------- currencyCode | String | Yes | Currency Code currencySymbol | String | Yes | Currency Symbol currencyType | String | Yes | Currency type(REAL/VIRTUAL) namespace | String | Yes | Currency namespace decimals | int | Yes | Currency decimals
#### Encryption Rule:
Concat payload json string and private key and then do sha1Hex.
#### Other detail info:
- Token type : client token
- Required permission : resource="ADMIN:NAMESPACE:{namespace}:PAYMENT", action=1 (CREATE)
- Optional permission(user with this permission will create sandbox order) : resource="SANDBOX", action=1 (CREATE)
- It will be forbidden while the target user is banned: PAYMENT_INITIATE or ORDER_AND_PAYMENT
- cross namespace allowed
- Returns : created payment order info
func (*Client) RefundPaymentOrderByDedicated
deprecated
func (a *Client) RefundPaymentOrderByDedicated(params *RefundPaymentOrderByDedicatedParams, authInfo runtime.ClientAuthInfoWriter) (*RefundPaymentOrderByDedicatedOK, *RefundPaymentOrderByDedicatedNoContent, *RefundPaymentOrderByDedicatedNotFound, *RefundPaymentOrderByDedicatedConflict, *RefundPaymentOrderByDedicatedUnprocessableEntity, error)
Deprecated: 2022-08-10 - Use RefundPaymentOrderByDedicatedShort instead.
RefundPaymentOrderByDedicated refund payment order by dedicated server
[Not Supported Yet In Starter]
This API is used to refund payment order by paymentOrderNo from non justice service. e.g. dedicated server.
- if the status field of response json is "REFUNDED", usually wallet paid, it indicates payment order already refunded
- if the status field of response json is "REFUNDING", usually real money paid, platform will send notification to registered notify url once refund successfully
Path Parameter:
Parameter | Type | Required | Description ---------------|--------|----------|----------------------------------------- namespace | String | Yes | Namespace that payment order resides in paymentOrderNo | String | Yes | Payment order number Request Body Parameters: Parameter | Type | Required | Description ------------|--------|----------|-------------------- description | String | Yes | Refund description Request Body Example: { "description": "Repeated item." }
`
#### Refund Notification:
It will send notification to configured web hook after refund successfully, http status code should return 200 or 204 once you resolve notification successfully, otherwise payment system will retry notification in interval
Refund notification parameter: Parameter | Type | Required | Description -----------|--------|----------|------------------------------------------------ payload | String | Yes | Refund notification payload in json string sign | String | Yes | sha1 hex signature for payload and private key Refund notification Example: { "payload": "{ "type": "payment", "nonceStr": "34c1dcf3eb58455eb161465bbfc0b590", "paymentOrderNo": "18081239088", "namespace": "accelbyte", "targetNamespace": "game1", "targetUserId": "94451623768940d58416ca33ca767ec3", "extOrderNo": "123456789", "sku": "sku", "extUserId": "678", "price": 100, "paymentProvider": "XSOLLA", "vat": 0, "salesTax": 0, "paymentProviderFee": 0, "paymentMethodFee": 0, "currency": { "currencyCode": "USD", "currencySymbol": "$", "currencyType": "REAL", "namespace": "accelbyte", "decimals": 2 }, "status": "REFUNDED", "createdTime": "2018-07-28T00:39:16.274Z", "chargedTime": "2018-07-28T00:39:16.274Z", "refundedTime": "2018-07-28T00:39:16.274Z" }", "sign":"e31fb92516cc9faaf50ad70343e1293acec6f3d5" }
`
Refund notification payload parameter list: Parameter | Type | Required | Description -------------------|----------|----------|-------------------------------------------------------------------------------------- type | String | Yes | Notification type: 'payment' paymentOrderNo | String | Yes | Payment system generated order number extOrderNo | String | No | External order number that passed by invoker namespace | String | Yes | Namespace that related payment order resides in targetNamespace | String | Yes | The game namespace targetUserId | String | Yes | The user id in game namespace sku | String | No | Item identify, it will return if pass it when create payment extUserId | String | No | External user id, can be character id, it will return if pass it when create payment price | int | Yes | Price of item paymentProvider | String | Yes | Payment provider: xsolla/alipay/wxpay/wallet vat | int | Yes | Payment order VAT salesTax | int | Yes | Payment order sales tax paymentProviderFee | int | Yes | Payment provider fee paymentMethodFee | int | Yes | Payment method fee currency | Map | Yes | Payment order currency info status | String | Yes | Payment order status statusReason | String | No | Payment order refund status reason createdTime | Datetime | No | The time of the order created chargedTime | Datetime | No | The time of the order charged refundedTime | Datetime | No | The time of the order refunded customParameters | Map | No | custom parameters, will return if pass it when create payment nonceStr | String | Yes | Random string, max length is 32,
Currency info parameter list:
Parameter | Type | Required | Description ---------------|--------|----------|----------------------------- currencyCode | String | Yes | Currency Code currencySymbol | String | Yes | Currency Symbol currencyType | String | Yes | Currency type(REAL/VIRTUAL) namespace | String | Yes | Currency namespace decimals | int | Yes | Currency decimals
#### Encryption Rule:
Concat payload json string and private key and then do sha1Hex.
#### Other detail info:
- Token type : client token
- Required permission : resource="ADMIN:NAMESPACE:{namespace}:PAYMENT", action=4 (UPDATE)
- cross namespace allowed
func (*Client) RefundPaymentOrderByDedicatedShort ¶ added in v0.8.0
func (a *Client) RefundPaymentOrderByDedicatedShort(params *RefundPaymentOrderByDedicatedParams, authInfo runtime.ClientAuthInfoWriter) (*RefundPaymentOrderByDedicatedOK, error)
RefundPaymentOrderByDedicatedShort refund payment order by dedicated server
[Not Supported Yet In Starter]
This API is used to refund payment order by paymentOrderNo from non justice service. e.g. dedicated server.
- if the status field of response json is "REFUNDED", usually wallet paid, it indicates payment order already refunded
- if the status field of response json is "REFUNDING", usually real money paid, platform will send notification to registered notify url once refund successfully
Path Parameter:
Parameter | Type | Required | Description ---------------|--------|----------|----------------------------------------- namespace | String | Yes | Namespace that payment order resides in paymentOrderNo | String | Yes | Payment order number Request Body Parameters: Parameter | Type | Required | Description ------------|--------|----------|-------------------- description | String | Yes | Refund description Request Body Example: { "description": "Repeated item." }
`
#### Refund Notification:
It will send notification to configured web hook after refund successfully, http status code should return 200 or 204 once you resolve notification successfully, otherwise payment system will retry notification in interval
Refund notification parameter: Parameter | Type | Required | Description -----------|--------|----------|------------------------------------------------ payload | String | Yes | Refund notification payload in json string sign | String | Yes | sha1 hex signature for payload and private key Refund notification Example: { "payload": "{ "type": "payment", "nonceStr": "34c1dcf3eb58455eb161465bbfc0b590", "paymentOrderNo": "18081239088", "namespace": "accelbyte", "targetNamespace": "game1", "targetUserId": "94451623768940d58416ca33ca767ec3", "extOrderNo": "123456789", "sku": "sku", "extUserId": "678", "price": 100, "paymentProvider": "XSOLLA", "vat": 0, "salesTax": 0, "paymentProviderFee": 0, "paymentMethodFee": 0, "currency": { "currencyCode": "USD", "currencySymbol": "$", "currencyType": "REAL", "namespace": "accelbyte", "decimals": 2 }, "status": "REFUNDED", "createdTime": "2018-07-28T00:39:16.274Z", "chargedTime": "2018-07-28T00:39:16.274Z", "refundedTime": "2018-07-28T00:39:16.274Z" }", "sign":"e31fb92516cc9faaf50ad70343e1293acec6f3d5" }
`
Refund notification payload parameter list: Parameter | Type | Required | Description -------------------|----------|----------|-------------------------------------------------------------------------------------- type | String | Yes | Notification type: 'payment' paymentOrderNo | String | Yes | Payment system generated order number extOrderNo | String | No | External order number that passed by invoker namespace | String | Yes | Namespace that related payment order resides in targetNamespace | String | Yes | The game namespace targetUserId | String | Yes | The user id in game namespace sku | String | No | Item identify, it will return if pass it when create payment extUserId | String | No | External user id, can be character id, it will return if pass it when create payment price | int | Yes | Price of item paymentProvider | String | Yes | Payment provider: xsolla/alipay/wxpay/wallet vat | int | Yes | Payment order VAT salesTax | int | Yes | Payment order sales tax paymentProviderFee | int | Yes | Payment provider fee paymentMethodFee | int | Yes | Payment method fee currency | Map | Yes | Payment order currency info status | String | Yes | Payment order status statusReason | String | No | Payment order refund status reason createdTime | Datetime | No | The time of the order created chargedTime | Datetime | No | The time of the order charged refundedTime | Datetime | No | The time of the order refunded customParameters | Map | No | custom parameters, will return if pass it when create payment nonceStr | String | Yes | Random string, max length is 32,
Currency info parameter list:
Parameter | Type | Required | Description ---------------|--------|----------|----------------------------- currencyCode | String | Yes | Currency Code currencySymbol | String | Yes | Currency Symbol currencyType | String | Yes | Currency type(REAL/VIRTUAL) namespace | String | Yes | Currency namespace decimals | int | Yes | Currency decimals
#### Encryption Rule:
Concat payload json string and private key and then do sha1Hex.
#### Other detail info:
- Token type : client token
- Required permission : resource="ADMIN:NAMESPACE:{namespace}:PAYMENT", action=4 (UPDATE)
- cross namespace allowed
func (*Client) SetTransport ¶
func (a *Client) SetTransport(transport runtime.ClientTransport)
SetTransport changes the transport on the client
func (*Client) SyncPaymentOrders
deprecated
func (a *Client) SyncPaymentOrders(params *SyncPaymentOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncPaymentOrdersOK, error)
Deprecated: 2022-08-10 - Use SyncPaymentOrdersShort instead.
SyncPaymentOrders sync payment orders
[Not Supported Yet In Starter] Sync payment orders. If response contains nextEvaluatedKey, please use it as query param in the next call to fetch the next batch, a batch has 1000 elements or less.
Other detail info:
- Required permission : resource="ADMIN:PAYMENT", action=2 (READ)
- Returns : sync payment orders
func (*Client) SyncPaymentOrdersShort ¶ added in v0.8.0
func (a *Client) SyncPaymentOrdersShort(params *SyncPaymentOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncPaymentOrdersOK, error)
SyncPaymentOrdersShort sync payment orders
[Not Supported Yet In Starter] Sync payment orders. If response contains nextEvaluatedKey, please use it as query param in the next call to fetch the next batch, a batch has 1000 elements or less.
Other detail info:
- Required permission : resource="ADMIN:PAYMENT", action=2 (READ)
- Returns : sync payment orders
type ClientService ¶
type ClientService interface { CreatePaymentOrderByDedicated(params *CreatePaymentOrderByDedicatedParams, authInfo runtime.ClientAuthInfoWriter) (*CreatePaymentOrderByDedicatedCreated, *CreatePaymentOrderByDedicatedBadRequest, *CreatePaymentOrderByDedicatedForbidden, *CreatePaymentOrderByDedicatedNotFound, *CreatePaymentOrderByDedicatedConflict, *CreatePaymentOrderByDedicatedUnprocessableEntity, error) CreatePaymentOrderByDedicatedShort(params *CreatePaymentOrderByDedicatedParams, authInfo runtime.ClientAuthInfoWriter) (*CreatePaymentOrderByDedicatedCreated, error) RefundPaymentOrderByDedicated(params *RefundPaymentOrderByDedicatedParams, authInfo runtime.ClientAuthInfoWriter) (*RefundPaymentOrderByDedicatedOK, *RefundPaymentOrderByDedicatedNoContent, *RefundPaymentOrderByDedicatedNotFound, *RefundPaymentOrderByDedicatedConflict, *RefundPaymentOrderByDedicatedUnprocessableEntity, error) RefundPaymentOrderByDedicatedShort(params *RefundPaymentOrderByDedicatedParams, authInfo runtime.ClientAuthInfoWriter) (*RefundPaymentOrderByDedicatedOK, error) SyncPaymentOrders(params *SyncPaymentOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncPaymentOrdersOK, error) SyncPaymentOrdersShort(params *SyncPaymentOrdersParams, authInfo runtime.ClientAuthInfoWriter) (*SyncPaymentOrdersOK, error) SetTransport(transport runtime.ClientTransport) }
ClientService is the interface for Client methods
func New ¶
func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService
New creates a new payment dedicated API client.
type CreatePaymentOrderByDedicatedBadRequest ¶
type CreatePaymentOrderByDedicatedBadRequest struct {
Payload *platformclientmodels.ErrorEntity
}
CreatePaymentOrderByDedicatedBadRequest handles this case with default header values.
<table><tr><td>ErrorCode</td><td>ErrorMessage</td></tr><tr><td>33121</td><td>Recurring payment failed with code: [{errorCode}] and message: [{errorMessage}] by provider: [{provider}]</td></tr><tr><td>33122</td><td>Subscription not match when create payment order</td></tr></table>
func NewCreatePaymentOrderByDedicatedBadRequest ¶
func NewCreatePaymentOrderByDedicatedBadRequest() *CreatePaymentOrderByDedicatedBadRequest
NewCreatePaymentOrderByDedicatedBadRequest creates a CreatePaymentOrderByDedicatedBadRequest with default headers values
func (*CreatePaymentOrderByDedicatedBadRequest) Error ¶
func (o *CreatePaymentOrderByDedicatedBadRequest) Error() string
func (*CreatePaymentOrderByDedicatedBadRequest) GetPayload ¶
func (o *CreatePaymentOrderByDedicatedBadRequest) GetPayload() *platformclientmodels.ErrorEntity
func (*CreatePaymentOrderByDedicatedBadRequest) ToJSONString ¶ added in v0.25.0
func (o *CreatePaymentOrderByDedicatedBadRequest) ToJSONString() string
type CreatePaymentOrderByDedicatedConflict ¶
type CreatePaymentOrderByDedicatedConflict struct {
Payload *platformclientmodels.ErrorEntity
}
CreatePaymentOrderByDedicatedConflict handles this case with default header values.
<table><tr><td>ErrorCode</td><td>ErrorMessage</td></tr><tr><td>20006</td><td>optimistic lock</td></tr><tr><td>33173</td><td>ExtOrderNo [{extOrderNo}] already exists in namespace [{namespace}]</td></tr></table>
func NewCreatePaymentOrderByDedicatedConflict ¶
func NewCreatePaymentOrderByDedicatedConflict() *CreatePaymentOrderByDedicatedConflict
NewCreatePaymentOrderByDedicatedConflict creates a CreatePaymentOrderByDedicatedConflict with default headers values
func (*CreatePaymentOrderByDedicatedConflict) Error ¶
func (o *CreatePaymentOrderByDedicatedConflict) Error() string
func (*CreatePaymentOrderByDedicatedConflict) GetPayload ¶
func (o *CreatePaymentOrderByDedicatedConflict) GetPayload() *platformclientmodels.ErrorEntity
func (*CreatePaymentOrderByDedicatedConflict) ToJSONString ¶ added in v0.25.0
func (o *CreatePaymentOrderByDedicatedConflict) ToJSONString() string
type CreatePaymentOrderByDedicatedCreated ¶
type CreatePaymentOrderByDedicatedCreated struct {
Payload *platformclientmodels.PaymentOrderCreateResult
}
CreatePaymentOrderByDedicatedCreated handles this case with default header values.
successful operation
func NewCreatePaymentOrderByDedicatedCreated ¶
func NewCreatePaymentOrderByDedicatedCreated() *CreatePaymentOrderByDedicatedCreated
NewCreatePaymentOrderByDedicatedCreated creates a CreatePaymentOrderByDedicatedCreated with default headers values
func (*CreatePaymentOrderByDedicatedCreated) Error ¶
func (o *CreatePaymentOrderByDedicatedCreated) Error() string
func (*CreatePaymentOrderByDedicatedCreated) GetPayload ¶
func (o *CreatePaymentOrderByDedicatedCreated) GetPayload() *platformclientmodels.PaymentOrderCreateResult
func (*CreatePaymentOrderByDedicatedCreated) ToJSONString ¶ added in v0.25.0
func (o *CreatePaymentOrderByDedicatedCreated) ToJSONString() string
type CreatePaymentOrderByDedicatedForbidden ¶
type CreatePaymentOrderByDedicatedForbidden struct {
Payload *platformclientmodels.ErrorEntity
}
CreatePaymentOrderByDedicatedForbidden handles this case with default header values.
<table><tr><td>ErrorCode</td><td>ErrorMessage</td></tr><tr><td>20016</td><td>action is banned</td></tr></table>
func NewCreatePaymentOrderByDedicatedForbidden ¶
func NewCreatePaymentOrderByDedicatedForbidden() *CreatePaymentOrderByDedicatedForbidden
NewCreatePaymentOrderByDedicatedForbidden creates a CreatePaymentOrderByDedicatedForbidden with default headers values
func (*CreatePaymentOrderByDedicatedForbidden) Error ¶
func (o *CreatePaymentOrderByDedicatedForbidden) Error() string
func (*CreatePaymentOrderByDedicatedForbidden) GetPayload ¶
func (o *CreatePaymentOrderByDedicatedForbidden) GetPayload() *platformclientmodels.ErrorEntity
func (*CreatePaymentOrderByDedicatedForbidden) ToJSONString ¶ added in v0.25.0
func (o *CreatePaymentOrderByDedicatedForbidden) ToJSONString() string
type CreatePaymentOrderByDedicatedNotFound ¶
type CreatePaymentOrderByDedicatedNotFound struct {
Payload *platformclientmodels.ErrorEntity
}
CreatePaymentOrderByDedicatedNotFound handles this case with default header values.
<table><tr><td>ErrorCode</td><td>ErrorMessage</td></tr><tr><td>36141</td><td>Currency [{currencyCode}] does not exist in namespace [{namespace}]</td></tr><tr><td>33141</td><td>Payment Order [{paymentOrderNo}] does not exist</td></tr><tr><td>33145</td><td>Recurring token not found</td></tr><tr><td>20008</td><td>user [{userId}] does not exist in namespace [{namespace}]</td></tr></table>
func NewCreatePaymentOrderByDedicatedNotFound ¶
func NewCreatePaymentOrderByDedicatedNotFound() *CreatePaymentOrderByDedicatedNotFound
NewCreatePaymentOrderByDedicatedNotFound creates a CreatePaymentOrderByDedicatedNotFound with default headers values
func (*CreatePaymentOrderByDedicatedNotFound) Error ¶
func (o *CreatePaymentOrderByDedicatedNotFound) Error() string
func (*CreatePaymentOrderByDedicatedNotFound) GetPayload ¶
func (o *CreatePaymentOrderByDedicatedNotFound) GetPayload() *platformclientmodels.ErrorEntity
func (*CreatePaymentOrderByDedicatedNotFound) ToJSONString ¶ added in v0.25.0
func (o *CreatePaymentOrderByDedicatedNotFound) ToJSONString() string
type CreatePaymentOrderByDedicatedParams ¶
type CreatePaymentOrderByDedicatedParams struct { /*RetryPolicy*/ RetryPolicy *utils.Retry /*Body*/ Body *platformclientmodels.ExternalPaymentOrderCreate /*Namespace*/ Namespace string AuthInfoWriter runtime.ClientAuthInfoWriter Context context.Context HTTPClient *http.Client // XFlightId is an optional parameter from this SDK XFlightId *string // contains filtered or unexported fields }
CreatePaymentOrderByDedicatedParams contains all the parameters to send to the API endpoint for the create payment order by dedicated operation typically these are written to a http.Request
func NewCreatePaymentOrderByDedicatedParams ¶
func NewCreatePaymentOrderByDedicatedParams() *CreatePaymentOrderByDedicatedParams
NewCreatePaymentOrderByDedicatedParams creates a new CreatePaymentOrderByDedicatedParams object with the default values initialized.
func NewCreatePaymentOrderByDedicatedParamsWithContext ¶
func NewCreatePaymentOrderByDedicatedParamsWithContext(ctx context.Context) *CreatePaymentOrderByDedicatedParams
NewCreatePaymentOrderByDedicatedParamsWithContext creates a new CreatePaymentOrderByDedicatedParams object with the default values initialized, and the ability to set a context for a request
func NewCreatePaymentOrderByDedicatedParamsWithHTTPClient ¶
func NewCreatePaymentOrderByDedicatedParamsWithHTTPClient(client *http.Client) *CreatePaymentOrderByDedicatedParams
NewCreatePaymentOrderByDedicatedParamsWithHTTPClient creates a new CreatePaymentOrderByDedicatedParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewCreatePaymentOrderByDedicatedParamsWithTimeout ¶
func NewCreatePaymentOrderByDedicatedParamsWithTimeout(timeout time.Duration) *CreatePaymentOrderByDedicatedParams
NewCreatePaymentOrderByDedicatedParamsWithTimeout creates a new CreatePaymentOrderByDedicatedParams object with the default values initialized, and the ability to set a timeout on a request
func (*CreatePaymentOrderByDedicatedParams) SetAuthInfoWriter ¶ added in v0.17.0
func (o *CreatePaymentOrderByDedicatedParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
SetAuthInfoWriter adds the authInfoWriter to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) SetBody ¶
func (o *CreatePaymentOrderByDedicatedParams) SetBody(body *platformclientmodels.ExternalPaymentOrderCreate)
SetBody adds the body to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) SetContext ¶
func (o *CreatePaymentOrderByDedicatedParams) SetContext(ctx context.Context)
SetContext adds the context to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) SetFlightId ¶ added in v0.63.0
func (o *CreatePaymentOrderByDedicatedParams) SetFlightId(flightId string)
SetFlightId adds the flightId as the header value for this specific endpoint
func (*CreatePaymentOrderByDedicatedParams) SetHTTPClient ¶
func (o *CreatePaymentOrderByDedicatedParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) SetHTTPClientTransport ¶ added in v0.19.0
func (o *CreatePaymentOrderByDedicatedParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
SetHTTPClient adds the HTTPClient Transport to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) SetNamespace ¶
func (o *CreatePaymentOrderByDedicatedParams) SetNamespace(namespace string)
SetNamespace adds the namespace to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) SetTimeout ¶
func (o *CreatePaymentOrderByDedicatedParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) WithBody ¶
func (o *CreatePaymentOrderByDedicatedParams) WithBody(body *platformclientmodels.ExternalPaymentOrderCreate) *CreatePaymentOrderByDedicatedParams
WithBody adds the body to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) WithContext ¶
func (o *CreatePaymentOrderByDedicatedParams) WithContext(ctx context.Context) *CreatePaymentOrderByDedicatedParams
WithContext adds the context to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) WithHTTPClient ¶
func (o *CreatePaymentOrderByDedicatedParams) WithHTTPClient(client *http.Client) *CreatePaymentOrderByDedicatedParams
WithHTTPClient adds the HTTPClient to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) WithNamespace ¶
func (o *CreatePaymentOrderByDedicatedParams) WithNamespace(namespace string) *CreatePaymentOrderByDedicatedParams
WithNamespace adds the namespace to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) WithTimeout ¶
func (o *CreatePaymentOrderByDedicatedParams) WithTimeout(timeout time.Duration) *CreatePaymentOrderByDedicatedParams
WithTimeout adds the timeout to the create payment order by dedicated params
func (*CreatePaymentOrderByDedicatedParams) WriteToRequest ¶
func (o *CreatePaymentOrderByDedicatedParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type CreatePaymentOrderByDedicatedReader ¶
type CreatePaymentOrderByDedicatedReader struct {
// contains filtered or unexported fields
}
CreatePaymentOrderByDedicatedReader is a Reader for the CreatePaymentOrderByDedicated structure.
func (*CreatePaymentOrderByDedicatedReader) ReadResponse ¶
func (o *CreatePaymentOrderByDedicatedReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type CreatePaymentOrderByDedicatedUnprocessableEntity ¶
type CreatePaymentOrderByDedicatedUnprocessableEntity struct {
Payload *platformclientmodels.ValidationErrorEntity
}
CreatePaymentOrderByDedicatedUnprocessableEntity handles this case with default header values.
<table><tr><td>ErrorCode</td><td>ErrorMessage</td></tr><tr><td>20002</td><td>validation error</td></tr></table>
func NewCreatePaymentOrderByDedicatedUnprocessableEntity ¶
func NewCreatePaymentOrderByDedicatedUnprocessableEntity() *CreatePaymentOrderByDedicatedUnprocessableEntity
NewCreatePaymentOrderByDedicatedUnprocessableEntity creates a CreatePaymentOrderByDedicatedUnprocessableEntity with default headers values
func (*CreatePaymentOrderByDedicatedUnprocessableEntity) Error ¶
func (o *CreatePaymentOrderByDedicatedUnprocessableEntity) Error() string
func (*CreatePaymentOrderByDedicatedUnprocessableEntity) GetPayload ¶
func (o *CreatePaymentOrderByDedicatedUnprocessableEntity) GetPayload() *platformclientmodels.ValidationErrorEntity
func (*CreatePaymentOrderByDedicatedUnprocessableEntity) ToJSONString ¶ added in v0.25.0
func (o *CreatePaymentOrderByDedicatedUnprocessableEntity) ToJSONString() string
type RefundPaymentOrderByDedicatedConflict ¶
type RefundPaymentOrderByDedicatedConflict struct {
Payload *platformclientmodels.ErrorEntity
}
RefundPaymentOrderByDedicatedConflict handles this case with default header values.
<table><tr><td>ErrorCode</td><td>ErrorMessage</td></tr><tr><td>33172</td><td>Payment order [{paymentOrderNo}] is not refundable</td></tr></table>
func NewRefundPaymentOrderByDedicatedConflict ¶
func NewRefundPaymentOrderByDedicatedConflict() *RefundPaymentOrderByDedicatedConflict
NewRefundPaymentOrderByDedicatedConflict creates a RefundPaymentOrderByDedicatedConflict with default headers values
func (*RefundPaymentOrderByDedicatedConflict) Error ¶
func (o *RefundPaymentOrderByDedicatedConflict) Error() string
func (*RefundPaymentOrderByDedicatedConflict) GetPayload ¶
func (o *RefundPaymentOrderByDedicatedConflict) GetPayload() *platformclientmodels.ErrorEntity
func (*RefundPaymentOrderByDedicatedConflict) ToJSONString ¶ added in v0.25.0
func (o *RefundPaymentOrderByDedicatedConflict) ToJSONString() string
type RefundPaymentOrderByDedicatedNoContent ¶
type RefundPaymentOrderByDedicatedNoContent struct { }
RefundPaymentOrderByDedicatedNoContent handles this case with default header values.
Refund successfully
func NewRefundPaymentOrderByDedicatedNoContent ¶
func NewRefundPaymentOrderByDedicatedNoContent() *RefundPaymentOrderByDedicatedNoContent
NewRefundPaymentOrderByDedicatedNoContent creates a RefundPaymentOrderByDedicatedNoContent with default headers values
func (*RefundPaymentOrderByDedicatedNoContent) Error ¶
func (o *RefundPaymentOrderByDedicatedNoContent) Error() string
type RefundPaymentOrderByDedicatedNotFound ¶
type RefundPaymentOrderByDedicatedNotFound struct {
Payload *platformclientmodels.ErrorEntity
}
RefundPaymentOrderByDedicatedNotFound handles this case with default header values.
<table><tr><td>ErrorCode</td><td>ErrorMessage</td></tr><tr><td>33141</td><td>Payment Order [{paymentOrderNo}] does not exist</td></tr></table>
func NewRefundPaymentOrderByDedicatedNotFound ¶
func NewRefundPaymentOrderByDedicatedNotFound() *RefundPaymentOrderByDedicatedNotFound
NewRefundPaymentOrderByDedicatedNotFound creates a RefundPaymentOrderByDedicatedNotFound with default headers values
func (*RefundPaymentOrderByDedicatedNotFound) Error ¶
func (o *RefundPaymentOrderByDedicatedNotFound) Error() string
func (*RefundPaymentOrderByDedicatedNotFound) GetPayload ¶
func (o *RefundPaymentOrderByDedicatedNotFound) GetPayload() *platformclientmodels.ErrorEntity
func (*RefundPaymentOrderByDedicatedNotFound) ToJSONString ¶ added in v0.25.0
func (o *RefundPaymentOrderByDedicatedNotFound) ToJSONString() string
type RefundPaymentOrderByDedicatedOK ¶
type RefundPaymentOrderByDedicatedOK struct {
Payload *platformclientmodels.PaymentOrderRefundResult
}
RefundPaymentOrderByDedicatedOK handles this case with default header values.
successful operation
func NewRefundPaymentOrderByDedicatedOK ¶
func NewRefundPaymentOrderByDedicatedOK() *RefundPaymentOrderByDedicatedOK
NewRefundPaymentOrderByDedicatedOK creates a RefundPaymentOrderByDedicatedOK with default headers values
func (*RefundPaymentOrderByDedicatedOK) Error ¶
func (o *RefundPaymentOrderByDedicatedOK) Error() string
func (*RefundPaymentOrderByDedicatedOK) GetPayload ¶
func (o *RefundPaymentOrderByDedicatedOK) GetPayload() *platformclientmodels.PaymentOrderRefundResult
func (*RefundPaymentOrderByDedicatedOK) ToJSONString ¶ added in v0.25.0
func (o *RefundPaymentOrderByDedicatedOK) ToJSONString() string
type RefundPaymentOrderByDedicatedParams ¶
type RefundPaymentOrderByDedicatedParams struct { /*RetryPolicy*/ RetryPolicy *utils.Retry /*Body*/ Body *platformclientmodels.PaymentOrderRefund /*Namespace*/ Namespace string /*PaymentOrderNo*/ PaymentOrderNo string AuthInfoWriter runtime.ClientAuthInfoWriter Context context.Context HTTPClient *http.Client // XFlightId is an optional parameter from this SDK XFlightId *string // contains filtered or unexported fields }
RefundPaymentOrderByDedicatedParams contains all the parameters to send to the API endpoint for the refund payment order by dedicated operation typically these are written to a http.Request
func NewRefundPaymentOrderByDedicatedParams ¶
func NewRefundPaymentOrderByDedicatedParams() *RefundPaymentOrderByDedicatedParams
NewRefundPaymentOrderByDedicatedParams creates a new RefundPaymentOrderByDedicatedParams object with the default values initialized.
func NewRefundPaymentOrderByDedicatedParamsWithContext ¶
func NewRefundPaymentOrderByDedicatedParamsWithContext(ctx context.Context) *RefundPaymentOrderByDedicatedParams
NewRefundPaymentOrderByDedicatedParamsWithContext creates a new RefundPaymentOrderByDedicatedParams object with the default values initialized, and the ability to set a context for a request
func NewRefundPaymentOrderByDedicatedParamsWithHTTPClient ¶
func NewRefundPaymentOrderByDedicatedParamsWithHTTPClient(client *http.Client) *RefundPaymentOrderByDedicatedParams
NewRefundPaymentOrderByDedicatedParamsWithHTTPClient creates a new RefundPaymentOrderByDedicatedParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewRefundPaymentOrderByDedicatedParamsWithTimeout ¶
func NewRefundPaymentOrderByDedicatedParamsWithTimeout(timeout time.Duration) *RefundPaymentOrderByDedicatedParams
NewRefundPaymentOrderByDedicatedParamsWithTimeout creates a new RefundPaymentOrderByDedicatedParams object with the default values initialized, and the ability to set a timeout on a request
func (*RefundPaymentOrderByDedicatedParams) SetAuthInfoWriter ¶ added in v0.17.0
func (o *RefundPaymentOrderByDedicatedParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
SetAuthInfoWriter adds the authInfoWriter to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) SetBody ¶
func (o *RefundPaymentOrderByDedicatedParams) SetBody(body *platformclientmodels.PaymentOrderRefund)
SetBody adds the body to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) SetContext ¶
func (o *RefundPaymentOrderByDedicatedParams) SetContext(ctx context.Context)
SetContext adds the context to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) SetFlightId ¶ added in v0.63.0
func (o *RefundPaymentOrderByDedicatedParams) SetFlightId(flightId string)
SetFlightId adds the flightId as the header value for this specific endpoint
func (*RefundPaymentOrderByDedicatedParams) SetHTTPClient ¶
func (o *RefundPaymentOrderByDedicatedParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) SetHTTPClientTransport ¶ added in v0.19.0
func (o *RefundPaymentOrderByDedicatedParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
SetHTTPClient adds the HTTPClient Transport to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) SetNamespace ¶
func (o *RefundPaymentOrderByDedicatedParams) SetNamespace(namespace string)
SetNamespace adds the namespace to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) SetPaymentOrderNo ¶
func (o *RefundPaymentOrderByDedicatedParams) SetPaymentOrderNo(paymentOrderNo string)
SetPaymentOrderNo adds the paymentOrderNo to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) SetTimeout ¶
func (o *RefundPaymentOrderByDedicatedParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) WithBody ¶
func (o *RefundPaymentOrderByDedicatedParams) WithBody(body *platformclientmodels.PaymentOrderRefund) *RefundPaymentOrderByDedicatedParams
WithBody adds the body to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) WithContext ¶
func (o *RefundPaymentOrderByDedicatedParams) WithContext(ctx context.Context) *RefundPaymentOrderByDedicatedParams
WithContext adds the context to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) WithHTTPClient ¶
func (o *RefundPaymentOrderByDedicatedParams) WithHTTPClient(client *http.Client) *RefundPaymentOrderByDedicatedParams
WithHTTPClient adds the HTTPClient to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) WithNamespace ¶
func (o *RefundPaymentOrderByDedicatedParams) WithNamespace(namespace string) *RefundPaymentOrderByDedicatedParams
WithNamespace adds the namespace to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) WithPaymentOrderNo ¶
func (o *RefundPaymentOrderByDedicatedParams) WithPaymentOrderNo(paymentOrderNo string) *RefundPaymentOrderByDedicatedParams
WithPaymentOrderNo adds the paymentOrderNo to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) WithTimeout ¶
func (o *RefundPaymentOrderByDedicatedParams) WithTimeout(timeout time.Duration) *RefundPaymentOrderByDedicatedParams
WithTimeout adds the timeout to the refund payment order by dedicated params
func (*RefundPaymentOrderByDedicatedParams) WriteToRequest ¶
func (o *RefundPaymentOrderByDedicatedParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type RefundPaymentOrderByDedicatedReader ¶
type RefundPaymentOrderByDedicatedReader struct {
// contains filtered or unexported fields
}
RefundPaymentOrderByDedicatedReader is a Reader for the RefundPaymentOrderByDedicated structure.
func (*RefundPaymentOrderByDedicatedReader) ReadResponse ¶
func (o *RefundPaymentOrderByDedicatedReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.
type RefundPaymentOrderByDedicatedUnprocessableEntity ¶
type RefundPaymentOrderByDedicatedUnprocessableEntity struct {
Payload *platformclientmodels.ValidationErrorEntity
}
RefundPaymentOrderByDedicatedUnprocessableEntity handles this case with default header values.
<table><tr><td>ErrorCode</td><td>ErrorMessage</td></tr><tr><td>20002</td><td>validation error</td></tr></table>
func NewRefundPaymentOrderByDedicatedUnprocessableEntity ¶
func NewRefundPaymentOrderByDedicatedUnprocessableEntity() *RefundPaymentOrderByDedicatedUnprocessableEntity
NewRefundPaymentOrderByDedicatedUnprocessableEntity creates a RefundPaymentOrderByDedicatedUnprocessableEntity with default headers values
func (*RefundPaymentOrderByDedicatedUnprocessableEntity) Error ¶
func (o *RefundPaymentOrderByDedicatedUnprocessableEntity) Error() string
func (*RefundPaymentOrderByDedicatedUnprocessableEntity) GetPayload ¶
func (o *RefundPaymentOrderByDedicatedUnprocessableEntity) GetPayload() *platformclientmodels.ValidationErrorEntity
func (*RefundPaymentOrderByDedicatedUnprocessableEntity) ToJSONString ¶ added in v0.25.0
func (o *RefundPaymentOrderByDedicatedUnprocessableEntity) ToJSONString() string
type SyncPaymentOrdersOK ¶
type SyncPaymentOrdersOK struct {
Payload *platformclientmodels.PaymentOrderSyncResult
}
SyncPaymentOrdersOK handles this case with default header values.
successful operation
func NewSyncPaymentOrdersOK ¶
func NewSyncPaymentOrdersOK() *SyncPaymentOrdersOK
NewSyncPaymentOrdersOK creates a SyncPaymentOrdersOK with default headers values
func (*SyncPaymentOrdersOK) Error ¶
func (o *SyncPaymentOrdersOK) Error() string
func (*SyncPaymentOrdersOK) GetPayload ¶
func (o *SyncPaymentOrdersOK) GetPayload() *platformclientmodels.PaymentOrderSyncResult
func (*SyncPaymentOrdersOK) ToJSONString ¶ added in v0.25.0
func (o *SyncPaymentOrdersOK) ToJSONString() string
type SyncPaymentOrdersParams ¶
type SyncPaymentOrdersParams struct { /*RetryPolicy*/ RetryPolicy *utils.Retry /*NextEvaluatedKey*/ NextEvaluatedKey *string /*End exclude ISODateTimeFormat no millis like yyyy-MM-dd'T'HH:mm:ssZZ */ End string /*Start include ISODateTimeFormat no millis like yyyy-MM-dd'T'HH:mm:ssZZ */ Start string AuthInfoWriter runtime.ClientAuthInfoWriter Context context.Context HTTPClient *http.Client // XFlightId is an optional parameter from this SDK XFlightId *string // contains filtered or unexported fields }
SyncPaymentOrdersParams contains all the parameters to send to the API endpoint for the sync payment orders operation typically these are written to a http.Request
func NewSyncPaymentOrdersParams ¶
func NewSyncPaymentOrdersParams() *SyncPaymentOrdersParams
NewSyncPaymentOrdersParams creates a new SyncPaymentOrdersParams object with the default values initialized.
func NewSyncPaymentOrdersParamsWithContext ¶
func NewSyncPaymentOrdersParamsWithContext(ctx context.Context) *SyncPaymentOrdersParams
NewSyncPaymentOrdersParamsWithContext creates a new SyncPaymentOrdersParams object with the default values initialized, and the ability to set a context for a request
func NewSyncPaymentOrdersParamsWithHTTPClient ¶
func NewSyncPaymentOrdersParamsWithHTTPClient(client *http.Client) *SyncPaymentOrdersParams
NewSyncPaymentOrdersParamsWithHTTPClient creates a new SyncPaymentOrdersParams object with the default values initialized, and the ability to set a custom HTTPClient for a request
func NewSyncPaymentOrdersParamsWithTimeout ¶
func NewSyncPaymentOrdersParamsWithTimeout(timeout time.Duration) *SyncPaymentOrdersParams
NewSyncPaymentOrdersParamsWithTimeout creates a new SyncPaymentOrdersParams object with the default values initialized, and the ability to set a timeout on a request
func (*SyncPaymentOrdersParams) SetAuthInfoWriter ¶ added in v0.17.0
func (o *SyncPaymentOrdersParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)
SetAuthInfoWriter adds the authInfoWriter to the sync payment orders params
func (*SyncPaymentOrdersParams) SetContext ¶
func (o *SyncPaymentOrdersParams) SetContext(ctx context.Context)
SetContext adds the context to the sync payment orders params
func (*SyncPaymentOrdersParams) SetEnd ¶
func (o *SyncPaymentOrdersParams) SetEnd(end string)
SetEnd adds the end to the sync payment orders params
func (*SyncPaymentOrdersParams) SetFlightId ¶ added in v0.63.0
func (o *SyncPaymentOrdersParams) SetFlightId(flightId string)
SetFlightId adds the flightId as the header value for this specific endpoint
func (*SyncPaymentOrdersParams) SetHTTPClient ¶
func (o *SyncPaymentOrdersParams) SetHTTPClient(client *http.Client)
SetHTTPClient adds the HTTPClient to the sync payment orders params
func (*SyncPaymentOrdersParams) SetHTTPClientTransport ¶ added in v0.19.0
func (o *SyncPaymentOrdersParams) SetHTTPClientTransport(roundTripper http.RoundTripper)
SetHTTPClient adds the HTTPClient Transport to the sync payment orders params
func (*SyncPaymentOrdersParams) SetNextEvaluatedKey ¶
func (o *SyncPaymentOrdersParams) SetNextEvaluatedKey(nextEvaluatedKey *string)
SetNextEvaluatedKey adds the nextEvaluatedKey to the sync payment orders params
func (*SyncPaymentOrdersParams) SetStart ¶
func (o *SyncPaymentOrdersParams) SetStart(start string)
SetStart adds the start to the sync payment orders params
func (*SyncPaymentOrdersParams) SetTimeout ¶
func (o *SyncPaymentOrdersParams) SetTimeout(timeout time.Duration)
SetTimeout adds the timeout to the sync payment orders params
func (*SyncPaymentOrdersParams) WithContext ¶
func (o *SyncPaymentOrdersParams) WithContext(ctx context.Context) *SyncPaymentOrdersParams
WithContext adds the context to the sync payment orders params
func (*SyncPaymentOrdersParams) WithEnd ¶
func (o *SyncPaymentOrdersParams) WithEnd(end string) *SyncPaymentOrdersParams
WithEnd adds the end to the sync payment orders params
func (*SyncPaymentOrdersParams) WithHTTPClient ¶
func (o *SyncPaymentOrdersParams) WithHTTPClient(client *http.Client) *SyncPaymentOrdersParams
WithHTTPClient adds the HTTPClient to the sync payment orders params
func (*SyncPaymentOrdersParams) WithNextEvaluatedKey ¶
func (o *SyncPaymentOrdersParams) WithNextEvaluatedKey(nextEvaluatedKey *string) *SyncPaymentOrdersParams
WithNextEvaluatedKey adds the nextEvaluatedKey to the sync payment orders params
func (*SyncPaymentOrdersParams) WithStart ¶
func (o *SyncPaymentOrdersParams) WithStart(start string) *SyncPaymentOrdersParams
WithStart adds the start to the sync payment orders params
func (*SyncPaymentOrdersParams) WithTimeout ¶
func (o *SyncPaymentOrdersParams) WithTimeout(timeout time.Duration) *SyncPaymentOrdersParams
WithTimeout adds the timeout to the sync payment orders params
func (*SyncPaymentOrdersParams) WriteToRequest ¶
func (o *SyncPaymentOrdersParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error
WriteToRequest writes these params to a swagger request
type SyncPaymentOrdersReader ¶
type SyncPaymentOrdersReader struct {
// contains filtered or unexported fields
}
SyncPaymentOrdersReader is a Reader for the SyncPaymentOrders structure.
func (*SyncPaymentOrdersReader) ReadResponse ¶
func (o *SyncPaymentOrdersReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)
ReadResponse reads a server response into the received o.