Caibo PayDocs
Panel

Retrieve a pay-in

GET
/v1/payins/{id}

A credited pay-in also says what it has given back (refunded) and what can still be refunded (refundable).

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.

Parámetros de ruta

id*string

Cuerpo de la respuesta

OK

application/json
  1. response
amount?string

What was credited, or will be. A decimal string in the currency's precision.

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

When it was credited.

Formatodate-time
created_at*string

When it was first seen.

Formatodate-time
currency?string

The currency credited.

failure_code?string

Why it failed.

funding_account_id*string

The id of the funding account.

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

The id of the pay-in.

Match^pin_[0-9a-z]+$
paid?

What the payer paid, when the provider reports it apart from what was credited: a payer paying USD by bank transfer into an account credited in USDT. Evidence beside the credit; the balance is credited amount in currency.

refundable?string

What can still be refunded: the credited amount minus refunded. Present once the amount is known. A decimal string in the currency's precision.

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

What has been sent back to the payer so far, refunds in flight included. Present once the amount is known. A decimal string in the currency's precision.

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

processing until the deposit is verified and credited. completed: credited to the balance. failed: it will not arrive.

Valor en"processing""completed""failed"
Ejemplo de solicitud
curl -X GET 'https://api-sandbox.caibopay.app/v1/payins/string'
Ejemplo de respuesta
{  "amount": "string",  "completed_at": "2019-08-24T14:15:22Z",  "created_at": "2019-08-24T14:15:22Z",  "currency": "string",  "failure_code": "string",  "funding_account_id": "string",  "id": "string",  "paid": {    "amount": "string",    "currency": "string"  },  "refundable": "string",  "refunded": "string",  "status": "processing"}