Simulate a deposit into a funding account

POST
/v1/sandbox/deposits

Sandbox only. The simulated provider reports a deposit; it is verified and credited through the same path as a real one. Not served in live.

Autorización

apiKey
headerAuthorizationBearer <clave>

Your secret API key, sent as Authorization: Bearer <key>. A key names its environment: psp_test_… works only against sandbox (https://api-sandbox.caibopay.app), psp_live_… only against live (https://api.caibopay.app). Keys are issued by Caibo when your account is opened; the dashboard (Developers) shows the key in use.

application/json
  1. body
amount*string

The amount that arrives, in currency. A decimal string in the currency's precision.

Match^[0-9]+(\.[0-9]+)?$
currency?string

What amount is in. The account's settlement_currency (the default): that amount is credited. Or the account's currency, what the payer pays in: the simulated provider converts it into the settlement currency at its indicative rate, rounded down, and the pay-in records both (amount credited, paid).

funding_account_id*string

The id of the active funding account.

Match^fa_[0-9a-z]+$

Cuerpo de la respuesta

Accepted

application/json
  1. response
amount*string

The amount, as stated. A decimal string in the currency's precision.

Match^[0-9]+(\.[0-9]+)?$
currency*string

The currency it was stated in.

funding_account_id*string

The funding account.

status*"accepted"

The deposit was reported; it is credited asynchronously.

Valor en"accepted"
Ejemplo de solicitud
curl -X POST 'https://api-sandbox.caibopay.app/v1/sandbox/deposits' \  -H 'Content-Type: application/json' \  -d '{  "amount": "string",  "funding_account_id": "string"}'
Ejemplo de respuesta
{  "amount": "string",  "currency": "string",  "funding_account_id": "string",  "status": "accepted"}