WooshPay OpenAPI
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Product DocumentAPI ReferenceJS SDK ReferenceSaaS Platform Integration
Back to WooshPay Website
  1. Payment Methods
  • 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
      POST
    • Retrieve a refund
      GET
  • Webhooks
    • Create a Webhook
      POST
    • List All Webhooks
      GET
    • Retrieve a Webhook
      GET
    • Delete a Webhook
      DELETE
    • Update a Webhook
      POST
  • 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
      • 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. Payment Methods

List PaymentMethods

GET
/v1/payment_methods/list
Returns a list of PaymentMethods

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
customer
string 
optional
The ID of the customer whose PaymentMethods will be retrieved.
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.
type
string 
optional
enum: "card"
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.
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
{
    "customer": "string",
    "ending_before": "string",
    "type": "string",
    "limit": "string",
    "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/payment_methods/list' \
--header 'Accept;' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic Og==' \
--data-raw '{
    "customer": "string",
    "ending_before": "string",
    "type": "string",
    "limit": "string",
    "starting_after": "string"
}'

Responses

🟢200OK
application/json
Body
id
string 
optional
Unique identifier for the object, like 'pm_xxxxx'
object
string 
optional
'payment method'
created
integer 
optional
Time at which the object was created. Measured in seconds since the Unix epoch.
customer
string 
optional
The ID of the Customer to which this PaymentMethod is saved. This will not be set when the PaymentMethod has not been saved to a Customer.
metadata
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.
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.
billing_details
object (Billing Details) 
optional
Billing information associated with the PaymentMethod that may be used or required by particular types of payment methods.
address
object (Address) 
optional
email
string 
optional
Email address.
name
string 
optional
Full name.
phone
string 
optional
Billing phone number (including extension).
type
enum<string> 
required
The type of the PaymentMethod. An additional object is included on the PaymentMethod with a name matching this value. It contains additional information specific to the PaymentMethod type.
Allowed values:
cardalipayplusalipaywechat_paysepa_debitalipay_hkboosttruemoneygcashkakaopaytouchngorabbit_line_paydanaklarnaidealgiropaysofortepstrustlybancontactp24unionpayfpxmcashgrabpaybank_transfer_idqrispromptpayovoshopeepayupiboletopaynowpix9paystitchbpi
card
object 
optional
If this is a card PaymentMethod, this object contains the user’s card details.
brand
string 
optional
American Express, Diners Club, Discover, JCB, MasterCard, UnionPay, Visa, or Unknown
checks
object 
optional
country
string 
optional
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.
exp_month
integer 
optional
Two-digit number representing the card’s expiration month.
exp_year
integer 
optional
Four-digit number representing the card’s expiration year.
fingerprint
string 
optional
Uniquely identifies this particular card number.
funding
string 
optional
Can be credit, debit, prepaid, or unknown.
last4
string 
optional
The last four digits of the card.
metadata
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.
Example
{
    "id": "string",
    "object": "string",
    "created": 0,
    "customer": "string",
    "metadata": {},
    "livemode": true,
    "billing_details": {
        "address": {
            "city": "string",
            "country": "string",
            "line1": "string",
            "line2": "string",
            "postal_code": "string",
            "state": "string"
        },
        "email": "string",
        "name": "string",
        "phone": "string"
    },
    "type": "card",
    "card": {
        "brand": "string",
        "checks": {
            "address_line1_check": "string",
            "address_zip_check": "string",
            "cvc_check": "string"
        },
        "country": "string",
        "exp_month": 0,
        "exp_year": 0,
        "fingerprint": "string",
        "funding": "string",
        "last4": "string",
        "metadata": {}
    }
}
Previous
Update a PaymentMethod
Next
List a Customer's PaymentMethods
Built with