WePay logo
      Nothing Found

Get a collection of refunds

get/refunds

The GET /refunds call allows your platform to look up a collection of refunds. Refunds facilitate the return of money from the merchant to the 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.

minimum_amount
integer

Define the minimum value of the amount parameter you wish to see for returned Refunds (inclusive).

maximum_amount
integer

Define the maximum value of the amount parameter you wish to see for returned Refunds (inclusive).

owner_id
string

The ID of the owner of the resource.

payment_method_type
string

The payment method type to filter by.

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

The payment method ID to filter by.

status
string

The status of refunds to return.

Enum: Description
pending

The refund is processing, but the amount has not yet moved from the merchant to the payer's balance. Find more information in the pending_reason structure.

completed

The refund is complete, and will now be processed by the payer's banking institution.

… 1 more
payment_id
string

The payment ID to filter by.

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. 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

An array of refund objects.

api_version
string
400

INVALID_PARAMS

403

NOT_AUTHORIZED

500

UNEXPECTED_ERROR

Request samples 
Response samples 
application/json
{
  • "next": null,
  • "previous": null,
  • "api_version": "3.0",
  • "results": [
    • {
      • "amounts": {
        • "total_amount": 100,
        • "currency": "USD",
        • "fee_refund_amount": 0
        },
      • "create_time": 1509140695,
      • "custom_data": null,
      • "failure_reason": null,
      • "id": "9b53d5fd-17b1-400c-b197-3204f4d6171c",
      • "order": null,
      • "owner": {
        • "id": "40200612-e849-4172-8308-657cf3a0de27",
        • "path": "/accounts/40200612-e849-4172-8308-657cf3a0de2",
        • "resource": "accounts"
        },
      • "path": "/refunds/9b53d5fd-17b1-400c-b197-3204f4d6171c",
      • "payment": {
        • "id": "a8ca756e-5a62-4c2a-80fd-9b82563d47cb",
        • "path": "/payments/a8ca756e-5a62-4c2a-80fd-9b82563d47cb",
        • "resource": "payments"
        },
      • "payment_method": {
        • "id": "00000000-6363-0000-0000-0000c27db2f3",
        • "path": "/payment_methods/00000000-6363-0000-0000-0000c27db2f3",
        • "resource": "payment_methods"
        },
      • "pending_reasons": null,
      • "refund_reason": "example refund reason",
      • "resource": "refunds",
      • "status": "completed",
      • "txnr_app_fee_refund": null,
      • "txnr_merchant_refund": {
        • "id": "7c59ebf4-d6ae-4125-85f8-515b95725501",
        • "path": "/transaction_records/7c59ebf4-d6ae-4125-85f8-515b95725501",
        • "resource": "transaction_records"
        },
      • "api_version": "3.0",
      • "reference_id": "reference_id_0"
      }
    ]
}