Webhook Messages

The Webhook Messages API allows you to inspect and manage individual webhook delivery attempts. This is useful for debugging webhook issues.

You must include your Bearer token in the request header.

Get Webhook Messages

get

/api/v1/webhooks_messages

Retrieves a paginated list of webhook messages, optionally filtered by date range and status.

Authorizations

AuthorizationstringRequired

Authentication using a Bearer token.

Query parameters

date_fromstring · date-timeOptional

Filter messages created from this date (YYYY-MM-DD).

Example: 2025-04-26

date_tostring · date-timeOptional

Filter messages created up to this date (YYYY-MM-DD).

Example: 2025-04-27

per_pageinteger · min: 1 · max: 100Optional

Number of items to return per page in a paginated response.

Default: 15

pageinteger · min: 1Optional

The current page number for paginated results.

Default: 1

directionstring · enumOptional

Sort direction for the message list.

Default: descPossible values:

sortstring · enumOptional

Field to sort the message list by.

Default: created_atPossible values:

statusstring · enumOptional

Filter messages by their delivery status.

Example: deliveredPossible values:

Responses

200

A paginated list of webhook messages.

application/json

401

Unauthorized.

application/json

get/api/v1/webhooks_messages

GET /api/v1/webhooks_messages HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "uuid": "c1a9b8d7-e6f5-4321-ba98-7654321fedcb",
    "created_at": 1745825706,
    "status": "delivered",
    "account_uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
    "account": {
      "uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
      "account_number": "LT433400015000036002",
      "currency": "EUR",
      "balance": 100.5,
      "balance_national": 100.5,
      "book_balance": 0,
      "book_balance_national": 0,
      "available_balance": 100.5,
      "available_balance_national": 100.5,
      "hold": 0,
      "cards_reserved_amount": 0,
      "cards_reserved_amount_national": 0
    },
    "transaction": {
      "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "parent_transaction_uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
      "status": "pending",
      "operation_date": "2025-04-27",
      "operation_date_time": "2025-04-27T10:30:00Z",
      "operation_date_unix": 1745821800,
      "amount": 1234.56,
      "currency": "EUR",
      "payment_type": "SEPA",
      "transaction_type": "payment",
      "payment_urgency": "NORMAL",
      "payment_details": "Invoice #INV-123 Payment",
      "payment_code": "SALARY",
      "end_to_end_ident": "E2E-XYZ789",
      "direction": "CREDIT",
      "document_number": "DOC-456",
      "created_at": 1745820000,
      "payer": {
        "name": "John Doe",
        "iban": "DE89 3704 0044 0532 0130 00",
        "address": "123 Main St, Anytown",
        "country_code": "DE",
        "agency_id": "DEUTDEFF",
        "agency_name": "Deutsche Bank",
        "agency_address": "Taunusanlage 12, Frankfurt",
        "ultimate": {
          "name": "Ultimate Payer Corp"
        }
      },
      "recipient": {
        "name": "Jane Smith",
        "iban": "FR76 3000 6000 0112 3456 7890 189",
        "address": "456 Oak Ave, Otherville",
        "country_code": "FR",
        "agency_id": "SOGEFRPP",
        "agency_name": "Société Générale",
        "agency_address": "29 Boulevard Haussmann, Paris",
        "ultimate": {
          "name": "Ultimate Recipient Inc"
        }
      },
      "verification_of_payee": "MATCH"
    }
  }
]

Get Webhook message by UUID

get

/api/v1/webhooks_messages/{uuid}

Retrieves the details of a specific webhook message by its UUID.

Authorizations

AuthorizationstringRequired

Authentication using a Bearer token.

Path parameters

uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

Responses

200

Successfully retrieved the webhook message details.

application/json

Resource representing the data structure of a webhook message.

uuidstring · uuidOptional

Unique identifier for the webhook message.

Example: c1a9b8d7-e6f5-4321-ba98-7654321fedcb

created_atinteger · int64Optional

Timestamp when the webhook message was created.

Example: 1745825706

statusstring · enumOptional

Delivery status of the webhook message.

Example: deliveredPossible values:

account_uuidstring · uuid · nullableOptional

UUID of the account associated with the event that triggered the webhook.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g

accountone of · nullableOptional

Simplified details of the account associated with the event. Included based on webhook configuration.

transactionone of · nullableOptional

Details of the transaction associated with the event. Included for transaction-related webhooks.

401

Unauthorized.

application/json

422

Unprocessable.

application/json

get/api/v1/webhooks_messages/{uuid}

