Webhooks
Payment status event
Notification of the status update of your incoming/outgoing payment.
Mandatory parameters
Each event contains the following mandatory data:
paymentId
string required
Internal payment identifier
It is returned in response to the
POST /api/2/eurowallet/paymentsaccount
string required
Your IBAN account at Nexpay from/to which the funds are transferred
amount
string required
Payment amount
Format: Decimal string with at most two fractions and value greater than 0.00
direction
boolean required
Payment direction
Possible values:
INCOMING (deposit), OUTGOING (withdrawal)status
boolean required
Payment status
Values:
COMPLETED, REJECTEDnetworkType
string required
Payment rails through which the payment should be made
Possible values:
If the parameter is not provided, the
SEPA, SWIFTIf the parameter is not provided, the
SEPA network is chosen by defaultotherName
string required
Sender/beneficiary name
otherAccount
string required
Sender/beneficiary bank account number
Conditional parameters
These additional parameters will be sent if the payment was made via the SWIFT network (networkType = SWIFT):
originalAmount
string required
Original payment amount
originalCurrency
string required
Original payment currency
Optional parameters
The parameters listed below are optional:
feePaymentId
string optional
Identifier of a linked commission charge transaction
externalPaymentId
string optional
Custom internal identifier shared between you and your end-customer, helping you track and reference payments across systems
batchReference
string optional
The identifier of the batch file of which this payment is a part
date
string optional
Payment creation date
Format:
yyyy-MM-dddetails
string optional
Payment reference (transaction details)
runningBalance
string optional
Account balance (
account) at the time of paymentrejectReason
string optional
Payment rejection reason (if
status = REJECTED)Example
Response
{
"event": "payment.status",
"payload": {
"paymentId": "132",
"account": "LT103080010000000095",
"amount": "23.33",
"direction": "incoming",
"status": "COMPLETED",
"networkType": "SEPA",
"otherName": "Test company",
"otherAccount": "LT103080010000000601",
"feePaymentId": "133",
"externalPaymentId": "8c306b2e-36a8-49ad-a766-8155e071b6df",
"batchReference": "batch-123843",
"date": "2023-08-07",
"details": "Test payment",
"runningBalance": "188.03"
}
}