WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Cardholders
  • API Introduction
  • Error Code
  • Payment Intents
    • Create a PaymentIntent
      POST
    • Update a PaymentIntent
      POST
    • Cancel a PaymentIntent
      POST
    • Capture a PaymentIntent
      POST
    • Confirm a PaymentIntent
      POST
    • Retrieve a PaymentIntent
      GET
    • List all PaymentIntents
      GET
    • Search PaymentIntents
      GET
  • Charges
    • Retrieve a charge
      GET
    • List all charges
      GET
  • Payment Methods
    • Create a PaymentMethod
      POST
    • Retrieve a PaymentMethod
      GET
    • Retrieve a Customer's PaymentMethod
      GET
    • Update a PaymentMethod
      POST
    • List PaymentMethods
      GET
    • List a Customer's PaymentMethods
      GET
    • Attach a PaymentMethod to a Customer
      POST
    • Detach a PaymentMethod from a Customer
      POST
  • Refunds
    • Create a refund
    • Retrieve a refund
  • Webhooks
    • Create a Webhook
    • List All Webhooks
    • Retrieve a Webhook
    • Delete a Webhook
    • Update a Webhook
  • Events
    • Types of events
    • Retrieve an event
  • Files
    • Files
    • Create a file
    • Retrieve a file
  • Disputes
    • Retrieve a dispute
    • Update a dispute
    • Close a dispute
    • List all disputes
  • Payouts
    • Beneficiary
      • Create a beneficiary
      • Retrieve a beneficiary
      • List all beneficiaries
      • Update a beneficiary
      • Delete a beneficiary
    • Payouts
      • Create a payout
      • Retrieve a Payout
      • Update a Payout
      • List All Payouts
  • Balance
    • Get balance
  • Products
    • Create a Product
    • Retrieve a product
    • Update a product
    • List all products
  • Prices
    • Create a price
    • Retrieve a price
    • Update a price
  • Payment Links
    • Create a payment link
    • Update a payment link
    • Retrieve payment link
    • List all payment links
    • Retrieve a payment link's line items
  • Checkout
    • Create a Session
    • Expire a Session
    • Retreive a Session
    • List All Checkout Sessions
    • Retrieve a Checkout Session's line items
  • Customers
    • Create a customer
    • Retrieve a customer
    • Update a customer
  • Invoices
    • Setup Intents
      • Create a SetupIntent
      • Retrieve a SetupIntent
      • Cancel a SetupIntent
      • List all SetupIntents
      • List all SetupAttempts
      • Update a SetupIntent
      • Confirm a SetupIntent
    • Create an invoice
    • Retrieve an invoice
    • Finalize an invoice
    • Send an invoice for manual payment
    • Delete a draft invoice
    • Void an invoice
    • List all invoices
    • Pay an invoice
  • Invoice Items
    • Create an invoice item
    • Retrieve an invoice item
  • Invoice Line Item
    • Bulk add invoice line items
  • Subscriptions
    • Create a subscription
    • Retrieve a subscription
    • Update a subscription
    • Cancel a subscription
    • List subscriptions
  • Subscription Items
    • Create a subscription item
    • Retrieve a subscription item
    • Delete a subscription item
  • Issuing
    • Authorizations
      • Retrieve an authorization
      • List all authorization
    • Cardholders
      • Create a cardholder
        POST
      • Update a cardholder
        POST
      • Retrieve a cardholder
        GET
      • List all cardholders
        GET
    • Cards
      • Create a card
      • Update a card
      • Retrieve a card
      • List all cards
      • Retrieve card remaining limits
    • Transactions
      • Update a transaction
      • Retrieve a transaction
      • List all transactions
  • Coupons
    • Create a Coupon
    • Retrieve a coupon
    • Delete a coupon
  • Promotion Code
    • Create a promotion code
    • Update a promotion code
  • Accounts
    • Retrieve account's paymentmethods
  • Fx Quote
    • Create an FX Quote
  1. Cardholders

