> For the complete documentation index, see [llms.txt](https://docs.payvalida.com/api-cashout/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.payvalida.com/api-cashout/api-cashout-en/consult/consult-available-balance.md).

# Wallet Movements

## To get the wallet movements

<mark style="color:blue;">`GET`</mark> `https:/api.payvalida.com/cashout/v1/walletmovements/{merchant}`

`URL Sandbox: https://api-test.payvalida.com/v1/walletmovements`**`/{merchant}`**

Allows to obtain the wallet movements in a date range.

#### Path Parameters

| Name                                       | Type   | Description                                                   |
| ------------------------------------------ | ------ | ------------------------------------------------------------- |
| merchant<mark style="color:red;">\*</mark> | string | Commerce/merchant that owns the operation (Max 30 characters) |

#### Query Parameters

| Name                                       | Type   | Description                                                                   |
| ------------------------------------------ | ------ | ----------------------------------------------------------------------------- |
| checksum<mark style="color:red;">\*</mark> | string | Checksum encoded in SHA512(merchant+start+end+fixed\_hashed) (512 characters) |
| limit                                      | string | Number of records to get (default 23; 10 <= limit <= 100) (4 characters)      |
| page                                       | string | Page number (default > 0) (4 characters)                                      |
| type                                       | string | Concept type (Operation status) (30 characters)                               |
| start<mark style="color:red;">\*</mark>    | string | Start date of search (format YYYY-MM-DD) (8 characters)                       |
| end<mark style="color:red;">\*</mark>      | string | End date of search (format YYYY-MM-DD) (8 characters)                         |

{% tabs %}
{% tab title="200 Returns a JSON following this structure:" %}

```
{  
   "code":"0000",
   “text”:”OK”,
   "data":[
        {
            "operation_code": "optest-1",
            "observation": "REFUNDING COMMISSION AMOUNT FROM OPERATION: optest-1",
            "amount": 119,
            "type": "DEVOLUCION",
            "date": "2023-01-06T12:04:29.524562Z",
            "currency": "COP",
            "user": "user@email.com"
        },
        {
            "operation_code": "optest-2",
            "observation": "REFUNDING COMMISSION AMOUNT FROM OPERATION: optest-2",
            "amount": 119,
            "type": "DEVOLUCION",
            "date": "2023-01-06T12:04:29.44447Z",
            "currency": "COP",
            "user": "user@email.com"
        },
        ...
    ]
}
```

{% endtab %}
{% endtabs %}

## Available concept types:

* "DEVOLUCION"
* "TRANSFERENCIA"
* "ANULACION"
* "NINGUNO"
* "RECARGA"
* "COMPRA"
* "PROVISION"
* "IVA"
* "RECARGA/PAGO SERVICIO"
* "COMISION"
* "OPERACION CASHOUT"

### Response Data:

**code:** Code of the result, "0000" indicates success, any other code indicates error.

Error codes:

* "0000" : OK.
* "0001" :  No records found.
* "0009" :  Checksum provided is not valid.
* "0019" :  Required parameter was not found in the request.
* "0026" :  Parameter 'limit' out of range.
* "0028" :  Parameter 'page' must be greater than zero.
* "0036" :  Format not valid for start or end date.
* "0037" :  Range of dates is not valid.
* "0038" :  Concept type provided is not valid.

**text:** Contains a message associated with the code received.

**data:** Provides information of operations when the response is ok.

* **operation\_code**: Operation ID associated to the wallet movement
* **amount**: Decimal number representing the amount debited (withdrawn) or acredited (recharged) from the funds. Credit or debit is differentiated by the observation field.
* **type**: Represents the movement type
* **date**: Creation date of the operation. It includes milliseconds
* **currency**: Represents the currency of the movement
* **observation**: Description about the movement, it includes the operation ID.
* **user**: Email address of carried out the operation. This will be used for notification purposes
