Skip to main content

close credit wallet

PATCH 
/org/:orgId/buyer/:buyerId/wallet/:walletId/close

Close the given credit wallet, if it's a payment method, sync to payment provider too. Once closed, it can't be used for payment.

Request​

Path Parameters

    orgId stringrequired

    Organization ID

    buyerId stringrequired

    Buyer ID

    walletId stringrequired

    Wallet ID

Responses​

OK

Schema

    buyerID string
    creationTime date-time
    currency string
    expireTime date-time

    nullable

    externalID string

    The payment method id in payment provider, such as stripe payment method id.

    id string

    info

    object

    closeDate date-time

    The close date of the wallet if applicable.

    stripePaymentMethod

    object

    bacs_debit

    object

    fingerprint string

    Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

    last4 string

    Last four digits of the bank account number.

    sort_code string

    Sort code of the bank account. (e.g., 10-20-30)

    card

    object

    brand string

    Possible values: [amex, diners, discover, eftpos_au, jcb, mastercard, unionpay, visa, unknown]

    Card brand.

    country string

    Two-letter ISO code representing the country of the card. You could use this attribute to get a sense of the international breakdown of cards you've collected.

    display_brand string

    The brand to use when displaying the card, this accounts for customer's brand choice on dual-branded cards. Can be american_express, cartes_bancaires, diners_club, discover, eftpos_australia, interac, jcb, mastercard, union_pay, visa, or other and may contain more values in the future.

    exp_month integer

    Two-digit number representing the card's expiration month.

    exp_year integer

    Four-digit number representing the card's expiration year.

    fingerprint string

    Uniquely identifies this particular card number. You can use this attribute to check whether two customers who’ve signed up with you are using the same card number, for example. For payment methods that tokenize card information (Apple Pay, Google Pay), the tokenized number might be provided instead of the underlying card number.

    funding string

    Possible values: [credit, debit, prepaid, unknown]

    Card funding type. Can be credit, debit, prepaid, or unknown.

    last4 string

    The last four digits of the card.

    created integer

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

    id string

    Unique identifier for the payment method on stripe.

    livemode boolean

    Has the value true if the object exists in live mode or the value false if the object exists in test mode.

    object string

    String representing the object’s type. Always has the value payment_method.

    sepa_debit

    object

    bank_code string

    Bank code of bank associated with the bank account.

    branch_code string

    Branch code of bank associated with the bank account.

    country string

    Two-letter ISO code representing the country the bank account is located in.

    fingerprint string

    Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

    last4 string

    Last four characters of the IBAN.

    us_bank_account

    object

    account_holder_type string

    Possible values: [individual, company]

    Account holder type: individual or company.

    account_type string

    Possible values: [checking, savings]

    Account type: checkings or savings. Defaults to checking if omitted.

    bank_name string

    The name of the bank.

    fingerprint string

    Uniquely identifies this particular bank account. You can use this attribute to check whether two bank accounts are the same.

    last4 string

    Last four digits of the bank account number.

    routing_number string

    Routing number of the bank account.

    stripeSetupIntentId string
    lastUpdateTime date-time
    name string
    organizationID string
    partner Partner (string)

    Possible values: [``, ADYEN, ALIBABA, ANTHROPIC, AWS, AWS_CHINA, AZURE, CHARGEBEE, DATABRICKS, DOCUSIGN, GCP, GOOGLE, HUBSPOT, INTUIT, LAGO, MARKETO, METRONOME, MICROSOFT, OPENAI, ORACLE, ORB, REDHAT, SALESFORCE, SLACK, SNOWFLAKE, STRIPE, ZOHO]

    startTime date-time
    status BillingWalletStatus (string)

    Possible values: [ACTIVE, DELETED, PENDING_VERIFY, EXPIRED, CLOSED]

    totalAmount number
    type BillingWalletType (string)

    Possible values: [ach_debit, bacs_debit, card, credit, sepa_debit]

    usedAmount number
Loading...