WePay logo
      Nothing Found

Get a collection of payment methods

get/payment_methods

The GET /payment_methods call allows your platform to look up a collection of payment methods. Payment methods represent payment data like credit cards and bank accounts, and allow your platform to charge and accept money from a payer.

SecurityappIdAuth and appTokenAuth
Request
query Parameters
page
string

Return elements from this page.

page_size
integer [ 1 .. 50 ]
Default: 10

Return no more than this many elements per page. If not specified, page_size defaults to 10. Maximum value allowed is 50.

create_time_start
integer <int64> >= 0

The timestamp for the start of the search window.

create_time_end
integer <int64> >= 0

The timestamp for the end of the search window.

card_brand
string

The brand of the card to look up. Possible values include: amex, discover, mastercard, visa.

Enum: Description
visa
mastercard
… 4 more
card_last_four
string

The last four digits of the card to look up.

bank_routing_number
string

The routing number of the bank to look up.

bank_last_four
string

The last four numbers of the bank account. Note: If you have verified your account via Plaid, this might be the last four numbers of your tokenized bank account number (TAN).

type
string

The type of payment_method that should be searched. Possible values include: credit_card, payment_bank_us. Required unless "page" is provided.

Enum: Description
credit_card

This value is required if the credit_card structure is being sent with raw credit card data.

payment_bank_us

This value is required if the payment_bank_us structure is being sent with the raw bank account data.

… 1 more
header Parameters
Api-Version
required
string
Example: 3.0
Unique-Key
string
Responses
200
Response Schema: application/json
previous
required
string or null

An opaque path for the previous page of results. Perform an HTTP GET to obtain the previous page.

next
required
string or null

An opaque path for the next page of results. Perform an HTTP GET to obtain the next page.

required
Array of objects unique

An array of payment method objects.

api_version
string
400

INVALID_PARAMS

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": null,
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "create_time": 1512429187,
      • "credit_card": {
        • "auto_update": false,
        • "backing_display_name": null,
        • "bin": "400383",
        • "card_brand": "visa",
        • "card_entry_type": "card_keyed",
        • "card_holder": {
          • "address": {
            • "city": "",
            • "country": "US",
            • "line1": "",
            • "line2": "",
            • "postal_code": "94040",
            • "region": ""
            },
          • "email": "bob@example.com",
          • "holder_name": "Bob Belcher",
          • "phone": {
            • "country_code": null,
            • "phone_number": null,
            • "type": null
            }
          },
        • "display_name": "Visa xxxxxx4018",
        • "expiration_month": 10,
        • "expiration_year": 2019,
        • "last_four": "4018",
        • "virtual_terminal_mode": null,
        • "card_on_file": false,
        • "recurring": false,
        • "cvv_provided": true,
        • "card_funding": "credit",
        • "bin_details": {
          • "is_prepaid": false
          }
        },
      • "custom_data": null,
      • "id": "00000000-6363-0000-0000-00003be52b59",
      • "owner": {
        • "id": "171845",
        • "path": null,
        • "resource": "applications"
        },
      • "path": "/payment_methods/00000000-6363-0000-0000-00003be52b59",
      • "resource": "payment_methods",
      • "status": "verified",
      • "type": "credit_card",
      • "api_version": "3.0"
      },
    • {
      • "create_time": 1512429187,
      • "credit_card": {
        • "auto_update": false,
        • "backing_display_name": null,
        • "bin": "400383",
        • "card_brand": "visa",
        • "card_entry_type": "card_keyed",
        • "card_holder": {
          • "address": {
            • "city": "",
            • "country": "US",
            • "line1": "",
            • "line2": "",
            • "postal_code": "94040",
            • "region": ""
            },
          • "email": "bob@example.com",
          • "holder_name": "Bob Belcher",
          • "phone": {
            • "country_code": null,
            • "phone_number": null,
            • "type": null
            }
          },
        • "display_name": "Visa xxxxxx4018",
        • "expiration_month": 10,
        • "expiration_year": 2019,
        • "last_four": "4018",
        • "virtual_terminal_mode": null,
        • "card_on_file": false,
        • "recurring": false,
        • "cvv_provided": true,
        • "card_funding": null,
        • "bin_details": {
          • "is_prepaid": null
          }
        },
      • "custom_data": null,
      • "id": "00000000-6363-0000-0000-00003be52b59",
      • "owner": {
        • "id": "171845",
        • "path": null,
        • "resource": "applications"
        },
      • "path": "/payment_methods/00000000-6363-0000-0000-00003be52b59",
      • "resource": "payment_methods",
      • "status": "verified",
      • "type": "credit_card",
      • "api_version": "3.0"
      },
    • {
      • "create_time": 1512429187,
      • "credit_card": {
        • "auto_update": false,
        • "backing_display_name": null,
        • "bin": "400383",
        • "card_brand": "visa",
        • "card_entry_type": "card_keyed",
        • "card_holder": {
          • "address": {
            • "city": "",
            • "country": "US",
            • "line1": "",
            • "line2": "",
            • "postal_code": "94040",
            • "region": ""
            },
          • "email": "bob@example.com",
          • "holder_name": "Bob Belcher",
          • "phone": {
            • "country_code": null,
            • "phone_number": null,
            • "type": null
            }
          },
        • "display_name": "Visa xxxxxx4018",
        • "expiration_month": 10,
        • "expiration_year": 2019,
        • "last_four": "4018",
        • "virtual_terminal_mode": null,
        • "card_on_file": false,
        • "recurring": false,
        • "cvv_provided": true
        },
      • "custom_data": null,
      • "id": "00000000-6363-0000-0000-00003be52b59",
      • "owner": {
        • "id": "171845",
        • "path": null,
        • "resource": "applications"
        },
      • "path": "/payment_methods/00000000-6363-0000-0000-00003be52b59",
      • "resource": "payment_methods",
      • "status": "verified",
      • "type": "credit_card",
      • "api_version": "3.0"
      }
    ]
}