WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Events
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
      POST
    • Retrieve a refund
      GET
  • Webhooks
    • Create a Webhook
      POST
    • List All Webhooks
      GET
    • Retrieve a Webhook
      GET
    • Delete a Webhook
      DELETE
    • Update a Webhook
      POST
  • Events
    • Types of events
    • Retrieve an event
      GET
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • Payouts
    • Beneficiary
      • Create a beneficiary
      • Retrieve a beneficiary
      • List all beneficiaries
      • Update a beneficiary
      • Delete a beneficiary
    • Payouts
      • Create a payout
      • Retrieve a Payout
      • Update a Payout
      • List All Payouts
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
    • Update a payment link
    • Retrieve payment link
    • List all payment links
    • Retrieve a payment link's line items
  • Checkout
    • Create a Session
    • Expire a Session
    • Retreive a Session
    • List All Checkout Sessions
    • Retrieve a Checkout Session's line items
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • Setup Intents
      • Create a SetupIntent
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
    • Retrieve an invoice
    • Finalize an invoice
    • Send an invoice for manual payment
    • Delete a draft invoice
    • Void an invoice
    • List all invoices
    • Pay an invoice
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
    • Retrieve a subscription item
    • Delete a subscription item
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
    • Update a promotion code
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Events

Retrieve an event

GET
/v1/events/{id }

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Path Params
id
string 
required
Header Params
Accept
string 
required
Default:
application/json
Content-Type
string 
required
Default:
application/json

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://apitest.wooshpay.com/v1/events/' \
--header 'Accept;' \
--header 'Authorization: Basic Og=='

Responses

🟢200OK
application/json
Body
id
string 
optional
Unique identifier for the object, like "evt_xxxx".
object
string 
optional
"event"
api_version
string 
optional
The API version used to render data.
created
integer 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
data
object 
optional
Object containing data associated with the event.
livemode
boolean 
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
request
object 
optional
Information on the API request that instigated the event. request.id (string) ID of the API request that caused the event. If null, the event was automatic request.idempotency_key (string). The idempotency key transmitted during the request, if any.
id
string 
optional
ID of the API request that caused the event. If null, the event was automatic
idempotency_key
string 
optional
The idempotency key transmitted during the request, if any.
type
string 
optional
Description of the event.
Example
{
    "id": "evt_1593219809108033536",
    "object": "event",
    "created": 1668688178000,
    "data": {
        "object": {
            "id": "dp_1585839983195983872",
            "object": "dispute",
            "created": 1666928687870,
            "amount": 66,
            "currency": "USD",
            "status": "lost",
            "livemode": false,
            "metadata": {
                "card_scheme": "VISA",
                "card_number": "411111********1111",
                "orig_transaction_amount": "10",
                "partial_ind": "no",
                "orig_transaction_currency": "USD",
                "work_by_date": "1667059200000",
                "arn": "232323232323",
                "orig_transaction_date": "1666928646000"
            },
            "evidence": {
                "created": 1666928739358,
                "receipt": "",
                "access_activity_log": "",
                "billing_address": "null ",
                "cancellation_policy": "",
                "duplicate_charge_documentation": null,
                "cancellation_policy_disclosure": "",
                "cancellation_rebuttal": null,
                "customer_communication": "",
                "customer_email_address": "",
                "customer_name": null,
                "customer_purchase_ip": "",
                "customer_signature": "",
                "product_description": "",
                "refund_policy": "",
                "refund_policy_disclosure": "",
                "refund_refusal_explanation": "",
                "service_date": null,
                "service_documentation": "",
                "shipping_address": "null ",
                "shipping_carrier": "",
                "shipping_date": null,
                "shipping_documentation": "",
                "shipping_tracking_number": "",
                "uncategorized_file": "[\"1516963849268363264\"]",
                "uncategorized_text": "",
                "livemode": false
            },
            "payment_intent": "pi_1585839797425930240",
            "reason_type": "Fraud",
            "reason_description": "Visa Fraud Monitoring Program",
            "reason_code": "10.5",
            "evidence_details": {
                "has_evidence": true,
                "past_due": false,
                "submission_count": 1,
                "due_by": 1667059200000
            }
        }
    },
    "type": "charge.dispute.closed",
    "request": null,
    "livemode": false
}
Previous
Types of events
Next
Files
Built with