> For the complete documentation index, see [llms.txt](https://docs.payvalida.com/api-cashout-redes/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-redes/consulta.md).

# Consulta

Permite obtener información de una operación de Cashout

{% hint style="info" %}
Método: **POST**
{% endhint %}

{% hint style="success" %}
**Producción:** <https://api.payvalida.com/cashout/v1/order/{netname}>

**Sandbox (pruebas):** <https://api-test.payvalida.com/cashout/v1/order/{netname}>
{% endhint %}

{% tabs %}
{% tab title="Request" %}

<table><thead><tr><th>Nombre</th><th width="150">Requerido</th><th>Descripción</th><th>Tipo</th><th>Longitud</th></tr></thead><tbody><tr><td>otp</td><td>Si</td><td>Pin de operación u OTP</td><td>Alfanumérico</td><td>30</td></tr><tr><td>netcode</td><td>Si</td><td>Código de la red</td><td>Numérico</td><td>20</td></tr><tr><td>document</td><td>Si</td><td>Número de documento de identidad o referencia asociada a la transacción</td><td>Alfanumérico</td><td>20</td></tr><tr><td>checksum</td><td>Si</td><td>Cadena de comprobación, calculada con SHA512(name + pin + document + FIXED_HASH)</td><td>Alfanumérico</td><td>512</td></tr><tr><td>customparam01</td><td>No</td><td>Parámetro customizable (tipo cuenta)</td><td>Alfanumérico</td><td>50</td></tr><tr><td>customparam02</td><td>No</td><td>Parámetro customizable (valor)</td><td>Alfanumérico</td><td>50</td></tr><tr><td>customparam03</td><td>No</td><td>Parámetro customizable</td><td>Alfanumérico</td><td>50</td></tr></tbody></table>
{% endtab %}

{% tab title="Request (Ejemplo)" %}

> curl --request POST '<https://api-test.payvalida.com/cashout/v1/order/VIA'\\>
> &#x20;           \--data-raw '{
>
> &#x20;                       "otp": "1234056",
>
> &#x20;                       "netcode": 180,
>
> &#x20;                       "document": "1020304051",
>
> &#x20;                       "checksum": "SHA512FIXEDHASH"
>
> &#x20;           }'
> {% endtab %}

{% tab title="Response" %}

| Nombre               | Descripción                                                                                                                                                                                                                | Tipo         |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ |
| code                 | Indica el código del resultado, “0000” indica resultado sin error, otro valor indica el código del error                                                                                                                   | Alfanumérico |
| text                 | Contiene el mensaje referente al code enviado.                                                                                                                                                                             | Alfanumérico |
| data                 | Contiene los datos de la transacción (para resultados sin error)                                                                                                                                                           | Objeto       |
| data-amount          | Monto de la transacción                                                                                                                                                                                                    | Alfanumérico |
| data-transactionCost | Indica el costo que asume el usuario por realizar la transacción                                                                                                                                                           | Alfanumérico |
| data-currency        | Moneda en la que está registrada la orden de cashout\*                                                                                                                                                                     | Alfanumérico |
| data-document        | Descripción de la transacción                                                                                                                                                                                              | Alfanumérico |
| data-documetype      | <p>Tipo de documento.<br>Los tipos de documento por país son:<br>-Perú (DNI,RUC,CE)</p><p>-Colombia: (TI,CE,PP,VISA,NIT,RUT,CC y PPT)</p><p>-Ecuador: (CC y PP)</p><p>-Guatemala: (DPI y PP)</p><p>-El Salvador: (DUI)</p> | Alfanumérico |
| data-otp             | Confirmación del otp enviado                                                                                                                                                                                               | Alfanumérico |
| data-operation       | Identificador de la operación, necesario para el registro de una transacción                                                                                                                                               | Alfanumérico |
| data-customparam01   | Parámetro customizable enviado por la red                                                                                                                                                                                  | Alfanumérico |
| data-customparam02   | Parámetro customizable enviado por la red                                                                                                                                                                                  | Alfanumérico |
| data-customparam03   | Parámetro customizable enviado por la red                                                                                                                                                                                  | Alfanumérico |
| data-checksum        | Cadena de comprobación, calculada con SHA512(otp + document + amount + currency + idoperation + FIXED\_HASH)                                                                                                               | Alfanumérico |
| {% endtab %}         |                                                                                                                                                                                                                            |              |

{% tab title="Response (Ejemplo)" %}

> {
>
> &#x20;           "code": "0000",
>
> &#x20;           "text": "OK",
>
> &#x20;           "data": {
>
> &#x20;                       "amount": "31529.0",
>
> &#x20;                       "transactionCost": "991",
>
> &#x20;                       "currency": "COP",
>
> &#x20;                       "description": "Test Cashout",
>
> &#x20;                       "document": "10410754367",
>
> &#x20;                       "otp": "3659",
>
> &#x20;                       "operation": "312",
>
> &#x20;                       "checksum": "SHA512FIXEDHASH"
>
> &#x20;                       "documentType": "CC"
>
> &#x20;           }
>
> }
> {% endtab %}
> {% endtabs %}

{% hint style="warning" %}
El **documenType** estará disponible únicamente para las redes que soliciten esta información.
{% endhint %}

{% hint style="info" %}
\*Las monedas actualmente aceptadas en Payválida son:

* COP (Peso colombiano)
* PEN (Sol peruano)
* USD (Dolar americano)
* CRC (Colón costarricense)
* GTQ (Quetzal guatemalteco)
  {% endhint %}
