> 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/register/register-operation-1.md).

# Recharge funds

## Recharge funds

<mark style="color:green;">`POST`</mark> `https://api.payvalida.com/cashout/v1/rechargecashout`

`URL Sandbox: https://api-test.payvalida.com/v1`**`/rechargecashout`**

This API registers a payment order and it returns the **checkout** parameter, this is an URL to be used by the merchant in order to complete the payment. Once the merchant make the payment and this will be approved, the merchant will receive a confirmation e-mail about the recharging

#### Request Body

| Name           | Type   | Description                                                                                               |
| -------------- | ------ | --------------------------------------------------------------------------------------------------------- |
| merchant       | string | Merchant ID provided by Payvalida (max. 50 characters)                                                    |
| language       | string | Message language. (max. 2 characters)                                                                     |
| email          | string | Payer e-mail. (max. 100 characters).                                                                      |
| country        | number | <p>Country code. (max. 3 characters)<br><strong>Note:</strong> Currently only 343 is available</p>        |
| order          | string | Unique ID for the generated order (max. 100 characteres)                                                  |
| money          | string | <p>ISO currency code. (max. 3 characters).<br><strong>Note:</strong> Currently only COP is available.</p> |
| amount         | number | Order amount.                                                                                             |
| description    | string | Order description. (max. 250 characters)                                                                  |
| checksum       | string | Checksum encoded in SHA512 (email+country+order+money+amount+FIXED\_HASH)                                 |
| user\_di       | string | Payer document ID (max. 15 characters)                                                                    |
| user\_type\_di | string | Buyer document type (max. 3 characters)                                                                   |
| user\_name     | string | Buyer name (max. 25 characters)                                                                           |

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

```
{
   "CODE": "0000",
   "DESC": "OK", 
   "DATA":{
      "OrdenID":"comercioExterno_9892",
      "Monto":"500000",
      "PVordenID":"98555221",
      "Referencia":"8766554",
      "Operacion":"CREADA",
      "checkout":"checkout.payvalida.com/?token=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJNRVJDSEFOVF9DRUwiOiIzMTc2ODI3MzQxIiwiT1JERVJfTUVUSE9EIjoiZWZlY3R5IiwiTUVSQ0hBTlRfQ09ERSI6MjU0LCJNRVJDSEFOVF9FTUFJTCI6ImhyZXN0cmVwb0BwYXl2YWxpZGEuY29tIiwiaXNzIjoiYXV0aDAiLCJNRVJDSEFOVF9MT0dPIjoiaHR0cHM6Ly9zMy5hbWF6b25hd3MuY29tL3ZhbGlkZGF3ZWIvZXZlbnRvcy9mZW5hbGNvYnJhLnBuZyIsIk1FUkNIQU5UX1VSTF9SRVRVUk4iOiJ3d3cucGludmFsaWRkYS5jb20uY28iLCJNRVJDSEFOVF9OQU1FIjoiSGVybmFuIFJwbyAoQ09MKSIsIk9SREVSX0JSSUVGIjoiVGVzdCBSRVNUZnVsbCBQdXJjaGFzZSBPcmRlciBQT1NUIiwiTUVSQ0hBTlRfVEVMIjoiMjg4MDUzOSIsIk9SREVSX0NVUlJFTkNZIjoiQ09QIiwiT1JERVJfQU1PVVQiOiIxMCwwMDAuMDAiLCJleHAiOjE1MzA0MDE1MzgsIk9SREVSX1JFRkVSRU5DRSI6IjQyMzEzIn0.QVsZwm-2BIkK-5RgrAX2NuwGqmHSNHD_zw91i1hcSc8”
   }
}
```

{% endtab %}
{% endtabs %}

{% hint style="success" %}
Be aware this service is available only for Colombia (country code = 343 and currency code = "COP").\
The merchant ID (merchant) and FIXED\_HASH are generated when the merchant sign up in our platform and this is sent by e-mail.
{% endhint %}
