Request To Withdraw Status

GET {{base_url}}/collection/v1_0/requesttowithdraw/:Request_ID_CashOut

This endpoint makes an HTTP GET request to retrieve information about a specific cash withdrawal request identified by the provided RequestIDCashOut.

Request

The request does not contain a request body. The following headers may be included in the request: - No specific headers were mentioned in the request.

Response

Upon a successful execution, the endpoint returns a JSON object with the following fields: - financialTransactionId (string): The ID of the financial transaction. - externalId (string): The external ID associated with the transaction. - amount (string): The amount of the withdrawal. - currency (string): The currency in which the withdrawal is made. - payer (object): An object containing information about the payer, including partyIdType and partyId. - payerMessage (string): A message from the payer. - payeeNote (string): A note from the payee. - status (string): The status of the withdrawal request.

The response is returned with a status code of 200 and a Content-Type of application/json.

HEADERS

KeyDatatypeRequiredDescription
X-Target-Environmentstring
Ocp-Apim-Subscription-Keystring