close credit wallet
PATCHhttps://api.suger.cloud/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
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
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
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
{
"buyerID": "string",
"creationTime": "2024-07-29T15:51:28.071Z",
"currency": "string",
"expireTime": "2024-07-29T15:51:28.071Z",
"externalID": "string",
"id": "string",
"info": {
"closeDate": "2024-07-29T15:51:28.071Z",
"stripePaymentMethod": {
"bacs_debit": {
"fingerprint": "string",
"last4": "string",
"sort_code": "string"
},
"card": {
"brand": "amex",
"country": "string",
"display_brand": "string",
"exp_month": 0,
"exp_year": 0,
"fingerprint": "string",
"funding": "credit",
"last4": "string"
},
"created": 0,
"id": "string",
"livemode": true,
"object": "string",
"sepa_debit": {
"bank_code": "string",
"branch_code": "string",
"country": "string",
"fingerprint": "string",
"last4": "string"
},
"us_bank_account": {
"account_holder_type": "individual",
"account_type": "checking",
"bank_name": "string",
"fingerprint": "string",
"last4": "string",
"routing_number": "string"
}
},
"stripeSetupIntentId": "string"
},
"lastUpdateTime": "2024-07-29T15:51:28.071Z",
"name": "string",
"organizationID": "string",
"partner": "",
"startTime": "2024-07-29T15:51:28.071Z",
"status": "ACTIVE",
"totalAmount": 0,
"type": "ach_debit",
"usedAmount": 0
}
Bad request error
- application/json
- Schema
Schema
string
Internal server error
- application/json
- Schema
Schema
string
- curl
- python
- go
- nodejs
- ruby
- csharp
- php
- java
- powershell
- CURL
ResponseClear