List all cardholders

GET
/v1/issuing/cardholders
Returns a list of Issuing Cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

Request

Authorization
Send your HTTP requests with an
Authorization
header that contains the word Basic followed by a space and a base64-encoded string username:password
Example:
Authorization: Basic *****************
Header Params
Accept
string 
required
Default:
application/json
Content-Type
string 
required
Default:
application/json
Body Params application/json
created
object 
optional
A filter on the list based on the object created field. The value can be a string with an integer Unix timestamp, or it can be a dictionary with the following options:
gt
string 
optional
Return results where the created field is greater than this value.
gte
string 
optional
Return results where the created field is greater than or equal to this value.
lt
string 
optional
Return results where the created field is less than this value.
lte
string 
optional
Return results where the created field is less than or equal to this value.
ending_before
string 
optional
A cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.
limit
integer 
optional
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
starting_after
string 
optional
A cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.
Example
{
    "created": {
        "gt": "string",
        "gte": "string",
        "lt": "string",
        "lte": "string"
    },
    "ending_before": "string",
    "limit": 0,
    "starting_after": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://apitest.wooshpay.com/v1/issuing/cardholders' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "created": {
        "gt": "string",
        "gte": "string",
        "lt": "string",
        "lte": "string"
    },
    "ending_before": "string",
    "limit": 0,
    "starting_after": "string"
}'

Responses

🟢200OK
application/json
Body
object
string 
optional
Default:
"list"
url
string 
optional
has_more
boolean 
optional
data
array [object {14}] 
optional
id
string 
optional
Unique identifier for the object.
object
string 
optional
Value is "issuing.cardholder". String representing the object’s type. Objects of the same type share the same value.
billing
object 
optional
The cardholder’s billing information.
name
string 
optional
The cardholder’s name. This will be printed on cards issued to them.
email
string 
optional
The cardholder’s email address.
phone_number
string 
optional
The cardholder’s phone number. This is required for all cardholders who will be creating EU cards.
metadata
array [object] 
optional
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
object 
optional
Additional information about a company cardholder.
created
integer 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
individual
object 
optional
Additional information about an individual cardholder.
livemode
boolean 
optional
Has the value true if the object exists in live mode or the value false if the object exists in test mode.
spending_controls
object 
optional
Rules that control spending across this cardholder’s cards.
status
enum<string> 
optional
Specifies whether to permit authorizations on this cardholder’s cards.
Allowed values:
activeinactiveblocked
type
enum<string> 
optional
One of individual or company.
Allowed values:
individualcompany
Example
{
    "object": "\"list\"",
    "url": "string",
    "has_more": true,
    "data": [
        {
            "id": "string",
            "object": "string",
            "billing": {
                "address": {
                    "city": "string",
                    "country": "string",
                    "line1": "string",
                    "line2": "string",
                    "postal_code": "string",
                    "state": "string"
                }
            },
            "name": "string",
            "email": "string",
            "phone_number": "string",
            "metadata": [
                {}
            ],
            "company": {
                "tax_id_provided": true
            },
            "created": 0,
            "individual": {
                "card_issuing": {
                    "user_terms_acceptance": {
                        "date": 0,
                        "ip": "string",
                        "user_agent": "string"
                    }
                },
                "dob": {
                    "day": 0,
                    "month": 0,
                    "year": 0
                },
                "first_name": "string",
                "last_name": "string",
                "verification": {
                    "document": {
                        "back": "string",
                        "front": "string"
                    }
                }
            },
            "livemode": true,
            "spending_controls": {
                "spending_limits": {
                    "amount": 0,
                    "interval": "per_authorization"
                },
                "spending_limits_currency": "string"
            },
            "status": "active",
            "type": "individual"
        }
    ]
}
Previous
Retrieve a cardholder
Next
Create a card
Built with