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.
Clear
Core
Link