Skip to main content
GET
/
api
/
v1
/
charges
/
{id}
curl -X GET "https://api-sandbox.paywithsoap.com/api/v1/charges/ch_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK" \
  -H "Authorization: YOUR_API_KEY"

{
  "id": "ch_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK",
  "amount_cents": 2999,
  "transaction_type": "debit",
  "currency": "USD",
  "status": "succeeded",
  "failure_code": null,
  "failure_message": null,
  "created_at": "2026-05-31T10:30:00.000Z",
  "updated_at": "2026-05-31T10:30:05.000Z",
  "customer": {
    "id": "cus_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK",
    "first_name": "Sarah",
    "last_name": "Johnson"
  },
  "payment_method": {
    "id": "pm_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK",
    "payment_type": "card",
    "created_at": "2026-05-31T10:30:00.000Z",
    "updated_at": "2026-05-31T10:30:05.000Z",
    "saved": true,
    "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "card": {
      "last_four": "4242",
      "card_brand": "visa",
      "card_expiration_month": 12,
      "card_expiration_year": 2027,
      "card_issuer_country": "US",
      "name_on_card": "Sarah Johnson",
      "card_type": "credit",
      "first_name": "Sarah",
      "last_name": "Johnson",
      "zip": "10001",
      "google_pay": false,
      "apple_pay": false,
      "bin": "424242"
    }
  },
  "avs_result": "Y",
  "cvv_result": "M",
  "network_authorization_code": "OK1234",
  "processor_charge_id": "proc_5fNqQ8wRyzKp",
  "threeds": {
    "eci": "05",
    "version": "2.2.0",
    "liability_shifted": true,
    "failure_reason": null,
    "status": "success"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.paywithsoap.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve a single charge by its ID. The charge must belong to the merchant whose API key is used; otherwise the API responds with a 422 indistinguishable from “not found”, by design.
The response object groups into three field clusters:
  • Core: id, amount_cents, transaction_type, currency, status, failure_code, failure_message, created_at, updated_at.
  • Related entities: a flattened customer object and a payment_method object. payment_method always contains id, payment_type, created_at, updated_at, saved, and fingerprint, plus exactly one of card, bank_account, or crypto_wallet (matching payment_type).
  • Processor metadata (card charges only): avs_result, cvv_result, network_authorization_code, processor_charge_id, and an optional threeds block when 3D Secure was performed.
curl -X GET "https://api-sandbox.paywithsoap.com/api/v1/charges/ch_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK" \
  -H "Authorization: YOUR_API_KEY"

{
  "id": "ch_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK",
  "amount_cents": 2999,
  "transaction_type": "debit",
  "currency": "USD",
  "status": "succeeded",
  "failure_code": null,
  "failure_message": null,
  "created_at": "2026-05-31T10:30:00.000Z",
  "updated_at": "2026-05-31T10:30:05.000Z",
  "customer": {
    "id": "cus_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK",
    "first_name": "Sarah",
    "last_name": "Johnson"
  },
  "payment_method": {
    "id": "pm_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK",
    "payment_type": "card",
    "created_at": "2026-05-31T10:30:00.000Z",
    "updated_at": "2026-05-31T10:30:05.000Z",
    "saved": true,
    "fingerprint": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
    "card": {
      "last_four": "4242",
      "card_brand": "visa",
      "card_expiration_month": 12,
      "card_expiration_year": 2027,
      "card_issuer_country": "US",
      "name_on_card": "Sarah Johnson",
      "card_type": "credit",
      "first_name": "Sarah",
      "last_name": "Johnson",
      "zip": "10001",
      "google_pay": false,
      "apple_pay": false,
      "bin": "424242"
    }
  },
  "avs_result": "Y",
  "cvv_result": "M",
  "network_authorization_code": "OK1234",
  "processor_charge_id": "proc_5fNqQ8wRyzKp",
  "threeds": {
    "eci": "05",
    "version": "2.2.0",
    "liability_shifted": true,
    "failure_reason": null,
    "status": "success"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer token authentication using your API key

Path Parameters

​
id
string
required

Unique identifier of the charge to retrieve.

Example:

"ch_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK"

Response

Charge retrieved.

​
id
string
Example:

"ch_pQsQ4kz3Af6Mb9rCupnWj6VFzxJsmkYK"

​
amount_cents
integer

Charge amount in cents.

Example:

2999

​
transaction_type
enum<string>

Direction of the charge: credit for deposits (money into the customer balance), debit for withdrawals (money out).

Available options:
credit,
debit
Example:

"debit"

​
currency
string
Example:

"USD"

​
status
enum<string>

Current state of the charge across its full lifecycle. Some values are specific to deposits (returned, refunded) or withdrawals (held, voided).

Available options:
created,
pending,
succeeded,
failed,
held,
voided,
returned,
refunded,
cancelled
Example:

"succeeded"

​
failure_code
string | null

Machine-readable failure code; only present when status is failed.

Example:

null

​
failure_message
string | null

Human-readable failure reason; only present when status is failed.

Example:

null

​
created_at
string<date-time>
Example:

"2026-05-31T10:30:00.000Z"

​
updated_at
string<date-time>
Example:

"2026-05-31T10:30:05.000Z"

​
customer
object
​
payment_method
object

Payment method used for the charge. Exactly one of card, bank_account, or crypto_wallet is populated, matching payment_type.

​
avs_result
string | null

Address Verification System result from the processor. Card charges only.

Example:

null

​
cvv_result
string | null

CVV verification result from the processor. Card charges only.

Example:

null

​
network_authorization_code
string | null

Authorization code returned by the card network. Card charges only.

Example:

null

​
processor_charge_id
string | null

External processor's identifier for this charge. Card charges only.

Example:

null

​
threeds
object

3D Secure verification details. Only present for card charges where 3DS was performed.