Caibo PayDocs
Panel

Send a test event

POST
/v1/webhook-endpoints/{id}/ping

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

Accepted

application/json
  1. response
attempts*integer
created_at*string

When it was created.

Formatodate-time
delivered_at?string

When it was delivered.

Formatodate-time
endpoint_id*string

The id of the endpoint.

Match^we_[0-9a-z]+$
event_id*string

The id of the event.

Match^evt_[0-9a-z]+$
event_type*string

The event type.

Valor en"beneficiary.created""beneficiary.verified""customer.created""customer.status_changed""customer.updated""funding_account.active""funding_account.failed""hosted_session.created""hosted_session.payment_reported""payin.completed""payin.failed""payout.cancelled""payout.completed""payout.created""payout.failed""payout.return_settled""payout.returned""payout_batch.cancellation_finished""payout_batch.cancellation_requested""payout_batch.completed""payout_batch.created""reconciliation.exception_created""reconciliation.exception_resolved""refund.approved""refund.completed""refund.created""refund.failed""refund.processing""remittance.completed""remittance.created""remittance.failed""remittance.processing""remittance.returned""remittance.review""risk.review_required""settlement.completed""settlement.created""settlement.failed""settlement.on_hold""settlement.processing""settlement_schedule.activated""settlement_schedule.blocked""webhook.ping""withdrawal.approved""withdrawal.cancelled""withdrawal.completed""withdrawal.created""withdrawal.failed""withdrawal.pending_approval""withdrawal.submitted"
history*array<>
id*string

The id of the delivery.

Match^whd_[0-9a-z]+$
next_attempt_at?string

When it is tried next.

Formatodate-time
redelivery_of?string

The id of the delivery this one repeats.

Match^whd_[0-9a-z]+$
status*string

pending: not yet attempted, or waiting for its next attempt. delivered: the receiver answered 2xx. exhausted: every attempt failed; redeliver to try again. cancelled: the endpoint was deleted first.

Valor en"pending""delivered""exhausted""cancelled"
Ejemplo de solicitud
curl -X POST 'https://api-sandbox.caibopay.app/v1/webhook-endpoints/string/ping'
Ejemplo de respuesta
{  "attempts": 0,  "created_at": "2019-08-24T14:15:22Z",  "delivered_at": "2019-08-24T14:15:22Z",  "endpoint_id": "string",  "event_id": "string",  "event_type": "beneficiary.created",  "history": [    {      "duration_ms": 0,      "error": "string",      "http_status": 0,      "number": 0,      "occurred_at": "2019-08-24T14:15:22Z"    }  ],  "id": "string",  "next_attempt_at": "2019-08-24T14:15:22Z",  "redelivery_of": "string",  "status": "pending"}