Skip to content

Corgi BankDocumentation

OpenAPI

Record a verified provider receipt

POST/notifications/{id}/receipts

Path parameters

idstringRequired

Headers

Idempotency-KeystringOptional

Send on every write that creates or changes money or state; a replay with the same key returns the original result with 200.

Body parameters

bounce_typestringOptional

event_idstringRequired

provider_atstring · date-time or nullOptional

The provider's own time for the outcome

provider_refstringRequired

reasonstringOptional

recipient_addressstringRequired

statusstringRequired

Returns

200 OK

actorstringRequired

bounce_typestringOptional

created_atstring · date-timeRequired

event_idstringRequired

idstringRequired

notification_idstringRequired

Example ntf_2tVh8nqLxq4GbDe0K1F6S9zRcWm

provider_atstring · date-time or nullOptional

The provider's own time for the outcome

provider_refstringRequired

reasonstringOptional

recipient_addressstringRequired

statusstringRequired

Errors

Every error is a problem document with a stable code. See Errors.

400401403404409412413422424429500503

Request

curl -X POST 'https://api.dev.bank.corgi.com/notifications/{id}/receipts' \
  -H "Authorization: Bearer $TOKEN" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "event_id": "string",
    "provider_ref": "string",
    "recipient_address": "string",
    "status": "string"
  }'

Response200

{
  "actor": "string",
  "bounce_type": "string",
  "created_at": "2026-09-17T14:30:00Z",
  "event_id": "string",
  "id": "string",
  "notification_id": "ntf_2tVh8nqLxq4GbDe0K1F6S9zRcWm",
  "provider_at": "2026-09-17T14:30:00Z",
  "provider_ref": "string",
  "reason": "string",
  "recipient_address": "string",
  "status": "string"
}