# Retrieve a charge ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/charges/{id}: get: summary: Retrieve a charge deprecated: false description: >- 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. tags: - API Reference/Charges parameters: - name: id in: path description: '' required: true schema: type: string - name: Accept in: header description: '' required: true example: application/json schema: type: string - name: Content-Type in: header description: '' required: true example: application/json schema: type: string responses: '200': description: '' content: application/json: schema: type: object x-apifox-refs: 01GMPTJNVMYZ06Z1E0JG7QGXF1: $ref: '#/components/schemas/Charge' x-apifox-overrides: receipt_number: null receipt_url: null transfer_group: null transfer_data: null statement_descriptor_suffix: null calculated_statement_descriptor: null application_fee_amount: null application: null statement_descriptor: null on_behalf_of: null application_fee: null source_transfer: null x-apifox-orders: - 01GMPTJNVMYZ06Z1E0JG7QGXF1 properties: id: type: string description: Unique identifier for the object, like "ch_XXX". object: type: string description: value is "charge" amount: type: integer description: Amount intended to be collected by this payment. amount_captured: type: integer description: >- Amount in cents captured (can be less than the amount attribute on the charge if a partial capture was made). amount_refunded: type: integer description: >- Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued). balance_transaction: type: string description: >- ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). billing_details: &ref_1 description: >- Billing information associated with the payment method at the time of the transaction. $ref: '#/components/schemas/Billing%20Details' captured: type: boolean description: >- If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. created: type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. currency: type: string description: Three-letter ISO currency code. customer: type: string description: ID of the customer this charge is for if one exists description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. disputed: type: boolean description: Whether the charge has been disputed. failure_balance_transaction: type: string description: >- ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. failure_code: type: string description: >- Error code explaining reason for charge failure if available failure_message: type: string description: >- Message to user further explaining reason for charge failure if available. fraud_details: type: object properties: gateway_report: type: string description: >- Assessments from the gateway. If set, the value is fraudulent. user_report: type: string description: >- Assessments reported by you. If set, possible values of are safe and fraudulent. x-apifox-orders: - gateway_report - user_report description: Information on fraud assessments for the charge. x-apifox-ignore-properties: [] invoice: type: string description: ID of the invoice this charge is for if one exists. livemode: type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. metadata: type: object properties: {} x-apifox-orders: [] description: 'Set of key-value pairs that you can attach to an object. ' x-apifox-ignore-properties: [] outcome: description: Details about whether the payment was accepted, and why. type: object x-apifox-refs: 01GMN5Y23Q2NHGKCTVB9CNQVNP: &ref_2 $ref: '#/components/schemas/Outcome' x-apifox-overrides: seller_message: null x-apifox-orders: - 01GMN5Y23Q2NHGKCTVB9CNQVNP properties: network_status: type: string description: >- Possible values are approved_by_network, declined_by_network, not_sent_to_network, and reversed_after_approval. reason: type: string description: >- 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: type: string description: >- 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: type: string description: >- 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: type: string description: >- The ID of the rule that matched the payment, if applicable. type: type: string description: >- Possible values are authorized, manual_review, issuer_declined, blocked, and invalid. x-apifox-ignore-properties: - network_status - reason - risk_level - risk_score - rule - type paid: type: boolean description: >- true if the charge succeeded, or was successfully authorized for later capture. payment_intent: type: string description: >- ID of the PaymentIntent associated with this charge, if one exists. payment_method: type: string description: ID of the payment method used in this charge. payment_method_details: type: object properties: card: type: object x-apifox-refs: 01GMN5M9CMWP2QG8QN5CG549PX: &ref_9 $ref: '#/components/schemas/Card%20in%20Charge' x-apifox-overrides: installments: null wallet: null x-apifox-orders: - 01GMN5M9CMWP2QG8QN5CG549PX properties: brand: type: string description: >- Card brand. Can be amex, diners, discover, jcb, mastercard, unionpay, visa, or unknown. checks: type: object properties: address_line1_check: type: string description: >- If a address line1 was provided, results of the check, one of pass, fail, unavailable, or unchecked. address_postal_code_check: type: string description: >- If a address postal code was provided, results of the check, one of pass, fail, unavailable, or unchecked. cvc_check: type: string description: >- If a CVC was provided, results of the check, one of pass, fail, unavailable, or unchecked. x-apifox-orders: - address_line1_check - address_postal_code_check - cvc_check description: >- Check results by Card networks on Card address and CVC at time of payment. x-apifox-ignore-properties: [] country: type: string description: >- Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected. exp_month: type: integer description: >- Two-digit number representing the card’s expiration month. exp_year: type: integer description: >- Four-digit number representing the card’s expiration year. fingerprint: type: string description: >- Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. funding: type: string description: >- Card funding type. Can be credit, debit, prepaid, or unknown. last4: type: string description: The last four digits of the card. mandate: type: string description: >- ID of the mandate used to make this payment or created by it. network: type: string description: >- Identifies which network this charge was processed on. Can be amex, cartes_bancaires, diners, discover, interac, jcb, mastercard, unionpay, visa, or unknown. three_d_secure: type: object properties: authentication_flow: type: string description: >- For authenticated transactions: how the customer was authenticated by the issuing bank. Possible enum values, challenge, frictionless enum: - challenge - frictionless x-apifox-enum: - value: challenge name: '' description: '' - value: frictionless name: '' description: '' result: type: string description: >- Indicates the outcome of 3D Secure authentication. result_reason: type: string description: >- Additional information about why 3D Secure succeeded or failed based on the result. enum: - card_not_enrolled - network_not_supported - abandoned - bypassed - protocol_error - canceled - rejected x-apifox-enum: - value: card_not_enrolled name: '' description: >- For not_supported. The issuing bank does not support 3D Secure or has not set up 3D Secure for the card, and the card network did not provide proof of the attempt. - value: network_not_supported name: '' description: >- For not_supported. The gateway does not support 3D Secure on this card network. - value: abandoned name: '' description: >- For failed. The transaction timed out: the cardholder dropped off before completing authentication. - value: bypassed name: '' description: >- For processing_error. Stripe bypassed 3D Secure because the issuing bank’s web-facing server was returning errors or timeouts to customers in the challenge window. - value: protocol_error name: '' description: >- For processing_error. An invalid message was received from the card network or issuing bank. (Includes “downgrades” and similar errors). - value: canceled name: '' description: >- For failed. The cardholder canceled authentication (where possible to identify). - value: rejected name: '' description: >- For failed. The cardholder was redirected back from the issuing bank without completing authentication. version: type: string description: |- 1.0.2 2.1.0 2.2.0 x-apifox-orders: - authentication_flow - result - result_reason - version description: >- Populated if this transaction used 3D Secure authentication. x-apifox-ignore-properties: [] x-apifox-ignore-properties: - brand - checks - country - exp_month - exp_year - fingerprint - funding - last4 - mandate - network - three_d_secure type: type: string description: >- The type of transaction-specific details of the payment method used in the payment. x-apifox-orders: - card - type description: >- Details about the payment method at the time of the transaction. x-apifox-ignore-properties: [] receipt_email: type: string description: >- This is the email address that the receipt for this charge was sent to. refunded: type: boolean description: >- Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. refunds: type: object properties: object: type: string description: The value is "list" data: type: array items: type: string description: Array of objects Details about each object. has_more: type: boolean description: >- True if this list has another page of items after this one that can be fetched. url: type: string description: The URL where this list can be accessed. x-apifox-orders: - object - data - has_more - url description: >- 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. x-apifox-ignore-properties: [] review: type: string description: >- ID of the review associated with this charge if one exists. status: type: string description: >- The status of the payment is either succeeded, pending, or failed. shipping: &ref_28 $ref: '#/components/schemas/Shipping' description: Shipping information for the charge. x-apifox-ignore-properties: - id - object - amount - amount_captured - amount_refunded - balance_transaction - billing_details - captured - created - currency - customer - description - disputed - failure_balance_transaction - failure_code - failure_message - fraud_details - invoice - livemode - metadata - outcome - paid - payment_intent - payment_method - payment_method_details - receipt_email - refunded - refunds - review - status - shipping headers: {} x-apifox-name: OK security: - basic: [] x-apifox-folder: API Reference/Charges x-apifox-status: developing x-run-in-apifox: https://app.apifox.com/web/project/1296482/apis/api-55482259-run components: schemas: Shipping: type: object properties: address: &ref_0 $ref: '#/components/schemas/Address' carrier: type: string description: >- The delivery service that shipped a physical product, such as FedEx, UPS, USPS, etc. name: type: string description: 'Recipient name. ' phone: type: string description: 'Recipient phone (including extension). ' tracking_number: type: string description: >- 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. x-apifox-orders: - address - carrier - name - phone - tracking_number x-apifox-ignore-properties: [] x-apifox-folder: '' Address: type: object properties: city: type: string description: City, district, suburb, town, or village. country: type: string description: Two-letter country code (ISO 3166-1 alpha-2 ). line1: type: string description: Address line 1 (e.g., street, PO Box, or company name). line2: type: string description: Address line 2 (e.g., apartment, suite, unit, or building). postal_code: type: string description: ZIP or postal code. state: type: string description: State, county, province, or region. x-apifox-orders: - city - country - line1 - line2 - postal_code - state x-apifox-ignore-properties: [] x-apifox-folder: '' Card in Charge: type: object properties: brand: &ref_10 type: string description: >- Card brand. Can be amex, diners, discover, jcb, mastercard, unionpay, visa, or unknown. checks: type: object properties: address_line1_check: &ref_11 type: string description: >- If a address line1 was provided, results of the check, one of pass, fail, unavailable, or unchecked. address_postal_code_check: &ref_12 type: string description: >- If a address postal code was provided, results of the check, one of pass, fail, unavailable, or unchecked. cvc_check: &ref_13 type: string description: >- If a CVC was provided, results of the check, one of pass, fail, unavailable, or unchecked. x-apifox-orders: &ref_14 - address_line1_check - address_postal_code_check - cvc_check description: >- Check results by Card networks on Card address and CVC at time of payment. x-apifox-ignore-properties: [] country: &ref_15 type: string description: >- Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you’ve collected. exp_month: &ref_16 type: integer description: Two-digit number representing the card’s expiration month. exp_year: &ref_17 type: integer description: Four-digit number representing the card’s expiration year. fingerprint: &ref_18 type: string description: >- Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. funding: &ref_19 type: string description: Card funding type. Can be credit, debit, prepaid, or unknown. last4: &ref_20 type: string description: The last four digits of the card. mandate: &ref_21 type: string description: ID of the mandate used to make this payment or created by it. network: &ref_22 type: string description: >- Identifies which network this charge was processed on. Can be amex, cartes_bancaires, diners, discover, interac, jcb, mastercard, unionpay, visa, or unknown. three_d_secure: type: object properties: authentication_flow: type: string description: >- For authenticated transactions: how the customer was authenticated by the issuing bank. Possible enum values, challenge, frictionless enum: &ref_23 - challenge - frictionless x-apifox-enum: - value: challenge name: '' description: '' - value: frictionless name: '' description: '' result: &ref_24 type: string description: Indicates the outcome of 3D Secure authentication. result_reason: type: string description: >- Additional information about why 3D Secure succeeded or failed based on the result. enum: &ref_25 - card_not_enrolled - network_not_supported - abandoned - bypassed - protocol_error - canceled - rejected x-apifox-enum: - value: card_not_enrolled name: '' description: >- For not_supported. The issuing bank does not support 3D Secure or has not set up 3D Secure for the card, and the card network did not provide proof of the attempt. - value: network_not_supported name: '' description: >- For not_supported. The gateway does not support 3D Secure on this card network. - value: abandoned name: '' description: >- For failed. The transaction timed out: the cardholder dropped off before completing authentication. - value: bypassed name: '' description: >- For processing_error. Stripe bypassed 3D Secure because the issuing bank’s web-facing server was returning errors or timeouts to customers in the challenge window. - value: protocol_error name: '' description: >- For processing_error. An invalid message was received from the card network or issuing bank. (Includes “downgrades” and similar errors). - value: canceled name: '' description: >- For failed. The cardholder canceled authentication (where possible to identify). - value: rejected name: '' description: >- For failed. The cardholder was redirected back from the issuing bank without completing authentication. version: &ref_26 type: string description: |- 1.0.2 2.1.0 2.2.0 x-apifox-orders: &ref_27 - authentication_flow - result - result_reason - version description: Populated if this transaction used 3D Secure authentication. x-apifox-ignore-properties: [] wallet: type: 'null' description: （未实现） installments: type: 'null' description: （未实现） x-apifox-orders: - brand - checks - country - exp_month - exp_year - fingerprint - funding - last4 - mandate - network - three_d_secure - wallet - installments x-apifox-ignore-properties: [] x-apifox-folder: '' Outcome: type: object properties: network_status: &ref_3 type: string description: >- Possible values are approved_by_network, declined_by_network, not_sent_to_network, and reversed_after_approval. reason: &ref_4 type: string description: >- 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: &ref_5 type: string description: >- 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: &ref_6 type: string description: >- 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: &ref_7 type: string description: The ID of the rule that matched the payment, if applicable. type: &ref_8 type: string description: >- Possible values are authorized, manual_review, issuer_declined, blocked, and invalid. seller_message: type: string description: （未实现） x-apifox-orders: - network_status - reason - risk_level - risk_score - rule - type - seller_message x-apifox-ignore-properties: [] x-apifox-folder: '' Billing Details: type: object properties: address: *ref_0 email: type: string description: Email address. name: type: string description: 'Full name. ' phone: type: string description: Billing phone number (including extension). x-apifox-orders: - address - email - name - phone x-apifox-ignore-properties: [] x-apifox-folder: '' Charge: type: object properties: id: type: string description: Unique identifier for the object, like "ch_XXX". object: type: string description: value is "charge" amount: type: integer description: Amount intended to be collected by this payment. amount_captured: type: integer description: >- Amount in cents captured (can be less than the amount attribute on the charge if a partial capture was made). amount_refunded: type: integer description: >- Amount in cents refunded (can be less than the amount attribute on the charge if a partial refund was issued). balance_transaction: type: string description: >- ID of the balance transaction that describes the impact of this charge on your account balance (not including refunds or disputes). billing_details: *ref_1 captured: type: boolean description: >- If the charge was created without capturing, this Boolean represents whether it is still uncaptured or has since been captured. created: type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. currency: type: string description: Three-letter ISO currency code. customer: type: string description: ID of the customer this charge is for if one exists description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. disputed: type: boolean description: Whether the charge has been disputed. failure_balance_transaction: type: string description: >- ID of the balance transaction that describes the reversal of the balance on your account due to payment failure. failure_code: type: string description: Error code explaining reason for charge failure if available failure_message: type: string description: >- Message to user further explaining reason for charge failure if available. fraud_details: type: object properties: gateway_report: type: string description: Assessments from the gateway. If set, the value is fraudulent. user_report: type: string description: >- Assessments reported by you. If set, possible values of are safe and fraudulent. x-apifox-orders: - gateway_report - user_report description: Information on fraud assessments for the charge. x-apifox-ignore-properties: [] invoice: type: string description: ID of the invoice this charge is for if one exists. livemode: type: boolean description: >- Has the value true if the object exists in live mode or the value false if the object exists in test mode. metadata: type: object properties: {} x-apifox-orders: [] description: 'Set of key-value pairs that you can attach to an object. ' x-apifox-ignore-properties: [] outcome: description: Details about whether the payment was accepted, and why. type: object x-apifox-refs: 01GMN5Y23Q2NHGKCTVB9CNQVNP: *ref_2 x-apifox-orders: - 01GMN5Y23Q2NHGKCTVB9CNQVNP properties: network_status: *ref_3 reason: *ref_4 risk_level: *ref_5 risk_score: *ref_6 rule: *ref_7 type: *ref_8 x-apifox-ignore-properties: - network_status - reason - risk_level - risk_score - rule - type paid: type: boolean description: >- true if the charge succeeded, or was successfully authorized for later capture. payment_intent: type: string description: ID of the PaymentIntent associated with this charge, if one exists. payment_method: type: string description: ID of the payment method used in this charge. payment_method_details: type: object properties: card: type: object x-apifox-refs: 01GMN5M9CMWP2QG8QN5CG549PX: *ref_9 x-apifox-orders: - 01GMN5M9CMWP2QG8QN5CG549PX properties: brand: *ref_10 checks: type: object properties: address_line1_check: *ref_11 address_postal_code_check: *ref_12 cvc_check: *ref_13 x-apifox-orders: *ref_14 description: >- Check results by Card networks on Card address and CVC at time of payment. x-apifox-ignore-properties: [] country: *ref_15 exp_month: *ref_16 exp_year: *ref_17 fingerprint: *ref_18 funding: *ref_19 last4: *ref_20 mandate: *ref_21 network: *ref_22 three_d_secure: type: object properties: authentication_flow: type: string description: >- For authenticated transactions: how the customer was authenticated by the issuing bank. Possible enum values, challenge, frictionless enum: *ref_23 x-apifox-enum: - value: challenge name: '' description: '' - value: frictionless name: '' description: '' result: *ref_24 result_reason: type: string description: >- Additional information about why 3D Secure succeeded or failed based on the result. enum: *ref_25 x-apifox-enum: - value: card_not_enrolled name: '' description: >- For not_supported. The issuing bank does not support 3D Secure or has not set up 3D Secure for the card, and the card network did not provide proof of the attempt. - value: network_not_supported name: '' description: >- For not_supported. The gateway does not support 3D Secure on this card network. - value: abandoned name: '' description: >- For failed. The transaction timed out: the cardholder dropped off before completing authentication. - value: bypassed name: '' description: >- For processing_error. Stripe bypassed 3D Secure because the issuing bank’s web-facing server was returning errors or timeouts to customers in the challenge window. - value: protocol_error name: '' description: >- For processing_error. An invalid message was received from the card network or issuing bank. (Includes “downgrades” and similar errors). - value: canceled name: '' description: >- For failed. The cardholder canceled authentication (where possible to identify). - value: rejected name: '' description: >- For failed. The cardholder was redirected back from the issuing bank without completing authentication. version: *ref_26 x-apifox-orders: *ref_27 description: Populated if this transaction used 3D Secure authentication. x-apifox-ignore-properties: [] x-apifox-ignore-properties: - brand - checks - country - exp_month - exp_year - fingerprint - funding - last4 - mandate - network - three_d_secure type: type: string description: >- The type of transaction-specific details of the payment method used in the payment. x-apifox-orders: - card - type description: Details about the payment method at the time of the transaction. x-apifox-ignore-properties: [] receipt_email: type: string description: >- This is the email address that the receipt for this charge was sent to. refunded: type: boolean description: >- Whether the charge has been fully refunded. If the charge is only partially refunded, this attribute will still be false. refunds: type: object properties: object: type: string description: The value is "list" data: type: array items: type: string description: Array of objects Details about each object. has_more: type: boolean description: >- True if this list has another page of items after this one that can be fetched. url: type: string description: The URL where this list can be accessed. x-apifox-orders: - object - data - has_more - url description: >- 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. x-apifox-ignore-properties: [] review: type: string description: ID of the review associated with this charge if one exists. status: type: string description: The status of the payment is either succeeded, pending, or failed. shipping: *ref_28 source_transfer: type: 'null' description: （未实现） application_fee: type: 'null' description: （未实现） on_behalf_of: type: 'null' description: （未实现） statement_descriptor: type: 'null' description: （未实现） application: type: 'null' description: （未实现） application_fee_amount: type: 'null' description: （未实现） calculated_statement_descriptor: type: 'null' description: （未实现） statement_descriptor_suffix: type: 'null' description: （未实现） transfer_data: type: 'null' description: （未实现） transfer_group: type: 'null' description: （未实现） receipt_url: type: string description: （未实现） receipt_number: type: 'null' description: （未实现） x-apifox-orders: - id - object - amount - amount_captured - amount_refunded - balance_transaction - billing_details - captured - created - currency - customer - description - disputed - failure_balance_transaction - failure_code - failure_message - fraud_details - invoice - livemode - metadata - outcome - paid - payment_intent - payment_method - payment_method_details - receipt_email - refunded - refunds - review - status - shipping - source_transfer - application_fee - on_behalf_of - statement_descriptor - application - application_fee_amount - calculated_statement_descriptor - statement_descriptor_suffix - transfer_data - transfer_group - receipt_url - receipt_number x-apifox-ignore-properties: [] x-apifox-folder: '' securitySchemes: basic: type: http scheme: basic servers: - url: https://apitest.wooshpay.com description: 官网测试 security: - basic: [] ```