WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Charges
  • API introduction
  • Error code
  • Checkout
    • Create a Session
      POST
    • Expire a Session
      POST
    • Retreive a Session
      GET
    • List All Checkout Sessions
      GET
    • Retrieve a Checkout Session's line items
      GET
    • Expire a Session Copy
      POST
  • 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
  • Setup Intents
    • Create a SetupIntent
      POST
    • Retrieve a SetupIntent
      GET
    • Cancel a SetupIntent
      POST
    • List all SetupIntents
      GET
    • List all SetupAttempts
      GET
    • Update a SetupIntent
      POST
    • Confirm a SetupIntent
      POST
  • Refunds
    • Create a refund
      POST
    • Retrieve a refund
      GET
  • 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
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Webhooks
    • Create a Webhook
    • List All Webhooks
    • Retrieve a Webhook
    • Delete a Webhook
    • Update a Webhook
  • Events
    • Types of events
    • Retrieve an event
  • Payment Methods
    • Create a PaymentMethod
    • Retrieve a PaymentMethod
    • Retrieve a Customer's PaymentMethod
    • Update a PaymentMethod
    • List PaymentMethods
    • List a Customer's PaymentMethods
    • Attach a PaymentMethod to a Customer
    • Detach a PaymentMethod from a Customer
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • 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
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • 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. Charges

Retrieve a charge

Developing
GET
/v1/charges/{id}
Retrieves the details of a charge that has previously been created. Supply the unique charge ID that was returned from your previous request, and we will return the corresponding charge information. The same information is returned when creating or refunding the charge.

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

Header Params

Request Code 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/charges/' \
--header 'Accept;' \
--header 'Authorization: Basic Og=='

Responses

🟢200OK
application/json
Body

Example
{
    "id": "string",
    "object": "string",
    "amount": 0,
    "amount_captured": 0,
    "amount_refunded": 0,
    "balance_transaction": "string",
    "billing_details": {
        "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string"
        },
        "email": "string",
        "name": "string",
        "phone": "string"
    },
    "captured": true,
    "created": 0,
    "currency": "string",
    "customer": "string",
    "description": "string",
    "disputed": true,
    "failure_balance_transaction": "string",
    "failure_code": "string",
    "failure_message": "string",
    "fraud_details": {
        "gateway_report": "string",
        "user_report": "string"
    },
    "invoice": "string",
    "livemode": true,
    "metadata": {},
    "outcome": {
        "network_status": "string",
        "reason": "string",
        "risk_level": "string",
        "risk_score": "string",
        "rule": "string",
        "type": "string"
    },
    "paid": true,
    "payment_intent": "string",
    "payment_method": "string",
    "payment_method_details": {
        "card": {
            "brand": "string",
            "checks": {
                "address_line1_check": "string",
                "address_postal_code_check": "string",
                "cvc_check": "string"
            },
            "country": "string",
            "exp_month": 0,
            "exp_year": 0,
            "fingerprint": "string",
            "funding": "string",
            "last4": "string",
            "mandate": "string",
            "network": "string",
            "three_d_secure": {
                "authentication_flow": "challenge",
                "result": "string",
                "result_reason": "card_not_enrolled",
                "version": "string"
            }
        },
        "type": "string"
    },
    "receipt_email": "string",
    "refunded": true,
    "refunds": {
        "object": "string",
        "data": [
            "string"
        ],
        "has_more": true,
        "url": "string"
    },
    "review": "string",
    "status": "string",
    "shipping": {
        "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string"
        },
        "carrier": "string",
        "name": "string",
        "phone": "string",
        "tracking_number": "string"
    }
}
Modified at 2024-02-27 07:30:18
Previous
List All Payouts
Next
List all charges
Built with