GET /api/v1/webhooks_messages/{uuid} HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "uuid": "c1a9b8d7-e6f5-4321-ba98-7654321fedcb",
  "created_at": 1745825706,
  "status": "delivered",
  "account_uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
  "account": {
    "uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
    "account_number": "LT433400015000036002",
    "currency": "EUR",
    "balance": 100.5,
    "balance_national": 100.5,
    "book_balance": 0,
    "book_balance_national": 0,
    "available_balance": 100.5,
    "available_balance_national": 100.5,
    "hold": 0,
    "cards_reserved_amount": 0,
    "cards_reserved_amount_national": 0
  },
  "transaction": {
    "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "parent_transaction_uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "status": "pending",
    "operation_date": "2025-04-27",
    "operation_date_time": "2025-04-27T10:30:00Z",
    "operation_date_unix": 1745821800,
    "amount": 1234.56,
    "currency": "EUR",
    "payment_type": "SEPA",
    "transaction_type": "payment",
    "payment_urgency": "NORMAL",
    "payment_details": "Invoice #INV-123 Payment",
    "payment_code": "SALARY",
    "end_to_end_ident": "E2E-XYZ789",
    "direction": "CREDIT",
    "document_number": "DOC-456",
    "created_at": 1745820000,
    "payer": {
      "name": "John Doe",
      "iban": "DE89 3704 0044 0532 0130 00",
      "address": "123 Main St, Anytown",
      "country_code": "DE",
      "agency_id": "DEUTDEFF",
      "agency_name": "Deutsche Bank",
      "agency_address": "Taunusanlage 12, Frankfurt",
      "ultimate": {
        "name": "Ultimate Payer Corp"
      }
    },
    "recipient": {
      "name": "Jane Smith",
      "iban": "FR76 3000 6000 0112 3456 7890 189",
      "address": "456 Oak Ave, Otherville",
      "country_code": "FR",
      "agency_id": "SOGEFRPP",
      "agency_name": "Société Générale",
      "agency_address": "29 Boulevard Haussmann, Paris",
      "ultimate": {
        "name": "Ultimate Recipient Inc"
      }
    },
    "verification_of_payee": "MATCH"
  }
}

Update webhook message status

patch

/api/v1/webhooks_messages/{uuid}

Allows updating the status of a specific webhook message.

Authorizations

AuthorizationstringRequired

Authentication using a Bearer token.

Path parameters

uuidstring · uuidRequired

Universally Unique Identifier (UUID) as defined by RFC 4122.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2gPattern: ^[a-zA-Z0-9]{8}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{4}-[a-zA-Z0-9]{12}$

Query parameters

statusstring · enumRequired

The new status to set for the webhook message.

Possible values:

Responses

200

Webhook message status updated successfully. Returns the updated resource.

application/json

Resource representing the data structure of a webhook message.

uuidstring · uuidOptional

Unique identifier for the webhook message.

Example: c1a9b8d7-e6f5-4321-ba98-7654321fedcb

created_atinteger · int64Optional

Timestamp when the webhook message was created.

Example: 1745825706

statusstring · enumOptional

Delivery status of the webhook message.

Example: deliveredPossible values:

account_uuidstring · uuid · nullableOptional

UUID of the account associated with the event that triggered the webhook.

Example: e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g

accountone of · nullableOptional

Simplified details of the account associated with the event. Included based on webhook configuration.

transactionone of · nullableOptional

Details of the transaction associated with the event. Included for transaction-related webhooks.

401

Unauthorized.

application/json

422

Unprocessable.

application/json

patch/api/v1/webhooks_messages/{uuid}

PATCH /api/v1/webhooks_messages/{uuid}?status=processing HTTP/1.1
Host: public-api.gurupay.eu
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "uuid": "c1a9b8d7-e6f5-4321-ba98-7654321fedcb",
  "created_at": 1745825706,
  "status": "delivered",
  "account_uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
  "account": {
    "uuid": "e1f8a3b1-7d6c-4e9a-9b2e-3f8d1a9c5f2g",
    "account_number": "LT433400015000036002",
    "currency": "EUR",
    "balance": 100.5,
    "balance_national": 100.5,
    "book_balance": 0,
    "book_balance_national": 0,
    "available_balance": 100.5,
    "available_balance_national": 100.5,
    "hold": 0,
    "cards_reserved_amount": 0,
    "cards_reserved_amount_national": 0
  },
  "transaction": {
    "uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "parent_transaction_uuid": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
    "status": "pending",
    "operation_date": "2025-04-27",
    "operation_date_time": "2025-04-27T10:30:00Z",
    "operation_date_unix": 1745821800,
    "amount": 1234.56,
    "currency": "EUR",
    "payment_type": "SEPA",
    "transaction_type": "payment",
    "payment_urgency": "NORMAL",
    "payment_details": "Invoice #INV-123 Payment",
    "payment_code": "SALARY",
    "end_to_end_ident": "E2E-XYZ789",
    "direction": "CREDIT",
    "document_number": "DOC-456",
    "created_at": 1745820000,
    "payer": {
      "name": "John Doe",
      "iban": "DE89 3704 0044 0532 0130 00",
      "address": "123 Main St, Anytown",
      "country_code": "DE",
      "agency_id": "DEUTDEFF",
      "agency_name": "Deutsche Bank",
      "agency_address": "Taunusanlage 12, Frankfurt",
      "ultimate": {
        "name": "Ultimate Payer Corp"
      }
    },
    "recipient": {
      "name": "Jane Smith",
      "iban": "FR76 3000 6000 0112 3456 7890 189",
      "address": "456 Oak Ave, Otherville",
      "country_code": "FR",
      "agency_id": "SOGEFRPP",
      "agency_name": "Société Générale",
      "agency_address": "29 Boulevard Haussmann, Paris",
      "ultimate": {
        "name": "Ultimate Recipient Inc"
      }
    },
    "verification_of_payee": "MATCH"
  }
}

PreviousWebhooks NextHealth check

Last updated 1 year ago

Was this helpful?