Retrieve Payments

Use this end point to retrieve or find a specific info of payments. start_search_date and end_search_date are UTC datetime

Request

Security:

Bearer

path Parameters

version

required

string

query Parameters

wallet_guid	string <uuid> Unique Wallet GUID on the platform
status	string Current status of the Payment Schedule
payment_status	string Current status of the Payment
is_payee	boolean When is_payee equals true, Payees payment info will be fetched; If is_payee is false, Payers Payment info will be fetched
start_search_date	string <date-time> Payments will be searched from this Date
end_search_date	string <date-time> Payments will be searched till this Date
start_index	integer <int32>
limit	integer <int32> maximum number of records will be fetched

Responses

200

Returns the PaymentInfo

400

Bad request.

401

Unauthorized

404

Person not found

500

Server Error

get/api/{version}/payments

Request samples

curl
JavaScript
Node.js

curl -i -X GET \
  'https://qvapikeybank.qolopay.com/api/{version}/payments?wallet_guid=497f6eca-6276-4993-bfeb-53cbbbba6f08&status=string&payment_status=string&is_payee=true&start_search_date=2019-08-24T14%3A15%3A22Z&end_search_date=2019-08-24T14%3A15%3A22Z&start_index=0&limit=0' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Response samples

application/json

{"count": 0,
"start_index": 0,
"end_index": 0,
"has_more": true,
"data": [{"payer": [{"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"card_proxy": "string",
"wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
"outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
"preferred_transfer_type": "string",
"account_type": "string",
"instrument_type": "string"
}
],
"payee": [{"account_guid": "d2b7c9d2-85e7-4c51-92d0-3f97a47f8d76",
"person_guid": "2ae6ba4b-f6c0-4817-a158-43e5a87168fd",
"card_proxy": "string",
"wallet_guid": "17eaeda9-c0ab-4ac3-8ef9-27ac9b388a03",
"outside_instrument_guid": "f2fb9354-2f4f-40d1-819c-4ff2a66a4bd8",
"preferred_transfer_type": "string",
"account_type": "string",
"instrument_type": "string"
}
],
"payment_amount": 0,
"payment_base_currency": "string",
"payment_description": "string",
"payment_request_code": "string",
"payment_balance": 0,
"payment_guid": "ca76c87d-c08b-46dc-a069-5abd4a4ab259",
"response_code": "string",
"reason_code": "string",
"requestor_wallet_guid": "996c589d-2ec1-4921-a37b-692f64c4cb1c",
"payment_status": "string",
"payment_due_date": "2019-08-24T14:15:22Z",
"reference_code": "string",
"payment_schedule": {"schedule_guid": "b6f4cc4c-e025-4982-9800-846c354bc66c",
"frequency": "string",
"period_value": 0,
"start_date": "2019-08-24T14:15:22Z",
"until_date": "2019-08-24T14:15:22Z",
"schedule_status": "string",
"payment_window": "string",
"payment_schedule_type": "string",
"created_date": "2019-08-24T14:15:22Z",
"last_updated_date": "2019-08-24T14:15:22Z"
},
"recurring_reason_code": "string",
"last_transaction_status": "string"
}
],
"check_statuses": ["string"
]
}