v1

latestOpenAPI 3.0.02026-07-242830146.7 KB

Execute event

Execute event endpoint

post/v1/event

Headers

Authorizationstring required

Api key

X-Request-Signaturestring required

Base64 encoded string, containing request body, encrypted with the sha512 algorithm using RSA 4096 bit public key

Request body

event_idstring 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

timestampstring date-time required

Request timestamp.

Example request

{
  "pay_in": {
    "id": "uuid",
    "quote_id": "uuid"
  },
  "payout": {
    "beneficiary": {
      "type": "individual",
      "iban": "US00EXAMPLE123456789",
      "companyName": "Acme Inc.",
      "firstName": "Jane",
      "lastName": "Doe"
    }
  }
}

Response

statusstring required

Example response

{
  "result": {
    "event_id": "e24b0081-8a83-4705-8cd5-7293f2c1c302",
    "name": "payment_execute"
  }
}