Refunds

List refunds

List DICT refunds for an organization.

get/v2/pix/refunds

Request

  • Base URL
    https://sandbox.pismolabs.io/passport
  • URL
    https://sandbox.pismolabs.io/passport/v2/pix/refunds
  • Auth
    HTTP bearer

Query parameters

participant_role'CONTESTED' | 'REQUESTED' required

Participant role filter

funds_recovery_idstring

Funds recovery identifier.

Returned from the Create funds recovery endpoint.

include_detailsboolean

Include details in response? Default is false.

limitinteger

Maximum results to return. Default is 20. Maximum is 200.

modified_afterstring date-time

Return DICT refunds modified after this date. A RFC 3339 date-time value. For example - 2023-04-12T23:20:50.52Z.

modified_beforestring

Return DICT refunds modified before this date. A RFC 3339 date-time value. For example - 2023-04-12T23:20:50.52Z.

status'OPEN' | 'CLOSED' | 'CANCELLED'

Refund status filter

Headers

x-tenantstring required

Organization/tenant ID

x-cidstring

The Correlation ID UUID field links related API requests and events. The x-cid can help the Pismo engineering team track everything related to a call. If not passed, this field is automatically generated.

Response

List refunds

has_more_elementsboolean required

Are there more items?

Example response

{
  "has_more_elements": true,
  "items": [
    {
      "contested_participant": "99999011",
      "creation_date_time": "2020-08-13T13:49:03Z",
      "last_modified": "2020-08-13T13:49:03Z",
      "refund_amount": "20.10",
      "refund_id": "12345645-9ff7-439f-a318-2e6f974707a5",
      "refund_reason": "OPERATIONAL_FLAW",
      "requesting_participant": "99999011",
      "status": "CLOSED",
      "transaction_id": "E9999901012341234123412345678900",
      "correlation_id": "c737895c-8159-4c0c-a92a-a4f8600bff37",
      "infraction_report_id": "cfdff46e-5d58-45b8-b7aa-591a65f74444",
      "refund_analysis_details": "Details about the refund analysis.",
      "refund_analysis_result": "PARTIALLY_ACCEPTED",
      "refund_details": "Details about the refund request",
      "refund_rejection_reason": "NO_BALANCE",
      "refund_account": {
        "tax_id_number": "123412341234",
        "participant": "00115678",
        "branch": "011",
        "account_number": "98765432",
        "account_type": "TRAN"
      },
      "refund_transaction_id": "E9999901012341234123412345678900",
      "funds_recovery_id": "53D0F66A-BAB0-49D7-B7DC-807B82AABD8D",
      "effective_refunded_amount": 20.1
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.