PayNow

Chargebacks

Get chargebacks

GEThttps://api.paynow.gg/v1/stores/{storeId}/chargebacks

Retrieves all chargebacks and pre-chargeback inquiries for the specified store using the filter specified.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
The ID of the store to retrieve chargebacks for.
Query parameters
limitintegerOptional
The maximum number of items to return in a single request.
afterFlakeIdOptional
Returns items after the specified ID. Used for forward pagination through results.
beforeFlakeIdOptional
Returns items before the specified ID. Used for backward pagination through results.
ascbooleanOptional
Determines the sort order of returned items. When true, items are returned in ascending order. When false, items are returned in descending order.
order_idFlakeIdOptional
Filter by order ID.
customer_idFlakeIdOptional
Filter by customer ID.
statusenum[]Optional
Filter by chargeback statuses.
stageenumOptional
Filter by chargeback stage.
Response
200OKStoreChargebackDto[]
Represents a chargeback or pre-chargeback inquiry raised against a payment.
Show fields
idFlakeIdRequired
created_atstringRequired
The date and time the chargeback was opened.
currencystringRequired
The three-letter ISO currency code of 'disputed_amount', in lowercase.
customer_idFlakeIdRequired
disputed_amountintegerRequired
The disputed amount, in the smallest currency unit.
is_refundablebooleanRequired
Whether the payment can still be refunded.
network_case_typeenumRequired
Specifies the type of case the card network opened for the chargeback.
Possible enum values
  • unspecified

    No card network case type is available, for example for PayPal disputes.

  • chargeback

    A formal chargeback where the disputed funds are withdrawn.

  • inquiry

    A pre-chargeback inquiry from the issuer.

  • compliance

    A network compliance case filed outside the regular dispute process.

  • block

    The network blocked the dispute before it became a chargeback. No funds move.

  • resolution

    The dispute was resolved by automatically refunding the customer.

order_idFlakeIdRequired
payment_idFlakeIdRequired
reasonenumRequired
Specifies the reason the customer gave for the chargeback.
Possible enum values
  • invalid

    The reason is unknown.

  • product_not_received

    The customer says the product or service was not received.

  • product_not_as_described

    The customer says the product or service was not as described.

  • unauthorized

    The customer says they did not authorize the payment.

  • credit_not_processed

    The customer says a promised refund or credit was not processed.

  • duplicate_charge

    The customer says they were charged more than once.

  • incorrect_amount

    The customer says they were charged the wrong amount.

  • subscription_canceled

    The customer says they were charged after canceling a subscription.

  • general

    Any other reason.

stageenumRequired
Specifies the stage of a chargeback.
Possible enum values
  • invalid

    The stage is unknown.

  • inquiry

    A pre-chargeback inquiry. No funds are withdrawn yet, and a refund may resolve it.

  • claim

    A formal claim where the disputed funds are at stake.

statusenumRequired
Specifies the status of a chargeback.
Possible enum values
  • invalid

    The status is unknown.

  • needs_response

    The chargeback is open and awaiting a response.

  • under_review

    A response was submitted and the chargeback is being reviewed.

  • won

    The chargeback was resolved in the store's favor.

  • lost

    The chargeback was resolved in the customer's favor.

  • closed

    The inquiry was closed without escalating to a chargeback.

  • prevented

    The chargeback was prevented before it was filed, see 'network_case_type' for how.

store_idFlakeIdRequired
closed_atstringOptional
The date and time the chargeback was closed, if it is closed.
escalated_atstringOptional
The date and time the inquiry escalated to a claim, if it did.
network_reason_codestringOptional
The card network's reason code for the chargeback, if available.
response_deadline_atstringOptional
The date and time by which a response must be submitted, if one is required.

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/chargebacks" \
  -H "Authorization: APIKey TOKEN"
Response200
[
  {
    "id": "411486491630370816",
    "created_at": "2024-01-01T00:00:00Z",
    "currency": "string",
    "customer_id": "411486491630370816",
    "disputed_amount": 0,
    "is_refundable": true,
    "network_case_type": "unspecified",
    "order_id": "411486491630370816",
    "payment_id": "411486491630370816",
    "reason": "invalid",
    "stage": "invalid",
    "status": "invalid",
    "store_id": "411486491630370816",
    "closed_at": "2024-01-01T00:00:00Z",
    "escalated_at": "2024-01-01T00:00:00Z",
    "network_reason_code": "string",
    "response_deadline_at": "2024-01-01T00:00:00Z"
  }
]

