# Retrieve an authorization ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/issuing/authorizations/{id}: get: summary: Retrieve an authorization deprecated: false description: Retrieves an Issuing Authorization object. tags: - API Reference/Issuing/Authorizations 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: 01HTC6DKG1BS8M5HCYTW32T3VV: $ref: '#/components/schemas/The%20Authorization%20object' x-apifox-overrides: wallet: null amount_details: null authorization_method: null balance_transactions: null verification_data: null pending_request: null request_history: null merchant_data: &ref_0 type: object properties: category_code: type: string description: >- The merchant category code for the seller’s business name: type: string description: Name of the seller description: Details about the seller x-apifox-orders: - category_code - name x-apifox-ignore-properties: [] x-apifox-orders: - 01HTC6DKG1BS8M5HCYTW32T3VV properties: id: type: string description: Unique identifier for the object. amount: type: integer description: >- The total amount that was authorized or rejected. This amount is in currency and in the smallest currency unit. Amount should be the same as merchant_amount, unless currency and merchant_currency are different. approved: type: boolean card: description: Card associated with this authorization type: object x-apifox-refs: 01HTBRHM7NTTZFX76Y153R8R4R: &ref_43 $ref: '#/components/schemas/The%20Card%20object' x-apifox-overrides: wallets: null shipping: null replacement_for: null replaced_by: null replacement_reason: null x-apifox-orders: - 01HTBRHM7NTTZFX76Y153R8R4R properties: id: type: string description: Unique identifier for the object. cancellation_reason: type: string description: The reason why the card was canceled. enum: - lost - stolen - design_rejected x-apifox-enum: - name: '' value: lost description: The card was lost. - name: '' value: stolen description: The card was stolen. - name: '' value: design_rejected description: The design of this card was rejected by Wooshpay currency: type: string description: Three-letter ISO currency code. type: type: string description: The type of the card. enum: - virtual x-apifox-enum: - name: '' value: virtual description: No physical card will be printed. cardholder: description: The Cardholder object to which the card belongs. type: object x-apifox-refs: 01HTBRDQTR7C3Y5P119S5R60DF: &ref_1 $ref: '#/components/schemas/The%20Cardholder%20object' x-apifox-overrides: preferred_locales: null requirements: null x-apifox-orders: - 01HTBRDQTR7C3Y5P119S5R60DF properties: id: type: string description: Unique identifier for the object. object: type: string description: >- Value is "issuing.cardholder". String representing the object’s type. Objects of the same type share the same value. billing: type: object properties: address: type: object properties: city: type: string description: City, district, suburb, town, or village. country: type: string description: Two-letter country code line1: type: string description: Address line 1 line2: type: string description: Address line 2 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 description: The cardholder’s billing address. x-apifox-ignore-properties: [] x-apifox-orders: - address description: The cardholder’s billing information. x-apifox-ignore-properties: [] name: type: string description: >- The cardholder’s name. This will be printed on cards issued to them. email: type: string description: The cardholder’s email address. phone_number: type: string description: >- The cardholder’s phone number. This is required for all cardholders who will be creating EU cards. metadata: type: array items: type: object properties: {} x-apifox-orders: [] x-apifox-ignore-properties: [] description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. company: type: object properties: tax_id_provided: type: boolean description: >- Whether the company’s business ID number was provided. description: Additional information about a company cardholder. x-apifox-orders: - tax_id_provided x-apifox-ignore-properties: [] created: type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. individual: type: object properties: card_issuing: type: object properties: user_terms_acceptance: type: object properties: date: type: integer description: >- The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. ip: type: string description: >- The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. user_agent: type: string description: >- The user agent of the browser from which the cardholder accepted the Authorized User Terms. x-apifox-orders: - date - ip - user_agent x-apifox-ignore-properties: [] x-apifox-orders: - user_terms_acceptance description: >- Information related to the card_issuing program for this cardholder. x-apifox-ignore-properties: [] dob: type: object properties: day: type: integer description: The day of birth, between 1 and 31. month: type: integer description: The month of birth, between 1 and 12. year: type: integer description: The four-digit year of birth. x-apifox-orders: - day - month - year description: The date of birth of this cardholder. x-apifox-ignore-properties: [] first_name: type: string description: >- The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. last_name: type: string description: >- The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. verification: type: object properties: document: type: object properties: back: type: string description: >- The back of a document returned by a file upload with a purpose value of identity_document. front: type: string description: >- The front of a document returned by a file upload with a purpose value of identity_document. x-apifox-orders: - back - front description: >- An identifying document, either a passport or local ID card. x-apifox-ignore-properties: [] x-apifox-orders: - document description: >- An identifying document, either a passport or local ID card. x-apifox-ignore-properties: [] description: >- Additional information about an individual cardholder. x-apifox-orders: - card_issuing - dob - first_name - last_name - verification x-apifox-ignore-properties: [] 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. spending_controls: type: object properties: spending_limits: type: object properties: amount: type: integer description: >- Maximum amount allowed to spend per interval. This amount is in the card’s currency and in the smallest currency unit. interval: type: string enum: - per_authorization - daily - weekly - monthly - yearly - all_time description: >- Interval (or event) to which the amount applies. x-apifox-enum: - value: per_authorization name: '' description: Limit applies to each authorization. - value: daily name: '' description: >- Limit applies to a day, starting at midnight UTC. - value: weekly name: '' description: >- Limit applies to a week, starting on Sunday at midnight UTC - value: monthly name: '' description: >- Limit applies to a month, starting on the 1st. - value: yearly name: '' description: >- Limit applies to a year, starting on January 1st. - value: all_time name: '' description: Limit applies to all transactions. description: >- Limit spending with amount-based rules that apply across this cardholder’s cards. x-apifox-orders: - amount - interval x-apifox-ignore-properties: [] spending_limits_currency: type: string description: >- Currency of the amounts within spending_limits. description: >- Rules that control spending across this cardholder’s cards. x-apifox-orders: - spending_limits - spending_limits_currency x-apifox-ignore-properties: [] status: type: string description: >- Specifies whether to permit authorizations on this cardholder’s cards. enum: - active - inactive - blocked x-apifox-enum: - value: active name: '' description: >- Cards attached to this cardholder can approve authorizations. - value: inactive name: '' description: >- Cards attached to this cardholder will decline all authorizations with the cardholder_inactive reason. - value: blocked name: '' description: >- Cards attached to this cardholder will decline all authorizations without an authorization object created. This status is non-reversible. type: type: string description: One of individual or company. enum: - individual - company x-apifox-enum: - value: individual name: '' description: >- The cardholder is a person, and additional information includes first and last name, date of birth. - value: company name: '' description: >- The cardholder is a company or business entity, and additional information includes their tax ID. x-apifox-ignore-properties: - id - object - billing - name - email - phone_number - metadata - company - created - individual - livemode - spending_controls - status - type exp_month: type: integer description: The expiration month of the card. exp_year: type: integer description: The expiration year of the card. first6: type: string description: The first 6 digits of the card number. binCode: type: string description: The first 6 digits of the card number. last4: type: string description: The last 4 digits of the card number. metadata: type: object properties: cardNick: type: string description: Identify the card nickname x-apifox-orders: - cardNick description: >- Set of key-value pairs that you can attach to an object. required: - cardNick x-apifox-ignore-properties: [] status: type: string description: >- Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to inactive. enum: - active - inactive - canceled x-apifox-enum: - name: '' value: active description: >- The card can approve authorizations. If the card is linked to a cardholder with past-due requirements, you may be unable to change the card’s status to ‘active’. - name: '' value: inactive description: >- The card will decline authorizations with the card_inactive reason. - name: '' value: canceled description: >- The card will decline authorizations, and no authorization object will be recorded. This status is permanent. object: type: string description: Value is "issuing.card" brand: type: string description: The brand of the card. created: type: string description: >- Time at which the object was created. Measured in seconds since the Unix epoch. cvc: type: string description: >- The card’s CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it’s only available via the “Retrieve a card” endpoint, not via “List all cards” or any other endpoint. This field is not included by default. To include it in the response, expand the cvc field. nullable: true 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. number: type: string description: >- The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it’s only available via the “Retrieve a card” endpoint, not via “List all cards” or any other endpoint. This field is not included by default. To include it in the response, expand the number field. nullable: true spending_controls: type: object properties: spending_limits: type: array items: type: object properties: amount: type: string description: >- Maximum amount allowed to spend per interval. interval: type: string description: >- Interval (or event) to which the amount applies. enum: - all_time - daily - monthly - yearly - per_authorization x-apifox-enum: - name: '' value: all_time description: Limit applies to all transactions. - name: '' value: daily description: >- Limit applies to a day, starting at midnight UTC. - name: '' value: monthly description: >- Limit applies to a month, starting on the 1st at midnight UTC. - name: '' value: yearly description: >- Limit applies to a year, starting on January 1st at midnight UTC. - name: '' value: per_authorization description: Limit applies to each authorization. x-apifox-orders: - amount - interval required: - amount - interval x-apifox-ignore-properties: [] description: >- Limit spending with amount-based rules that apply across any cards this card replaced spending_limits_currency: type: string description: >- Currency of the amounts within spending_limits. Always the same as the currency of the card. nullable: true description: >- Rules that control spending for this card. The all_time and per_authorization rules are required. x-apifox-orders: - spending_limits - spending_limits_currency required: - spending_limits x-apifox-ignore-properties: [] card_product_code: type: string description: >- The code representing a group of card features, such as currency, brand, bin code, supporting 3ds or not and so on. You can get them from open API [List all card bins]. required: - binCode - spending_controls x-apifox-ignore-properties: - id - cancellation_reason - currency - type - cardholder - exp_month - exp_year - first6 - binCode - last4 - metadata - status - object - brand - created - cvc - livemode - number - spending_controls - card_product_code cardholder: type: string description: >- Expandable. The cardholder to whom this authorization belongs. nullable: true currency: type: string description: >- The currency of the cardholder. This currency can be different from the currency presented at authorization and the merchant_currency field on this authorization. metadata: type: object properties: {} description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. x-apifox-orders: [] x-apifox-ignore-properties: [] status: type: string enum: - closed - pending - reversed description: The current status of the authorization in its lifecycle. x-apifox-enum: - name: '' value: closed description: >- The authorization was declined or captured through one or more transactions. - name: '' value: pending description: >- The authorization was created and is awaiting approval or was approved and is awaiting capture. - name: '' value: reversed description: >- The authorization was reversed by the merchant or expired without capture. object: type: string description: >- String representing the object’s type. Objects of the same type share the same value. created: type: integer 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. merchant_currency: type: string description: >- The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the currency field on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency. merchant_amount: type: string description: >- The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency. transactions: type: array items: type: object x-apifox-refs: 01HTBT17J8Y2X0800N7Q8MDY02: &ref_70 $ref: '#/components/schemas/The%20Transaction%20object' x-apifox-overrides: balance_transaction: null amount_details: null purchase_details: null token: null wallet: null x-apifox-orders: - 01HTBT17J8Y2X0800N7Q8MDY02 properties: id: type: string description: Unique identifier for the object. object: type: string description: >- String representing the object’s type. Objects of the same type share the same value. amount: type: integer description: The transaction amount (minor unit) authorization: type: string description: >- The Authorization object that led to this transaction. card: type: string description: The card used to make this transaction. cardholder: type: string description: The cardholder to whom this transaction belongs. currency: type: string description: >- Three-letter ISO currency code, in lowercase. Must be a supported currency. metadata: type: object properties: {} x-apifox-orders: [] description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. x-apifox-ignore-properties: [] type: type: string description: The nature of the transaction. enum: - capture - refund x-apifox-enum: - name: '' value: capture description: >- Funds were captured by the acquirer. amount will be negative as funds are moving out of your balance. - name: '' value: refund description: >- An acquirer initiated a refund. This transaction might not be linked to an original capture, for example credits are original transactions. amount will be positive for refunds created: type: string description: >- Time at which the object was created. Measured in seconds since the Unix epoch. dispute: type: string description: >- If you’ve disputed the transaction, the ID of the dispute. 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. merchant_amount: type: integer description: >- The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency. merchant_currency: type: string description: >- The currency with which the merchant is taking payment. merchant_data: type: object properties: category: type: string description: >- A categorization of the seller’s type of business. category_code: type: string description: >- The merchant category code for the seller’s business city: type: string description: City where the seller is located country: type: string description: Country where the seller is located name: type: string description: Name of the seller network_id: type: string description: >- Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. postal_code: type: string description: Postal code where the seller is located state: type: string description: State where the seller is located terminal_id: type: string description: >- An ID assigned by the seller to the location of the sale. url: type: string description: URL provided by the merchant on a 3DS request x-apifox-orders: - category - category_code - city - country - name - network_id - postal_code - state - terminal_id - url description: >- Details about the seller (grocery store, e-commerce website, etc.) involved in this transaction. x-apifox-ignore-properties: [] network_data: type: object properties: authorization_code: type: string description: >- This field will be populated if the authorization message was approved. nullable: true processing_date: type: string description: （未实现） deprecated: true transaction_id: type: string description: The transaction ID from VISA network description: >- Details about the transaction, such as processing dates, set by the card network. x-apifox-orders: - authorization_code - processing_date - transaction_id x-apifox-ignore-properties: [] x-apifox-ignore-properties: - id - object - amount - authorization - card - cardholder - currency - metadata - type - created - dispute - livemode - merchant_amount - merchant_currency - merchant_data - network_data description: List of transactions associated with this authorization. merchant_data: *ref_0 network_data: type: object properties: transaction_id: type: string description: >- Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions description: >- Details about the authorization, such as identifiers, set by the card network. x-apifox-orders: - transaction_id required: - transaction_id x-apifox-ignore-properties: [] nullable: true fail_reason: type: string combinedStatus: type: string description: >- Combine approved and status field to simplify the status logic, enum value as PENDING, APPROVED, DECLINED, REVERSED required: - merchant_currency - merchant_amount - combinedStatus x-apifox-ignore-properties: - id - amount - approved - card - cardholder - currency - metadata - status - object - created - livemode - merchant_currency - merchant_amount - transactions - merchant_data - network_data - fail_reason - combinedStatus headers: {} x-apifox-name: OK security: - basic: [] x-apifox-folder: API Reference/Issuing/Authorizations x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/1296482/apis/api-160844370-run components: schemas: The Transaction object: type: object properties: id: &ref_71 type: string description: Unique identifier for the object. object: &ref_72 type: string description: >- String representing the object’s type. Objects of the same type share the same value. amount: &ref_73 type: integer description: The transaction amount (minor unit) authorization: &ref_74 type: string description: The Authorization object that led to this transaction. card: &ref_75 type: string description: The card used to make this transaction. cardholder: &ref_76 type: string description: The cardholder to whom this transaction belongs. currency: &ref_77 type: string description: >- Three-letter ISO currency code, in lowercase. Must be a supported currency. metadata: type: object properties: {} x-apifox-orders: &ref_78 [] description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. x-apifox-ignore-properties: [] type: &ref_79 type: string description: The nature of the transaction. enum: - capture - refund x-apifox-enum: - name: '' value: capture description: >- Funds were captured by the acquirer. amount will be negative as funds are moving out of your balance. - name: '' value: refund description: >- An acquirer initiated a refund. This transaction might not be linked to an original capture, for example credits are original transactions. amount will be positive for refunds created: &ref_80 type: string description: >- Time at which the object was created. Measured in seconds since the Unix epoch. dispute: &ref_81 type: string description: If you’ve disputed the transaction, the ID of the dispute. livemode: &ref_82 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. merchant_amount: &ref_83 type: integer description: >- The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency. merchant_currency: &ref_84 type: string description: The currency with which the merchant is taking payment. merchant_data: type: object properties: category: &ref_85 type: string description: A categorization of the seller’s type of business. category_code: &ref_86 type: string description: The merchant category code for the seller’s business city: &ref_87 type: string description: City where the seller is located country: &ref_88 type: string description: Country where the seller is located name: &ref_89 type: string description: Name of the seller network_id: &ref_90 type: string description: >- Identifier assigned to the seller by the card network. Different card networks may assign different network_id fields to the same merchant. postal_code: &ref_91 type: string description: Postal code where the seller is located state: &ref_92 type: string description: State where the seller is located terminal_id: &ref_93 type: string description: An ID assigned by the seller to the location of the sale. url: &ref_94 type: string description: URL provided by the merchant on a 3DS request x-apifox-orders: &ref_95 - category - category_code - city - country - name - network_id - postal_code - state - terminal_id - url description: >- Details about the seller (grocery store, e-commerce website, etc.) involved in this transaction. x-apifox-ignore-properties: [] network_data: type: object properties: authorization_code: &ref_96 type: string description: >- This field will be populated if the authorization message was approved. nullable: true processing_date: &ref_97 type: string description: （未实现） deprecated: true transaction_id: &ref_98 type: string description: The transaction ID from VISA network description: >- Details about the transaction, such as processing dates, set by the card network. x-apifox-orders: &ref_99 - authorization_code - processing_date - transaction_id x-apifox-ignore-properties: [] balance_transaction: type: string deprecated: true description: （未实现）ID of the balance transaction associated with this transaction. amount_details: type: object properties: {} description: >- （未实现）Detailed breakdown of amount components. These amounts are denominated in currency and in the smallest currency unit. x-apifox-orders: [] deprecated: true x-apifox-ignore-properties: [] purchase_details: type: string description: （未实现） deprecated: true token: type: string description: （未实现） deprecated: true wallet: type: string description: >- （未实现）The digital wallet used for this transaction. One of apple_pay, google_pay, or samsung_pay. deprecated: true x-apifox-orders: - id - object - amount - authorization - card - cardholder - currency - metadata - type - created - dispute - livemode - merchant_amount - merchant_currency - merchant_data - network_data - balance_transaction - amount_details - purchase_details - token - wallet x-apifox-ignore-properties: [] x-apifox-folder: '' The Cardholder object: type: object properties: id: &ref_2 type: string description: Unique identifier for the object. object: &ref_3 type: string description: >- Value is "issuing.cardholder". String representing the object’s type. Objects of the same type share the same value. billing: type: object properties: address: type: object properties: city: &ref_4 type: string description: City, district, suburb, town, or village. country: &ref_5 type: string description: Two-letter country code line1: &ref_6 type: string description: Address line 1 line2: &ref_7 type: string description: Address line 2 postal_code: &ref_8 type: string description: ZIP or postal code. state: &ref_9 type: string description: State, county, province, or region. x-apifox-orders: &ref_10 - city - country - line1 - line2 - postal_code - state description: The cardholder’s billing address. x-apifox-ignore-properties: [] x-apifox-orders: &ref_11 - address description: The cardholder’s billing information. x-apifox-ignore-properties: [] name: &ref_12 type: string description: The cardholder’s name. This will be printed on cards issued to them. email: &ref_13 type: string description: The cardholder’s email address. phone_number: &ref_14 type: string description: >- The cardholder’s phone number. This is required for all cardholders who will be creating EU cards. metadata: type: array items: type: object properties: {} x-apifox-orders: &ref_15 [] x-apifox-ignore-properties: [] description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. company: type: object properties: tax_id_provided: &ref_16 type: boolean description: Whether the company’s business ID number was provided. description: Additional information about a company cardholder. x-apifox-orders: &ref_17 - tax_id_provided x-apifox-ignore-properties: [] created: &ref_18 type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch. individual: type: object properties: card_issuing: type: object properties: user_terms_acceptance: type: object properties: date: &ref_19 type: integer description: >- The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. ip: &ref_20 type: string description: >- The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. user_agent: &ref_21 type: string description: >- The user agent of the browser from which the cardholder accepted the Authorized User Terms. x-apifox-orders: &ref_22 - date - ip - user_agent x-apifox-ignore-properties: [] x-apifox-orders: &ref_23 - user_terms_acceptance description: >- Information related to the card_issuing program for this cardholder. x-apifox-ignore-properties: [] dob: type: object properties: day: &ref_24 type: integer description: The day of birth, between 1 and 31. month: &ref_25 type: integer description: The month of birth, between 1 and 12. year: &ref_26 type: integer description: The four-digit year of birth. x-apifox-orders: &ref_27 - day - month - year description: The date of birth of this cardholder. x-apifox-ignore-properties: [] first_name: &ref_28 type: string description: >- The first name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. last_name: &ref_29 type: string description: >- The last name of this cardholder. Required before activating Cards. This field cannot contain any numbers, special characters (except periods, commas, hyphens, spaces and apostrophes) or non-latin letters. verification: type: object properties: document: type: object properties: back: &ref_30 type: string description: >- The back of a document returned by a file upload with a purpose value of identity_document. front: &ref_31 type: string description: >- The front of a document returned by a file upload with a purpose value of identity_document. x-apifox-orders: &ref_32 - back - front description: An identifying document, either a passport or local ID card. x-apifox-ignore-properties: [] x-apifox-orders: &ref_33 - document description: An identifying document, either a passport or local ID card. x-apifox-ignore-properties: [] description: Additional information about an individual cardholder. x-apifox-orders: &ref_34 - card_issuing - dob - first_name - last_name - verification x-apifox-ignore-properties: [] livemode: &ref_35 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. spending_controls: type: object properties: spending_limits: type: object properties: amount: &ref_36 type: integer description: >- Maximum amount allowed to spend per interval. This amount is in the card’s currency and in the smallest currency unit. interval: type: string enum: &ref_37 - per_authorization - daily - weekly - monthly - yearly - all_time description: Interval (or event) to which the amount applies. x-apifox-enum: - value: per_authorization name: '' description: Limit applies to each authorization. - value: daily name: '' description: Limit applies to a day, starting at midnight UTC. - value: weekly name: '' description: >- Limit applies to a week, starting on Sunday at midnight UTC - value: monthly name: '' description: Limit applies to a month, starting on the 1st. - value: yearly name: '' description: Limit applies to a year, starting on January 1st. - value: all_time name: '' description: Limit applies to all transactions. description: >- Limit spending with amount-based rules that apply across this cardholder’s cards. x-apifox-orders: &ref_38 - amount - interval x-apifox-ignore-properties: [] spending_limits_currency: &ref_39 type: string description: Currency of the amounts within spending_limits. description: Rules that control spending across this cardholder’s cards. x-apifox-orders: &ref_40 - spending_limits - spending_limits_currency x-apifox-ignore-properties: [] status: type: string description: >- Specifies whether to permit authorizations on this cardholder’s cards. enum: &ref_41 - active - inactive - blocked x-apifox-enum: - value: active name: '' description: Cards attached to this cardholder can approve authorizations. - value: inactive name: '' description: >- Cards attached to this cardholder will decline all authorizations with the cardholder_inactive reason. - value: blocked name: '' description: >- Cards attached to this cardholder will decline all authorizations without an authorization object created. This status is non-reversible. type: type: string description: One of individual or company. enum: &ref_42 - individual - company x-apifox-enum: - value: individual name: '' description: >- The cardholder is a person, and additional information includes first and last name, date of birth. - value: company name: '' description: >- The cardholder is a company or business entity, and additional information includes their tax ID. preferred_locales: type: string description: >- The cardholder’s preferred locales (languages), ordered by preference. Locales can be de, en, es, fr, or it. This changes the language of the 3D Secure flow and one-time password messages sent to the cardholder. deprecated: true requirements: type: object properties: disabled_reason: type: string description: >- If disabled_reason is present, all cards will decline authorizations with cardholder_verification_required reason. enum: - listed - under_review - rejected.listed - requirements.past_due x-apifox-enum: - value: listed name: '' description: >- Account might be on a prohibited persons or companies list. The past_due field contains information that you need to provide before the cardholder can approve authorizations. - value: under_review name: '' description: >- This cardholder has raised additional review. Wooshpay will make a decision and update the disabled_reason field. - value: rejected.listed name: '' description: >- Cardholder is rejected because they are on a third-party prohibited persons or companies list (such as financial services provider or government). Their status will be blocked. - value: requirements.past_due name: '' description: >- Cardholder has outstanding requirements. The past_due field contains information that you need to provide before the cardholder can activate cards. past_due: type: string description: >- Array of fields that need to be collected in order to verify and re-enable the cardholder. enum: - individual.card_issuing.user_terms_acceptance.ip - individual.card_issuing.user_terms_acceptance.date - individual.first_name - individual.last_name - individual.dob.day - individual.dob.month - individual.dob.year - individual.verification.document - company.tax_id x-apifox-enum: - value: individual.card_issuing.user_terms_acceptance.ip name: '' description: >- The IP address from which the Cardholder accepted their Authorized User Terms. Required for Celtic Spend Card users. - value: individual.card_issuing.user_terms_acceptance.date name: '' description: >- The Unix timestamp marking when the Cardholder accepted their Authorized User Terms. Required for Celtic Spend Card users. - value: individual.first_name name: '' description: The cardholder’s legal first name. - value: individual.last_name name: '' description: The cardholder’s legal last name. - value: individual.dob.day name: '' description: The cardholder’s date of birth’s day. - value: individual.dob.month name: '' description: The cardholder’s date of birth’s month. - value: individual.dob.year name: '' description: The cardholder’s date of birth’s year. - value: individual.verification.document name: '' description: >- The front and back of a government-issued form of identification. - value: company.tax_id name: '' description: The cardholder’s business number (Tax ID). description: Information about verification requirements for the cardholder. x-apifox-orders: - disabled_reason - past_due deprecated: true x-apifox-ignore-properties: [] x-apifox-orders: - id - object - billing - name - email - phone_number - metadata - company - created - individual - livemode - spending_controls - status - type - preferred_locales - requirements x-apifox-ignore-properties: [] x-apifox-folder: '' The Card object: type: object properties: id: &ref_44 type: string description: Unique identifier for the object. cancellation_reason: &ref_45 type: string description: The reason why the card was canceled. enum: - lost - stolen - design_rejected x-apifox-enum: - name: '' value: lost description: The card was lost. - name: '' value: stolen description: The card was stolen. - name: '' value: design_rejected description: The design of this card was rejected by Wooshpay currency: &ref_46 type: string description: Three-letter ISO currency code. type: &ref_47 type: string description: The type of the card. enum: - virtual x-apifox-enum: - name: '' value: virtual description: No physical card will be printed. cardholder: description: The Cardholder object to which the card belongs. type: object x-apifox-refs: &ref_48 01HTBRDQTR7C3Y5P119S5R60DF: *ref_1 x-apifox-orders: &ref_49 - 01HTBRDQTR7C3Y5P119S5R60DF properties: id: *ref_2 object: *ref_3 billing: type: object properties: address: type: object properties: city: *ref_4 country: *ref_5 line1: *ref_6 line2: *ref_7 postal_code: *ref_8 state: *ref_9 x-apifox-orders: *ref_10 description: The cardholder’s billing address. x-apifox-ignore-properties: [] x-apifox-orders: *ref_11 description: The cardholder’s billing information. x-apifox-ignore-properties: [] name: *ref_12 email: *ref_13 phone_number: *ref_14 metadata: type: array items: type: object properties: {} x-apifox-orders: *ref_15 x-apifox-ignore-properties: [] description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. company: type: object properties: tax_id_provided: *ref_16 description: Additional information about a company cardholder. x-apifox-orders: *ref_17 x-apifox-ignore-properties: [] created: *ref_18 individual: type: object properties: card_issuing: type: object properties: user_terms_acceptance: type: object properties: date: *ref_19 ip: *ref_20 user_agent: *ref_21 x-apifox-orders: *ref_22 x-apifox-ignore-properties: [] x-apifox-orders: *ref_23 description: >- Information related to the card_issuing program for this cardholder. x-apifox-ignore-properties: [] dob: type: object properties: day: *ref_24 month: *ref_25 year: *ref_26 x-apifox-orders: *ref_27 description: The date of birth of this cardholder. x-apifox-ignore-properties: [] first_name: *ref_28 last_name: *ref_29 verification: type: object properties: document: type: object properties: back: *ref_30 front: *ref_31 x-apifox-orders: *ref_32 description: >- An identifying document, either a passport or local ID card. x-apifox-ignore-properties: [] x-apifox-orders: *ref_33 description: An identifying document, either a passport or local ID card. x-apifox-ignore-properties: [] description: Additional information about an individual cardholder. x-apifox-orders: *ref_34 x-apifox-ignore-properties: [] livemode: *ref_35 spending_controls: type: object properties: spending_limits: type: object properties: amount: *ref_36 interval: type: string enum: *ref_37 description: Interval (or event) to which the amount applies. x-apifox-enum: - value: per_authorization name: '' description: Limit applies to each authorization. - value: daily name: '' description: Limit applies to a day, starting at midnight UTC. - value: weekly name: '' description: >- Limit applies to a week, starting on Sunday at midnight UTC - value: monthly name: '' description: Limit applies to a month, starting on the 1st. - value: yearly name: '' description: Limit applies to a year, starting on January 1st. - value: all_time name: '' description: Limit applies to all transactions. description: >- Limit spending with amount-based rules that apply across this cardholder’s cards. x-apifox-orders: *ref_38 x-apifox-ignore-properties: [] spending_limits_currency: *ref_39 description: Rules that control spending across this cardholder’s cards. x-apifox-orders: *ref_40 x-apifox-ignore-properties: [] status: type: string description: >- Specifies whether to permit authorizations on this cardholder’s cards. enum: *ref_41 x-apifox-enum: - value: active name: '' description: >- Cards attached to this cardholder can approve authorizations. - value: inactive name: '' description: >- Cards attached to this cardholder will decline all authorizations with the cardholder_inactive reason. - value: blocked name: '' description: >- Cards attached to this cardholder will decline all authorizations without an authorization object created. This status is non-reversible. type: type: string description: One of individual or company. enum: *ref_42 x-apifox-enum: - value: individual name: '' description: >- The cardholder is a person, and additional information includes first and last name, date of birth. - value: company name: '' description: >- The cardholder is a company or business entity, and additional information includes their tax ID. x-apifox-ignore-properties: - id - object - billing - name - email - phone_number - metadata - company - created - individual - livemode - spending_controls - status - type exp_month: &ref_50 type: integer description: The expiration month of the card. exp_year: &ref_51 type: integer description: The expiration year of the card. first6: &ref_52 type: string description: The first 6 digits of the card number. binCode: &ref_53 type: string description: The first 6 digits of the card number. last4: &ref_54 type: string description: The last 4 digits of the card number. metadata: type: object properties: cardNick: &ref_55 type: string description: Identify the card nickname x-apifox-orders: &ref_56 - cardNick description: 'Set of key-value pairs that you can attach to an object. ' required: - cardNick x-apifox-ignore-properties: [] status: &ref_57 type: string description: >- Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to inactive. enum: - active - inactive - canceled x-apifox-enum: - name: '' value: active description: >- The card can approve authorizations. If the card is linked to a cardholder with past-due requirements, you may be unable to change the card’s status to ‘active’. - name: '' value: inactive description: >- The card will decline authorizations with the card_inactive reason. - name: '' value: canceled description: >- The card will decline authorizations, and no authorization object will be recorded. This status is permanent. object: &ref_58 type: string description: Value is "issuing.card" brand: &ref_59 type: string description: The brand of the card. created: &ref_60 type: string description: >- Time at which the object was created. Measured in seconds since the Unix epoch. cvc: &ref_61 type: string description: >- The card’s CVC. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it’s only available via the “Retrieve a card” endpoint, not via “List all cards” or any other endpoint. This field is not included by default. To include it in the response, expand the cvc field. nullable: true livemode: &ref_62 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. number: &ref_63 type: string description: >- The full unredacted card number. For security reasons, this is only available for virtual cards, and will be omitted unless you explicitly request it with the expand parameter. Additionally, it’s only available via the “Retrieve a card” endpoint, not via “List all cards” or any other endpoint. This field is not included by default. To include it in the response, expand the number field. nullable: true spending_controls: type: object properties: spending_limits: type: array items: type: object properties: amount: &ref_64 type: string description: Maximum amount allowed to spend per interval. interval: &ref_65 type: string description: Interval (or event) to which the amount applies. enum: - all_time - daily - monthly - yearly - per_authorization x-apifox-enum: - name: '' value: all_time description: Limit applies to all transactions. - name: '' value: daily description: Limit applies to a day, starting at midnight UTC. - name: '' value: monthly description: >- Limit applies to a month, starting on the 1st at midnight UTC. - name: '' value: yearly description: >- Limit applies to a year, starting on January 1st at midnight UTC. - name: '' value: per_authorization description: Limit applies to each authorization. x-apifox-orders: &ref_66 - amount - interval required: - amount - interval x-apifox-ignore-properties: [] description: >- Limit spending with amount-based rules that apply across any cards this card replaced spending_limits_currency: &ref_67 type: string description: >- Currency of the amounts within spending_limits. Always the same as the currency of the card. nullable: true description: >- Rules that control spending for this card. The all_time and per_authorization rules are required. x-apifox-orders: &ref_68 - spending_limits - spending_limits_currency required: - spending_limits x-apifox-ignore-properties: [] replacement_reason: type: string description: (未完成) The reason why the previous card needed to be replaced. enum: - lost - stolen - damaged - expired deprecated: true x-apifox-enum: - name: '' value: lost description: >- The card was lost. This status is only valid if the card it replaces is marked as lost. - name: '' value: stolen description: >- The card was stolen. This status is only valid if the card it replaces is marked as stolen. - name: '' value: damaged description: >- The physical card has been damaged and cannot be used at terminals. This reason is only valid for cards of type physical. - name: '' value: expired description: The expiration date has passed or is imminent. replaced_by: type: string description: (未完成) The latest card that replaces this card, if any. deprecated: true replacement_for: type: string description: (未完成) The card this card replaces, if any. deprecated: true shipping: type: object properties: address: type: object properties: city: type: string description: City, district, suburb, town, or village. country: type: string description: Two-letter country code line1: type: string description: Address line 1 line2: type: string description: Address line 2 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: [] carrier: type: string description: The delivery company that shipped a card. customs: type: object properties: eori_number: type: string x-apifox-orders: - eori_number x-apifox-ignore-properties: [] eta: type: string name: type: string phone_number: type: string require_signature: type: boolean service: type: string status: type: string tracking_number: type: string tracking_url: type: string type: type: string description: (未完成) Where and how the card will be shipped. x-apifox-orders: - address - carrier - customs - eta - name - phone_number - require_signature - service - status - tracking_number - tracking_url - type deprecated: true x-apifox-ignore-properties: [] wallets: type: object properties: {} description: >- (未完成) Information relating to digital wallets (like Apple Pay and Google Pay). x-apifox-orders: [] deprecated: true x-apifox-ignore-properties: [] card_product_code: &ref_69 type: string description: >- The code representing a group of card features, such as currency, brand, bin code, supporting 3ds or not and so on. You can get them from open API [List all card bins]. x-apifox-orders: - id - cancellation_reason - currency - type - cardholder - exp_month - exp_year - first6 - binCode - last4 - metadata - status - object - brand - created - cvc - livemode - number - spending_controls - replacement_reason - replaced_by - replacement_for - shipping - wallets - card_product_code required: - binCode - spending_controls x-apifox-ignore-properties: [] x-apifox-folder: '' The Authorization object: type: object properties: id: type: string description: Unique identifier for the object. amount: type: integer description: >- The total amount that was authorized or rejected. This amount is in currency and in the smallest currency unit. Amount should be the same as merchant_amount, unless currency and merchant_currency are different. approved: type: boolean card: description: Card associated with this authorization type: object x-apifox-refs: 01HTBRHM7NTTZFX76Y153R8R4R: *ref_43 x-apifox-orders: - 01HTBRHM7NTTZFX76Y153R8R4R properties: id: *ref_44 cancellation_reason: *ref_45 currency: *ref_46 type: *ref_47 cardholder: description: The Cardholder object to which the card belongs. type: object x-apifox-refs: *ref_48 x-apifox-orders: *ref_49 properties: id: *ref_2 object: *ref_3 billing: type: object properties: address: type: object properties: city: *ref_4 country: *ref_5 line1: *ref_6 line2: *ref_7 postal_code: *ref_8 state: *ref_9 x-apifox-orders: *ref_10 description: The cardholder’s billing address. x-apifox-ignore-properties: [] x-apifox-orders: *ref_11 description: The cardholder’s billing information. x-apifox-ignore-properties: [] name: *ref_12 email: *ref_13 phone_number: *ref_14 metadata: type: array items: type: object properties: {} x-apifox-orders: *ref_15 x-apifox-ignore-properties: [] description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. company: type: object properties: tax_id_provided: *ref_16 description: Additional information about a company cardholder. x-apifox-orders: *ref_17 x-apifox-ignore-properties: [] created: *ref_18 individual: type: object properties: card_issuing: type: object properties: user_terms_acceptance: type: object properties: date: *ref_19 ip: *ref_20 user_agent: *ref_21 x-apifox-orders: *ref_22 x-apifox-ignore-properties: [] x-apifox-orders: *ref_23 description: >- Information related to the card_issuing program for this cardholder. x-apifox-ignore-properties: [] dob: type: object properties: day: *ref_24 month: *ref_25 year: *ref_26 x-apifox-orders: *ref_27 description: The date of birth of this cardholder. x-apifox-ignore-properties: [] first_name: *ref_28 last_name: *ref_29 verification: type: object properties: document: type: object properties: back: *ref_30 front: *ref_31 x-apifox-orders: *ref_32 description: >- An identifying document, either a passport or local ID card. x-apifox-ignore-properties: [] x-apifox-orders: *ref_33 description: >- An identifying document, either a passport or local ID card. x-apifox-ignore-properties: [] description: Additional information about an individual cardholder. x-apifox-orders: *ref_34 x-apifox-ignore-properties: [] livemode: *ref_35 spending_controls: type: object properties: spending_limits: type: object properties: amount: *ref_36 interval: type: string enum: *ref_37 description: Interval (or event) to which the amount applies. x-apifox-enum: - value: per_authorization name: '' description: Limit applies to each authorization. - value: daily name: '' description: >- Limit applies to a day, starting at midnight UTC. - value: weekly name: '' description: >- Limit applies to a week, starting on Sunday at midnight UTC - value: monthly name: '' description: Limit applies to a month, starting on the 1st. - value: yearly name: '' description: >- Limit applies to a year, starting on January 1st. - value: all_time name: '' description: Limit applies to all transactions. description: >- Limit spending with amount-based rules that apply across this cardholder’s cards. x-apifox-orders: *ref_38 x-apifox-ignore-properties: [] spending_limits_currency: *ref_39 description: Rules that control spending across this cardholder’s cards. x-apifox-orders: *ref_40 x-apifox-ignore-properties: [] status: type: string description: >- Specifies whether to permit authorizations on this cardholder’s cards. enum: *ref_41 x-apifox-enum: - value: active name: '' description: >- Cards attached to this cardholder can approve authorizations. - value: inactive name: '' description: >- Cards attached to this cardholder will decline all authorizations with the cardholder_inactive reason. - value: blocked name: '' description: >- Cards attached to this cardholder will decline all authorizations without an authorization object created. This status is non-reversible. type: type: string description: One of individual or company. enum: *ref_42 x-apifox-enum: - value: individual name: '' description: >- The cardholder is a person, and additional information includes first and last name, date of birth. - value: company name: '' description: >- The cardholder is a company or business entity, and additional information includes their tax ID. x-apifox-ignore-properties: - id - object - billing - name - email - phone_number - metadata - company - created - individual - livemode - spending_controls - status - type exp_month: *ref_50 exp_year: *ref_51 first6: *ref_52 binCode: *ref_53 last4: *ref_54 metadata: type: object properties: cardNick: *ref_55 x-apifox-orders: *ref_56 description: 'Set of key-value pairs that you can attach to an object. ' required: - cardNick x-apifox-ignore-properties: [] status: *ref_57 object: *ref_58 brand: *ref_59 created: *ref_60 cvc: *ref_61 livemode: *ref_62 number: *ref_63 spending_controls: type: object properties: spending_limits: type: array items: type: object properties: amount: *ref_64 interval: *ref_65 x-apifox-orders: *ref_66 required: - amount - interval x-apifox-ignore-properties: [] description: >- Limit spending with amount-based rules that apply across any cards this card replaced spending_limits_currency: *ref_67 description: >- Rules that control spending for this card. The all_time and per_authorization rules are required. x-apifox-orders: *ref_68 required: - spending_limits x-apifox-ignore-properties: [] card_product_code: *ref_69 required: - binCode - spending_controls x-apifox-ignore-properties: - id - cancellation_reason - currency - type - cardholder - exp_month - exp_year - first6 - binCode - last4 - metadata - status - object - brand - created - cvc - livemode - number - spending_controls - card_product_code cardholder: type: string description: Expandable. The cardholder to whom this authorization belongs. nullable: true currency: type: string description: >- The currency of the cardholder. This currency can be different from the currency presented at authorization and the merchant_currency field on this authorization. metadata: type: object properties: {} description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. x-apifox-orders: [] x-apifox-ignore-properties: [] status: type: string enum: - closed - pending - reversed description: The current status of the authorization in its lifecycle. x-apifox-enum: - name: '' value: closed description: >- The authorization was declined or captured through one or more transactions. - name: '' value: pending description: >- The authorization was created and is awaiting approval or was approved and is awaiting capture. - name: '' value: reversed description: >- The authorization was reversed by the merchant or expired without capture. object: type: string description: >- String representing the object’s type. Objects of the same type share the same value. created: type: integer 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. merchant_currency: type: string description: >- The local currency that was presented to the cardholder for the authorization. This currency can be different from the cardholder currency and the currency field on this authorization. Three-letter ISO currency code, in lowercase. Must be a supported currency. merchant_amount: type: string description: >- The amount that the merchant will receive, denominated in merchant_currency and in the smallest currency unit. It will be different from amount if the merchant is taking payment in a different currency. transactions: type: array items: type: object x-apifox-refs: 01HTBT17J8Y2X0800N7Q8MDY02: *ref_70 x-apifox-orders: - 01HTBT17J8Y2X0800N7Q8MDY02 properties: id: *ref_71 object: *ref_72 amount: *ref_73 authorization: *ref_74 card: *ref_75 cardholder: *ref_76 currency: *ref_77 metadata: type: object properties: {} x-apifox-orders: *ref_78 description: >- Set of key-value pairs that you can attach to an object. This can be useful for storing additional information about the object in a structured format. x-apifox-ignore-properties: [] type: *ref_79 created: *ref_80 dispute: *ref_81 livemode: *ref_82 merchant_amount: *ref_83 merchant_currency: *ref_84 merchant_data: type: object properties: category: *ref_85 category_code: *ref_86 city: *ref_87 country: *ref_88 name: *ref_89 network_id: *ref_90 postal_code: *ref_91 state: *ref_92 terminal_id: *ref_93 url: *ref_94 x-apifox-orders: *ref_95 description: >- Details about the seller (grocery store, e-commerce website, etc.) involved in this transaction. x-apifox-ignore-properties: [] network_data: type: object properties: authorization_code: *ref_96 processing_date: *ref_97 transaction_id: *ref_98 description: >- Details about the transaction, such as processing dates, set by the card network. x-apifox-orders: *ref_99 x-apifox-ignore-properties: [] x-apifox-ignore-properties: - id - object - amount - authorization - card - cardholder - currency - metadata - type - created - dispute - livemode - merchant_amount - merchant_currency - merchant_data - network_data description: List of transactions associated with this authorization. merchant_data: type: object properties: category: type: string category_code: type: string description: The merchant category code for the seller’s business city: type: string country: type: string name: type: string description: Name of the seller network_id: type: string postal_code: type: string state: type: string terminal_id: type: string url: type: string description: Details about the seller x-apifox-orders: - category - category_code - city - country - name - network_id - postal_code - state - terminal_id - url x-apifox-ignore-properties: [] request_history: type: array items: type: object properties: amount: type: integer description: >- The pending_request.amount at the time of the request, presented in your card’s currency and in the smallest currency unit approved: type: boolean description: Whether this request was approved. authorization_code: type: string description: >- This field will be populated if the authorization message was approved. nullable: true created: type: string description: >- Time at which the object was created. Measured in seconds since the Unix epoch. currency: type: string description: Three-letter ISO currency code merchant_amount: type: string merchant_currency: type: string reason: type: string description: When an authorization is approved or declined requested_at: type: string description: >- Time when the card network received an authorization request from the acquirer in UTC. Referred to by networks as transmission time. x-apifox-orders: - amount - approved - authorization_code - created - currency - merchant_amount - merchant_currency - reason - requested_at x-apifox-ignore-properties: [] description: >- History of every time a pending_request authorization was approved/declined. If the merchant changes the authorization by performing an incremental authorization, you can look at this field to see the previous requests for the authorization. This field can be helpful in determining why a given authorization was approved/declined. nullable: true network_data: type: object properties: transaction_id: type: string description: >- Unique identifier for the authorization assigned by the card network used to match subsequent messages, disputes, and transactions description: >- Details about the authorization, such as identifiers, set by the card network. x-apifox-orders: - transaction_id required: - transaction_id x-apifox-ignore-properties: [] nullable: true fail_reason: type: string balance_transactions: type: array items: $ref: '#/components/schemas/Balance%20Transactions' description: (未完成) pending_request: type: object properties: {} description: (未完成) x-apifox-orders: [] x-apifox-ignore-properties: [] nullable: true verification_data: type: object properties: {} x-apifox-orders: [] description: (未完成) x-apifox-ignore-properties: [] authorization_method: type: string description: (未完成) amount_details: type: object properties: atm_fee: type: string cashback_amount: type: string description: (未完成) x-apifox-orders: - atm_fee - cashback_amount x-apifox-ignore-properties: [] nullable: true wallet: type: string description: (未完成) nullable: true combinedStatus: type: string description: >- Combine approved and status field to simplify the status logic, enum value as PENDING, APPROVED, DECLINED, REVERSED x-apifox-orders: - id - amount - approved - card - cardholder - currency - metadata - status - object - created - livemode - merchant_currency - merchant_amount - transactions - merchant_data - request_history - network_data - fail_reason - balance_transactions - pending_request - verification_data - authorization_method - amount_details - wallet - combinedStatus required: - merchant_currency - merchant_amount - combinedStatus x-apifox-ignore-properties: [] x-apifox-folder: '' Balance Transactions: type: object properties: id: type: string description: Unique identifier for the object. object: type: string description: >- Value is "balance_transaction". String representing the object’s type. Objects of the same type share the same value. amount: type: integer description: >- Gross amount of this transaction (in pence). A positive value represents funds charged to another party, and a negative value represents funds sent to another party. currency: type: string description: >- Three-letter ISO currency code, in uppercase. Must be a supported currency. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. fee: type: integer description: >- Fees (in pence) paid for this transaction. Represented as a positive integer when assessed. fee_details: type: object properties: amount: type: string description: Amount of the fee, in cents. application: type: string description: ID of the Connect application that earned the fee. deprecated: true currency: type: string description: >- Three-letter ISO currency code, in lowercase. Must be a supported currency. description: type: string description: >- An arbitrary string attached to the object. Often useful for displaying to users. type: type: string description: 'Type of the fee, one of: application_fee, wooshpay_fee or tax.' description: Detailed breakdown of fees (in pence) paid for this transaction. x-apifox-orders: - amount - application - currency - description - type x-apifox-ignore-properties: [] net: type: integer description: >- Net impact to Wooshpay balance (in pence). A positive value represents incrementing a Wooshpay balance, and a negative value decrementing a Wooshpay balance. You can calculate the net impact of a transaction on a balance by amount - fee source: type: string description: This transaction relates to the Wooshpay object. status: type: string description: >- The transaction’s net funds status in the Wooshpay balance, which are either available or pending. type: type: string available_on: type: string description: >- The date that the transaction’s net funds become available in the Wooshpay balance. created: type: integer description: >- Time at which the object was created. Measured in seconds since the Unix epoch exchange_rate: type: string description: >- decimal. If applicable, this transaction uses an exchange rate. If money converts from currency A to currency B, then the amount in currency A, multipled by the exchange_rate, equals the amount in currency B. For example, if you charge a customer 10.00 EUR, the PaymentIntent’s amount is 1000 and currency is eur. If this converts to 12.34 USD in your Wooshpay account, the BalanceTransaction’s amount is 1234, its currency is usd, and the exchange_rate is 1.234. reporting_category: type: string deprecated: true x-apifox-orders: - id - object - amount - currency - description - fee - fee_details - net - source - status - type - available_on - created - exchange_rate - reporting_category required: - object x-apifox-ignore-properties: [] x-apifox-folder: '' securitySchemes: basic: type: http scheme: basic servers: - url: https://apitest.wooshpay.com description: 官网测试 security: - basic: [] ```