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

string

required

Header Params

string

required

Default:

application/json

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://apitest.wooshpay.com/v1/charges/' \
--header 'Accept;' \
--header 'Authorization: Basic Og=='

Responses

🟢200OK

application/json

Body

string

optional

Unique identifier for the object, like "ch_XXX".

object

string

optional

value is "charge"

amount

integer

optional

Amount intended to be collected by this payment.

amount_captured

integer

optional

Amount in cents captured (can be less than the amount attribute on the charge if a partial capture was made).

amount_refunded

integer

optional

Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued).

balance_transaction

string

optional

ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes).

billing_details

object (Billing Details)

optional

Billing information associated with the payment method at the time of the transaction.

address

object (Address)

optional

string

optional

Email address.

name

string

optional

Full name.

phone

string

optional

Billing phone number (including extension).

captured

boolean

optional

If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured.

created

integer

optional

Time at which the object was created. Measured in seconds since the Unix epoch.

currency

string

optional

Three-letter ISO currency code.

customer

string

optional

ID of the customer this charge is for if one exists

description

string

optional

An arbitrary string attached to the object. Often useful for displaying to users.

disputed

boolean

optional

Whether the charge has been disputed.

failure_balance_transaction

string

optional

ID of the balance transaction that describes the reversal of the balance on your account due to payment failure.

failure_code

string

optional

Error code explaining reason for charge failure if available

failure_message

string

optional

Message to user further explaining reason for charge failure if available.

fraud_details

object

optional

Information on fraud assessments for the charge.

gateway_report

string

optional

Assessments from the gateway. If set, the value is fraudulent.

user_report

string

optional

Assessments reported by you. If set, possible values of are safe and fraudulent.

invoice

string

optional

ID of the invoice this charge is for if one exists.

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.

metadata

object

optional

Set of key-value pairs that you can attach to an object.

outcome

object

optional

Details about whether the payment was accepted, and why.

network_status

string

optional

Possible values are approved_by_network, declined_by_network, not_sent_to_network, and reversed_after_approval.

reason

string

optional

An enumerated value providing a more detailed explanation of the outcome’s type. Charges blocked by default block rule have the value highest_risk_level. Charges placed in review by default review rule have the value elevated_risk_level. Charges authorized, blocked, or placed in review by custom rules have the value rule.

risk_level

string

optional

Possible values for evaluated payments are normal, elevated, highest. For non-card payments, and card-based payments predating the public assignment of risk levels, this field will have the value not_assessed. In the event of an error in the evaluation, this field will have the value unknown.

risk_score

string

optional

Possible values for evaluated payments are between 0 and 100. For non-card payments, card-based payments predating the public assignment of risk scores, or in the event of an error during evaluation, this field will not be present.

rule

string

optional

The ID of the rule that matched the payment, if applicable.

type

string

optional

Possible values are authorized, manual_review, issuer_declined, blocked, and invalid.

paid

boolean

optional

true if the charge succeeded, or was successfully authorized for later capture.

payment_intent

string

optional

ID of the PaymentIntent associated with this charge, if one exists.

payment_method

string

optional

ID of the payment method used in this charge.

payment_method_details

object

optional

Details about the payment method at the time of the transaction.

card

object

optional

type

string

optional

The type of transaction-specific details of the payment method used in the payment.

receipt_email

string

optional

This is the email address that the receipt for this charge was sent to.

refunded

boolean

optional

Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false.

refunds

object

optional

A list of refunds that have been applied to the charge. refunds.object string, value is "list" String representing the object’s type. Objects of the same type share the same value. Always has the value list.

object

string

optional

The value is "list"

data

array[string]

optional

Array of objects Details about each object.

has_more

boolean

optional

True if this list has another page of items after this one that can be fetched.

url

string

optional

The URL where this list can be accessed.

review

string

optional

ID of the review associated with this charge if one exists.

status

string

optional

The status of the payment is either succeeded, pending, or failed.

shipping

object (Shipping)

optional

Shipping information for the charge.

address

object (Address)

optional

carrier

string

optional

The delivery service that shipped a physical product, such as FedEx, UPS, USPS, etc.

name

string

optional

Recipient name.

phone

string

optional

Recipient phone (including extension).

tracking_number

string

optional

The tracking number for a physical product, obtained from the delivery service. If multiple tracking numbers were generated for this purchase, please separate them with commas.

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"
  }
}

Search PaymentIntents

List all charges