# Update a card ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /v1/issuing/cards/{id}: post: summary: Update a card deprecated: false description: >- Updates the specified Issuing Card object by setting the values of the parameters passed. Any parameters not provided will be left unchanged. tags: - API Reference/Issuing/Cards 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 requestBody: content: application/json: schema: type: object x-apifox-refs: 01HHGGZPTBQ1P9GCB1BK2GY7Y4: &ref_2 $ref: '#/components/schemas/The%20Card%20object' x-apifox-overrides: cardholder: null currency: null exp_month: null exp_year: null last4: null type: null object: null brand: null cvc: null shipping: null wallets: null replacement_reason: null replacement_for: null replaced_by: null number: null livemode: null created: null id: null cancellation_reason: &ref_0 type: string description: The reason why the card was canceled. enum: - lost - stolen x-apifox-enum: - name: '' value: lost description: The card was lost. - name: '' value: stolen description: The card was stolen. spending_controls: &ref_1 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 x-apifox-ignore-properties: [] description: >- Limit spending with amount-based rules that apply across any cards this card replaced nullable: true 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: ' hash Rules that control spending for this card.' x-apifox-orders: - spending_limits - spending_limits_currency x-apifox-ignore-properties: [] first6: null binCode: null card_product_code: null x-apifox-orders: - 01HHGGZPTBQ1P9GCB1BK2GY7Y4 - releaseBalanceOnFrozen properties: cancellation_reason: *ref_0 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. spending_controls: *ref_1 releaseBalanceOnFrozen: type: boolean description: >- Whether to release balance from card to account when freezing card. Default: true. x-apifox-ignore-properties: - cancellation_reason - metadata - status - spending_controls examples: {} responses: '200': description: '' content: application/json: schema: type: object x-apifox-refs: 01HHGH3HV7F2ZHDD0FF38DYJNQ: *ref_2 x-apifox-orders: - 01HHGH3HV7F2ZHDD0FF38DYJNQ 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: x-apifox-overrides: preferred_locales: null requirements: null type: object properties: {} 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 headers: {} x-apifox-name: OK security: - basic: [] x-apifox-folder: API Reference/Issuing/Cards x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/1296482/apis/api-133004238-run components: schemas: The Card object: type: object 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: '#/components/schemas/The%20Cardholder%20object' x-apifox-overrides: preferred_locales: null requirements: null x-apifox-orders: - 01HTBRDQTR7C3Y5P119S5R60DF properties: id: &ref_3 type: string description: Unique identifier for the object. object: &ref_4 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_5 type: string description: City, district, suburb, town, or village. country: &ref_6 type: string description: Two-letter country code line1: &ref_7 type: string description: Address line 1 line2: &ref_8 type: string description: Address line 2 postal_code: &ref_9 type: string description: ZIP or postal code. state: &ref_10 type: string description: State, county, province, or region. x-apifox-orders: &ref_11 - city - country - line1 - line2 - postal_code - state description: The cardholder’s billing address. x-apifox-ignore-properties: [] x-apifox-orders: &ref_12 - address description: The cardholder’s billing information. x-apifox-ignore-properties: [] name: &ref_13 type: string description: >- The cardholder’s name. This will be printed on cards issued to them. email: &ref_14 type: string description: The cardholder’s email address. phone_number: &ref_15 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_16 [] 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_17 type: boolean description: Whether the company’s business ID number was provided. description: Additional information about a company cardholder. x-apifox-orders: &ref_18 - tax_id_provided x-apifox-ignore-properties: [] created: &ref_19 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_20 type: integer description: >- The Unix timestamp marking when the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. ip: &ref_21 type: string description: >- The IP address from which the cardholder accepted the Authorized User Terms. Required for Celtic Spend Card users. user_agent: &ref_22 type: string description: >- The user agent of the browser from which the cardholder accepted the Authorized User Terms. x-apifox-orders: &ref_23 - date - ip - user_agent x-apifox-ignore-properties: [] x-apifox-orders: &ref_24 - user_terms_acceptance description: >- Information related to the card_issuing program for this cardholder. x-apifox-ignore-properties: [] dob: type: object properties: day: &ref_25 type: integer description: The day of birth, between 1 and 31. month: &ref_26 type: integer description: The month of birth, between 1 and 12. year: &ref_27 type: integer description: The four-digit year of birth. x-apifox-orders: &ref_28 - day - month - year description: The date of birth of this cardholder. x-apifox-ignore-properties: [] first_name: &ref_29 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_30 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_31 type: string description: >- The back of a document returned by a file upload with a purpose value of identity_document. front: &ref_32 type: string description: >- The front of a document returned by a file upload with a purpose value of identity_document. x-apifox-orders: &ref_33 - back - front description: >- An identifying document, either a passport or local ID card. x-apifox-ignore-properties: [] x-apifox-orders: &ref_34 - 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_35 - card_issuing - dob - first_name - last_name - verification x-apifox-ignore-properties: [] livemode: &ref_36 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_37 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_38 - 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_39 - amount - interval x-apifox-ignore-properties: [] spending_limits_currency: &ref_40 type: string description: Currency of the amounts within spending_limits. description: Rules that control spending across this cardholder’s cards. x-apifox-orders: &ref_41 - 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_42 - 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_43 - 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: [] 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: 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 Cardholder object: type: object properties: id: *ref_3 object: *ref_4 billing: type: object properties: address: type: object properties: city: *ref_5 country: *ref_6 line1: *ref_7 line2: *ref_8 postal_code: *ref_9 state: *ref_10 x-apifox-orders: *ref_11 description: The cardholder’s billing address. x-apifox-ignore-properties: [] x-apifox-orders: *ref_12 description: The cardholder’s billing information. x-apifox-ignore-properties: [] name: *ref_13 email: *ref_14 phone_number: *ref_15 metadata: type: array items: type: object properties: {} x-apifox-orders: *ref_16 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_17 description: Additional information about a company cardholder. x-apifox-orders: *ref_18 x-apifox-ignore-properties: [] created: *ref_19 individual: type: object properties: card_issuing: type: object properties: user_terms_acceptance: type: object properties: date: *ref_20 ip: *ref_21 user_agent: *ref_22 x-apifox-orders: *ref_23 x-apifox-ignore-properties: [] x-apifox-orders: *ref_24 description: >- Information related to the card_issuing program for this cardholder. x-apifox-ignore-properties: [] dob: type: object properties: day: *ref_25 month: *ref_26 year: *ref_27 x-apifox-orders: *ref_28 description: The date of birth of this cardholder. x-apifox-ignore-properties: [] first_name: *ref_29 last_name: *ref_30 verification: type: object properties: document: type: object properties: back: *ref_31 front: *ref_32 x-apifox-orders: *ref_33 description: An identifying document, either a passport or local ID card. x-apifox-ignore-properties: [] x-apifox-orders: *ref_34 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_35 x-apifox-ignore-properties: [] livemode: *ref_36 spending_controls: type: object properties: spending_limits: type: object properties: amount: *ref_37 interval: type: string enum: *ref_38 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_39 x-apifox-ignore-properties: [] spending_limits_currency: *ref_40 description: Rules that control spending across this cardholder’s cards. x-apifox-orders: *ref_41 x-apifox-ignore-properties: [] status: type: string description: >- Specifies whether to permit authorizations on this cardholder’s cards. enum: *ref_42 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_43 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: '' securitySchemes: basic: type: http scheme: basic servers: - url: https://apitest.wooshpay.com description: 官网测试 security: - basic: [] ```