WePay logo
      Nothing Found

Get a collection of payments

get/payments

The GET /payments call allows your platform to look up a collection of payments.

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.

minimum_amount
integer

Define the minimum value of the amount value for returned Payments (inclusive).

maximum_amount
integer

Define the maximum value of the amount value for returned Payments (inclusive).

owner_id
string

ID of the owner of the resource.

payment_method_type
string

Type of the payment method used. Possible values include: credit_card, payment_bank_ca, payment_bank_us.

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
payment_method_id
string

ID of the payment method used, generated by WePay when the payment method is created.

status
string

Status of the payment. Possible values include: pending, completed, failed, canceled.

Enum: Description
pending

This payment is processing, but is not yet included in the account's available or reserve balance. Find more information in the pending_reasons structure.

completed

This payment has finished processing, and is now available in either the account's available or reserved balance. Note: A payment can have a completed status and simultaneously have a refund or dispute issued against it.

… 2 more
reference_id
string

The reference_id to search for.

expand
string

Pass the payment_method value to expand the response to include the payment method's card_brand and last_four.

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. You can perform an HTTP GET to obtain the previous page.

next
required
string or null

An opaque path for the next page of results. You can perform an HTTP GET to obtain the next page.

required
Array of objects

An array of payment objects.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": "/payments?page=QVFQNUFBRVhpWFpzUGwxdncxNXN5bFgxUWhOd2RkNjJjWjYvdXFkNTFwZFowYi9EM2hJS25IRVBpS1NybkwrSWRIZE9vd00xZjNsQ1Q4ZUlJTVJTd0VmVnVXd3VxK2N1MHJ3RUUrL0VFVXRneUFxTG41TW5lcUxxRGRtd2YvODlMbjdnamk2S21qSDBhRkVsYW1EMGZUalljVVFHUThjWTB2Rm1lbUdxd3R0WjVjZEFPejUyWU1sOGdTTXRWUT09",
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "amount": 1000,
      • "amount_refunded": 1000,
      • "amount_disputed": 1000,
      • "auto_capture": false,
      • "capture_at": null,
      • "create_time": 1510080179,
      • "currency": "USD",
      • "custom_data": null,
      • "failure_reason": null,
      • "fee_amount": 0,
      • "id": "00000000-0000-0000-0000-0000767bf5cd",
      • "order": null,
      • "owner": {
        • "id": "be2b42e5-b808-40ae-9bbe-3291ab493f57",
        • "path": "/accounts/be2b42e5-b808-40ae-9bbe-3291ab493f57",
        • "resource": "accounts"
        },
      • "path": "/payments/00000000-0000-0000-0000-0000767bf5cd",
      • "payment_method": {
        • "id": "00000000-6363-0000-0000-000008b93a6e",
        • "path": "/payment_methods/00000000-6363-0000-0000-000008b93a6e",
        • "resource": "payment_methods"
        },
      • "pending_reasons": [
        • {
          • "details": [ ],
          • "reason_code": "PENDING_CAPTURE",
          • "reason_message": "Payment pending capture."
          }
        ],
      • "resource": "payments",
      • "status": "pending",
      • "authorization_code": "0224241",
      • "txnr_app_fee": null,
      • "txnr_merchant": null,
      • "initiated_by": "none",
      • "api_version": "3.0",
      • "reference_id": "dfeb052b-ae8c-4a69-b909-8d9ecdd7c742"
      },
    • {
      • "amount": 1000,
      • "amount_refunded": 1000,
      • "amount_disputed": 1000,
      • "auto_capture": false,
      • "capture_at": null,
      • "create_time": 1510079535,
      • "currency": "USD",
      • "custom_data": null,
      • "failure_reason": null,
      • "fee_amount": 0,
      • "id": "00000000-0000-0000-0000-00006fa82d45",
      • "order": {
        • "id": "be2b42e5-b808-40ae-9bbe-3291ab493f57",
        • "path": "/orders/be2b42e5-b808-40ae-9bbe-3291ab493f57",
        • "resource": "orders"
        },
      • "owner": {
        • "id": "be2b42e5-b808-40ae-9bbe-3291ab493f57",
        • "path": "/accounts/be2b42e5-b808-40ae-9bbe-3291ab493f57",
        • "resource": "accounts"
        },
      • "path": "/payments/00000000-0000-0000-0000-00006fa82d45",
      • "payment_method": {
        • "id": "00000000-6261-5553-0000-0000000001b8",
        • "path": "/payment_methods/00000000-6261-5553-0000-0000000001b8",
        • "resource": "payment_methods"
        },
      • "pending_reasons": [
        • {
          • "details": [ ],
          • "reason_code": "PROCESSING",
          • "reason_message": "Payment is being processed."
          }
        ],
      • "resource": "payments",
      • "status": "pending",
      • "authorization_code": "0224241",
      • "txnr_app_fee": null,
      • "txnr_merchant": null,
      • "initiated_by": "none",
      • "api_version": "3.0",
      • "reference_id": "d6a60610-3a7e-4b9d-b56f-9005b9cd18ac"
      }
    ]
}