Sign in

v1

latestOpenAPI 3.0.02026-07-242830146.7 KB
Webhook

EMI webhook endpoint for receiving transaction status updates

post/v2/webhook/emi

Headers

X-Request-Signaturestring

Signature to sign the request. For more information see https://docs.payb.is/reference/signing-requests

Request body

status'completed' | 'failed'

The status of the EMI operation.

reasonstring nullable

The reason for the status, especially useful for failed status.

amountstring

The amount of the transaction.

currencystring

The currency of the transaction.

orderIdstring

The order ID in the EMI system.

partnerPaymentIdstring

The payment ID in the partner system.

partnerUserIdstring

The user ID in the partner system. Must match the partnerUserId of the request.

requestIdstring uuid

The ID of the request in the Paybis system.

Example request

{
  "status": "completed",
  "reason": "Transaction failed due to insufficient funds",
  "amount": "100.50",
  "currency": "USD",
  "orderId": "order-123456",
  "partnerPaymentId": "payment-789012",
  "partnerUserId": "user-345678",
  "requestId": "d77e0cf5-1c26-4bc8-8f4d-d81dff4cffb5",
  "bankRequisites": {
    "bankName": "Example Bank",
    "bankAddress": "123 Bank Street, City, Country",
    "accountHolderName": "John Doe",
    "iban": "DE89370400440532013000",
    "swift": "EXAMPLEBANK"
  }
}

Response

Webhook received and processed successfully.