Get chargeback by ID

GEThttps://api.paynow.gg/v1/stores/{storeId}/chargebacks/{chargebackId}

Retrieves a chargeback or pre-chargeback inquiry by an ID.

Headers
AuthorizationAPI KeyRequired
Authentication token for this request, sent as Authorization: APIKey TOKEN.
Path parameters
storeIdFlakeIdRequired
The ID of the store to retrieve the chargeback for.
chargebackIdFlakeIdRequired
The ID of the chargeback.
Response
200OKStoreChargebackDto
Represents a chargeback or pre-chargeback inquiry raised against a payment.
Show fields
idFlakeIdRequired
created_atstringRequired
The date and time the chargeback was opened.
currencystringRequired
The three-letter ISO currency code of 'disputed_amount', in lowercase.
customer_idFlakeIdRequired
disputed_amountintegerRequired
The disputed amount, in the smallest currency unit.
is_refundablebooleanRequired
Whether the payment can still be refunded.
network_case_typeenumRequired
Specifies the type of case the card network opened for the chargeback.
Possible enum values
  • unspecified

    No card network case type is available, for example for PayPal disputes.

  • chargeback

    A formal chargeback where the disputed funds are withdrawn.

  • inquiry

    A pre-chargeback inquiry from the issuer.

  • compliance

    A network compliance case filed outside the regular dispute process.

  • block

    The network blocked the dispute before it became a chargeback. No funds move.

  • resolution

    The dispute was resolved by automatically refunding the customer.

order_idFlakeIdRequired
payment_idFlakeIdRequired
reasonenumRequired
Specifies the reason the customer gave for the chargeback.
Possible enum values
  • invalid

    The reason is unknown.

  • product_not_received

    The customer says the product or service was not received.

  • product_not_as_described

    The customer says the product or service was not as described.

  • unauthorized

    The customer says they did not authorize the payment.

  • credit_not_processed

    The customer says a promised refund or credit was not processed.

  • duplicate_charge

    The customer says they were charged more than once.

  • incorrect_amount

    The customer says they were charged the wrong amount.

  • subscription_canceled

    The customer says they were charged after canceling a subscription.

  • general

    Any other reason.

stageenumRequired
Specifies the stage of a chargeback.
Possible enum values
  • invalid

    The stage is unknown.

  • inquiry

    A pre-chargeback inquiry. No funds are withdrawn yet, and a refund may resolve it.

  • claim

    A formal claim where the disputed funds are at stake.

statusenumRequired
Specifies the status of a chargeback.
Possible enum values
  • invalid

    The status is unknown.

  • needs_response

    The chargeback is open and awaiting a response.

  • under_review

    A response was submitted and the chargeback is being reviewed.

  • won

    The chargeback was resolved in the store's favor.

  • lost

    The chargeback was resolved in the customer's favor.

  • closed

    The inquiry was closed without escalating to a chargeback.

  • prevented

    The chargeback was prevented before it was filed, see 'network_case_type' for how.

store_idFlakeIdRequired
closed_atstringOptional
The date and time the chargeback was closed, if it is closed.
escalated_atstringOptional
The date and time the inquiry escalated to a claim, if it did.
network_reason_codestringOptional
The card network's reason code for the chargeback, if available.
response_deadline_atstringOptional
The date and time by which a response must be submitted, if one is required.

Failed requests return a PayNowError body. See the error response guide.

curl -X GET "https://api.paynow.gg/v1/stores/{storeId}/chargebacks/{chargebackId}" \
  -H "Authorization: APIKey TOKEN"
Response200
{
  "id": "411486491630370816",
  "created_at": "2024-01-01T00:00:00Z",
  "currency": "string",
  "customer_id": "411486491630370816",
  "disputed_amount": 0,
  "is_refundable": true,
  "network_case_type": "unspecified",
  "order_id": "411486491630370816",
  "payment_id": "411486491630370816",
  "reason": "invalid",
  "stage": "invalid",
  "status": "invalid",
  "store_id": "411486491630370816",
  "closed_at": "2024-01-01T00:00:00Z",
  "escalated_at": "2024-01-01T00:00:00Z",
  "network_reason_code": "string",
  "response_deadline_at": "2024-01-01T00:00:00Z"
}