WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Cards
  • 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
      • Update a cardholder
      • Retrieve a cardholder
      • List all cardholders
    • Cards
      • Create a card
        POST
      • Update a card
        POST
      • Retrieve a card
        GET
      • List all cards
        GET
      • Retrieve card remaining limits
        GET
    • 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. Cards

List all cards

GET
/v1/issuing/cards
Returns a list of Issuing Card 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 *****************
Query Params
cardholder
string 
optional
Only return cards belonging to the Cardholder with the provided ID.
type
string 
optional
Only return cards that have the given type. One of virtual or physical.
limit
string 
optional
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
created [gt]
string 
optional
Return results where the created field is greater than this value.
created [gte]
string 
optional
Return results where the created field is greater than or equal to this value.
created [lt]
string 
optional
Return results where the created field is less than this value.
created [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.
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.
exp_month
string 
optional
Only return cards that have the given expiration month.
exp_year
string 
optional
Only return cards that have the given expiration year.
last4
string 
optional
Only return cards that have the given last four digits.
status
string 
optional
Only return cards that have the given status. One of active, inactive, or canceled.
Header Params
Accept
string 
required
Default:
application/json
Content-Type
string 
required
Default:
application/json

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 -g --request GET 'https://apitest.wooshpay.com/v1/issuing/cards?cardholder&type&limit&created [gt]&created [gte]&created [lt]&created [lte]&ending_before&starting_after&exp_month&exp_year&last4&status' \
--header 'Accept;' \
--header 'Authorization: Basic Og=='

Responses

🟢200OK
application/json
Body
object
string 
optional
Default:
"list"
url
string 
optional
has_more
boolean 
optional
data
array [object {16}] 
optional
id
string 
optional
Unique identifier for the object.
cancellation_reason
enum<string> 
optional
The reason why the card was canceled.
Allowed values:
loststolendesign_rejected
currency
string 
optional
Three-letter ISO currency code.
type
enum<string> 
optional
The type of the card.
Allowed value:
virtual
cardholder
object 
optional
The Cardholder object to which the card belongs.
exp_month
integer 
optional
The expiration month of the card.
exp_year
integer 
optional
The expiration year of the card.
first6
string 
optional
The first 6 digits of the card number.
last4
string 
optional
The last 4 digits of the card number.
metadata
string 
optional
Set of key-value pairs that you can attach to an object.
status
enum<string> 
optional
Whether authorizations can be approved on this card. May be blocked from activating cards depending on past-due Cardholder requirements. Defaults to inactive.
Allowed values:
activeinactivecanceled
object
string 
optional
Value is "issuing.card"
brand
string 
optional
The brand of the card.
created
string 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
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
hash Rules that control spending for this card.
Example
{
    "object": "\"list\"",
    "url": "string",
    "has_more": true,
    "data": [
        {
            "id": "string",
            "cancellation_reason": "lost",
            "currency": "string",
            "type": "virtual",
            "cardholder": {
                "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"
            },
            "exp_month": 0,
            "exp_year": 0,
            "first6": "string",
            "last4": "string",
            "metadata": "string",
            "status": "active",
            "object": "string",
            "brand": "string",
            "created": "string",
            "livemode": true,
            "spending_controls": {
                "spending_limits": [
                    {
                        "amount": "string",
                        "interval": "all_time"
                    }
                ],
                "spending_limits_currency": "string"
            }
        }
    ]
}
Previous
Retrieve a card
Next
Retrieve card remaining limits
Built with