---
title: "/v1/event"
method: POST
path: "/v1/event"
tags: ["Execute event"]
---

# /v1/event

`POST /v1/event`

## Request

- Base URL: `https://cs-api.sandbox.paybis.com`
- URL: `https://cs-api.sandbox.paybis.com/v1/event`
- Auth: API key in header `Authorization` and API key in header `x-request-signature`

Executes a previously quoted event, such as a crypto payout.

## Headers

- `Authorization` string, required
- `X-Request-Signature` string, required

## Request body

- EventRequestPublicV1: Public event request. Supports three types of events: - payment_execute - pay_in_execute - payout_execute
  - `event_id` string, uuid, required: Unique event identifier in UUID format. Paybis will use this ID as an idempotency key.
  - `name` 'payment_execute' | 'pay_in_execute' | 'payout_execute', required: Event name. - payment_execute: requires `payment` payload - pay_in_execute: requires `pay_in` payload - payout_execute: requires `payout` payload
  - `timestamp` string, date-time, nullable: Deprecated. The value is ignored; the event timestamp is set server-side at creation time.
  - `payment` PaymentExecutePayloadV1, nullable
    - `transaction` object, required: Transaction details.
      - `id` string, uuid, required: Payment transaction identifier generated by Partner, i.e. specific payout id
      - `order_id` string, required: Order identifier generated by Partner, i.e. mass payout id
      - `quote_id` string, uuid, required: Referenced quote id. Must be a valid and not expired quote.
      - `fiat` object, required
        - `amount` string, required: Fiat amount of the transaction. Must match the quoted fiat amount.
        - `currency` string, required: Fiat currency of the transaction. Must match the quote fiat currency.
      - `crypto` object, required
        - `amount` string, required: Crypto amount of the transaction. Must match the quote crypto amount.
        - `currency` string, required: Cryptocurrency of the transaction. Must match the quote cryptocurrency.
      - `merchant` string, required: Crypto transaction sender. Must be a string up to 255 characters in length.
    - `crypto_destination` object, required
      - `type` string, required: Destination crypto address type. Must be constant user.
      - `crypto_address` string, required: Destination crypto wallet address.
      - `user` object, required: Crypto transaction beneficiary details.
        - `user_id` string, required: The user identifier in the partner’s system, which allows to distinguish end users.
  - `pay_in` PayInExecutePayloadV1, nullable
    - `id` string, required
    - `quote_id` string, required
    - `fiat` object, required
      - `amount` string, required
      - `currency` string, required
    - `crypto` object, required
      - `amount` string, required
      - `currency` string, required
  - `payout` PayoutExecutePayloadV1, nullable
    - `id` string, uuid, required
    - `beneficiary` object, required: Beneficiary details
      - `type` 'business' | 'individual', required
      - `iban` string, required
      - `companyName` string: Required for business beneficiaries
      - `firstName` string: Required for individual beneficiaries
      - `lastName` string: Required for individual beneficiaries
    - `amount` object, required: Fiat payout amount.
      - `amount` string, required: Fiat amount of the payout.
      - `currency` string, required: Fiat currency code (e.g. EUR, USD).
    - `reference` string, required: Payout reference that will appear in the bank transfer details. 2-140 characters: letters, digits, spaces and the characters / - ? : ( ) . ' +. Must not consist of one repeated character (for example 44 or AAAA).

## Response `200`

OK

- EventResponseV1
  - `status` string, required
  - `result` object, required
    - `event_id` string, required
    - `name` string, required
    - `timestamp` string, date-time, required
    - `payment` PaymentV1, nullable
      - `transaction` object, required
        - `id` string, uuid, required
        - `order_id` string, required
        - `quote_id` string, uuid, required
        - `fiat` object, required
          - `amount` string, required
          - `currency` string, required
        - `crypto` object, required
          - `amount` string, required
          - `currency` string, required
        - `merchant` string, required
      - `crypto_destination` object, required
        - `type` string, required
        - `crypto_address` string, required
        - `user` object, required
          - `user_id` string, required
    - `pay_in` PayInV1, nullable
      - `id` string, uuid, required
      - `quote_id` string, uuid, required
      - `fiat` object, required
        - `amount` string, required
        - `currency` string, required
      - `crypto` object, required
        - `amount` string, required
        - `currency` string, required
    - `payout` PayoutV1
      - `beneficiary` object: Payout beneficiary details.
        - `type` 'individual' | 'business', required: Beneficiary type: individual or business.
        - `iban` string, required: Beneficiary IBAN account number.
        - `first_name` string, nullable: First name of the beneficiary. Present when type = individual.
        - `last_name` string, nullable: Last name of the beneficiary. Present when type = individual.
        - `company_name` string, nullable: Company name of the beneficiary. Present when type = business.
      - `amount` object: Fiat payout amount.
        - `amount` string, required: Fiat amount of the payout.
        - `currency` string, required: Fiat currency code (e.g. EUR, USD).
      - `reference` string: Payout reference that will appear in the bank transfer details.

## Other responses

- `429`: Too many requests

---

[API](https://skmtc.dev/payb/apis/paybis-send.md) - [All operations](https://skmtc.dev/payb/apis/paybis-send/llms.txt) - [OpenAPI document](https://skmtc.dev/payb/apis/paybis-send/revisions/5327e9b2ad8d?raw)