| Category | Events |
|---|---|
| Invoice | all INVOICE_* events except INVOICE_PAYMENT_PAID |
| Onboarding | all ONBOARDING_* events |
| Payout | REPORT_AVAILABLE and INVOICE_PAYMENT_PAID |
| Product Classification | not currently available |
callback_url, pick its category, and enter a signing secret of your own choice. The secret is stored and used to sign every delivery, and it is not shown again in full. An endpoint without a secret receives no deliveries.| Sent to | Events |
|---|---|
| Merchant only | INVOICE_OVERDUE, INVOICE_REFUND_INITIATED, INVOICE_REFUNDED, INVOICE_REFUND_FAILED, INVOICE_CHARGEBACK, INVOICE_CHARGEBACK_REVERSED, INVOICE_SECOND_CHARGEBACK, INVOICE_RECURRING_INITIATED, INVOICE_RECURRING_TOKEN_DELETED, ONBOARDING_CREATED, ONBOARDING_ERROR_ADDED, ONBOARDING_ERROR_REMOVED, ONBOARDING_PROCESSING_FAILED |
| Merchant and partner | INVOICE_PAYMENT_AUTHORIZED, INVOICE_PAYMENT_REFUSED, INVOICE_DELIVERY_SUCCESS, INVOICE_DELIVERY_FAILED, INVOICE_PAYMENT_PAID, ONBOARDING_STATUS_UPDATED, REPORT_AVAILABLE |
POST with a JSON body. Your application must answer with a 2xx status within 30 seconds. A non-2xx answer, a timeout or a connection error counts as a failed attempt.X-AmiliPay-Event-Id, so use it to ignore duplicates.X-AmiliPay-Signature header.X-AmiliPay-Signature and Zettr-Signature (same value). Use X-AmiliPay-Signature. Zettr-Signature is deprecated and will be removed in a future release.| Header | Value |
|---|---|
X-AmiliPay-Event | The event type, for example INVOICE_PAYMENT_AUTHORIZED. |
X-AmiliPay-Event-Id | Identifier of the event. It stays the same on retries. |
X-AmiliPay-Timestamp | Time of this attempt as Unix time in seconds (UTC), for example 1760000000. |
User-Agent | AmiliPay-Webhooks/1.0 |
X-AmiliPay-Timestamp is more than 5 minutes old.INVOICE_PAYMENT_AUTHORIZEDINVOICE_PAYMENT_REFUSEDINVOICE_OVERDUEINVOICE_REFUND_INITIATEDINVOICE_REFUNDEDINVOICE_REFUND_FAILEDINVOICE_CHARGEBACKINVOICE_CHARGEBACK_REVERSEDINVOICE_SECOND_CHARGEBACKINVOICE_RECURRING_INITIATEDINVOICE_RECURRING_TOKEN_DELETEDINVOICE_DELIVERY_SUCCESSINVOICE_DELIVERY_FAILEDINVOICE_PAYMENT_PAID{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": "2022-02-07T13:23:38",
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-07T13:23:38",
"deleted_at": null,
"deactivated_at": null,
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_PAYMENT_AUTHORIZED",
"message": "Invoice payment is authorized."
}kid and account_number are the payment references set on the invoice (null when not set). Date/time fields are ISO-8601 (e.g. "2022-02-07T13:23:38"), and an unset date is JSON null, not an empty string. is_recurring is always present (false on non-recurring invoices). details (card summary) appears only once the invoice has been paid. customer_reference is the merchant-supplied reference sent when the invoice was created; it is null when none was supplied.{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": null,
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-07T13:23:38",
"deleted_at": null,
"deactivated_at": null,
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_PAYMENT_REFUSED",
"message": "Invoice payment was refused."
}message - it's a static string for this event type.{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": null,
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-07T13:23:38",
"deleted_at": null,
"deactivated_at": "2022-02-07T13:23:38",
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_OVERDUE",
"message": "Invoice is overdue. Payment is disabled."
}message is in major units (for example 150.00).{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": "2022-02-14T17:33:00",
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-14T17:33:00",
"deleted_at": null,
"deactivated_at": "2022-02-07T13:23:38",
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_REFUND_INITIATED",
"message": "The refund (amount: 150.00 NOK) has been initiated."
}{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": "2022-02-14T17:33:00",
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-15T12:43:00",
"deleted_at": "2022-02-15T12:43:00",
"deactivated_at": "2022-02-07T13:23:38",
"refunded_at": "2022-02-15T12:43:00",
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_REFUNDED",
"message": "Invoice has been refunded."
}{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": "2022-02-14T17:33:00",
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-14T17:33:00",
"deleted_at": null,
"deactivated_at": "2022-02-07T13:23:38",
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_REFUND_FAILED",
"message": "The refund request has failed."
}message is a static string for this event type - it does not carry the specific failure reason (e.g. amount too high).{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": null,
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-14T17:33:00",
"deleted_at": "2022-02-14T17:33:00",
"deactivated_at": "2022-02-07T13:23:38",
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_CHARGEBACK",
"message": "The payment has been charged back."
}{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": "2022-02-14T17:33:00",
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-14T17:33:00",
"deleted_at": "2022-02-14T17:33:00",
"deactivated_at": "2022-02-07T13:23:38",
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_CHARGEBACK_REVERSED",
"message": "The chargeback has been reversed."
}{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": null,
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-14T17:33:00",
"deleted_at": "2022-02-14T17:33:00",
"deactivated_at": "2022-02-07T13:23:38",
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_SECOND_CHARGEBACK",
"message": "A second chargeback has been received."
}{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": null,
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-14T17:33:00",
"deleted_at": "2022-02-14T17:33:00",
"deactivated_at": "2022-02-07T13:23:38",
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": true,
"recurring_invoice_id": null
},
"event": "INVOICE_RECURRING_INITIATED",
"message": "Recurring payment initiated - customer must re-authenticate to capture token."
}INVOICE_RECURRING_INITIATED, which means your customer must open the payment page and pay manually.{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": null,
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-14T17:33:00",
"deleted_at": "2022-02-14T17:33:00",
"deactivated_at": "2022-02-07T13:23:38",
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": true,
"recurring_invoice_id": null
},
"event": "INVOICE_RECURRING_TOKEN_DELETED",
"message": "Recurring payment token deleted after 10 consecutive failures."
}{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": null,
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-04T10:19:35",
"deleted_at": null,
"deactivated_at": null,
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_DELIVERY_SUCCESS",
"message": "Invoice was delivered to the customer.",
"delivery_channel": "email"
}delivery_channel field sits next to data, event and message (not inside data). It is the channel the invoice was sent on: email, sms or rcs.INVOICE_DELIVERY_SUCCESS, this event goes to the merchant and to its partner account.{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": null,
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-02-04T10:19:35",
"deleted_at": null,
"deactivated_at": null,
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_DELIVERY_FAILED",
"message": "Invoice delivery failed (bounce): The email account does not exist.",
"delivery_channel": "email"
}message has the form Invoice delivery failed (<status>): <reason>. For email <status> is bounce, blocked or dropped. For SMS and RCS it is failed or undelivered. The reason is the text reported by the mail server or carrier. Unlike most other invoice events, message is not a fixed string. As with the success event, delivery_channel sits next to data and is email, sms or rcs.REPORT_AVAILABLE payout webhook (see Payout webhooks below) and fires once per invoice in that payout, one by one - so a payout settling 6 invoices sends 6 separate INVOICE_PAYMENT_PAID events, each naming exactly one invoice, rather than a single event listing all of them. This means you don't have to cross-reference the payout report yourself.{
"data": {
"unique_id": "O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"account_id": 1,
"invoice_id": "1",
"amount": 15000,
"customer_id": "1",
"customer_reference": "PO-88231",
"kid": "1234567890",
"account_number": "15030012345",
"name": "FirstName LastName",
"email": "firstname.lastname@mail.com",
"phone": "+4444444444",
"currency": "NOK",
"notify_customer": true,
"reminded": false,
"payment_method": "visa",
"opened": 1,
"language": "no",
"redirect_url": "https://www.customer.com/callback",
"cancel_url": null,
"due_date": "2022-02-08T00:00:00",
"last_payment_date": "2022-02-15T00:00:00",
"paid_at": "2022-02-07T13:23:38",
"created_at": "2022-02-04T10:19:29",
"updated_at": "2022-04-13T15:15:07",
"deleted_at": null,
"deactivated_at": null,
"refunded_at": null,
"payment_url": "https://pay2.amili.no/pay/invoice/O5XRLP0Muabxufne6Eb62uFjAvj8D5nog3waANRQEI5Ce7zcC6",
"is_recurring": false,
"recurring_invoice_id": null
},
"event": "INVOICE_PAYMENT_PAID",
"message": "Invoice payment has been paid out."
}data is the same invoice object used by every other invoice webhook. It has no payout information (amount, reference, etc.); get those from the matching REPORT_AVAILABLE event or the payouts endpoint.ONBOARDING_CREATEDONBOARDING_STATUS_UPDATEDONBOARDING_ERROR_ADDEDONBOARDING_ERROR_REMOVEDONBOARDING_PROCESSING_FAILED{
"data": {
"id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
"account_id": 3,
"status": "STARTED",
"status_changed_at": "2022-02-08 09:21:28",
"ownership_category": "ownership_no_major",
"company": {
"id": "8f14e45f-ceea-467e-bd7b-6a35c5d18ea9",
"industry_category": "4522",
"tax_id": "116963",
"registration_code": "64543302",
"address": {
"city": "Oslo",
"country": "AO",
"street_address": "Storgata 56",
"zip": "0563"
},
"average_transaction": "250",
"average_daily_transactions": "5",
"documentation": [],
"created_at": "2022-02-08 09:22:14",
"updated_at": "2022-02-08 09:22:14"
},
"payout": {
"id": "c9b1c1c1-6f2a-4f2a-8e2a-1a2b3c4d5e6f",
"account_name": "Payout account",
"bic": "NORWNOK1",
"iban": "NO1111111111111",
"currency": "NOK",
"country": "NO",
"city": "Oslo",
"name": "Bank",
"documentation": [],
"created_at": "2022-02-08 09:22:14",
"updated_at": "2022-02-08 09:22:14"
},
"shareholders": [
{
"id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
"role": "procurator",
"is_signatory": true,
"ownership_percentage": 0,
"procurator_is_confirmed": true,
"first_name": "John",
"last_name": "Doe",
"gender": "male",
"date_of_birth": "1966-01-31",
"job_title": null,
"address": {
"city": "Oslo",
"country": "NO",
"street_address": "Storgata 56",
"zip": "0563",
"phone": "040123456"
},
"email": "customer@com.com",
"nationality": "NO",
"documentation": null,
"created_at": "2022-02-08 09:22:01",
"updated_at": "2022-02-08 09:22:01"
}
],
"created_at": "2022-02-08 09:21:28",
"updated_at": "2022-02-08 09:21:28"
},
"event": "ONBOARDING_CREATED",
"message": ""
}company, payout and shareholder id values are UUIDs. The onboarding is identified by the top-level id.data.status (and the statuses in message) is one of CANCELED, COMPLETED, IN_PROGRESS, PENDING_REVIEW, REVIEW_FAILED, STARTED. In message the previous status is UNKNOWN when there was none. A merchant can accept payments once the status is COMPLETED.{
"data": {
"id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
"account_id": 3,
"status": "COMPLETED",
"status_changed_at": "2022-02-08 09:21:28",
"ownership_category": "ownership_no_major",
"company": {
"id": "8f14e45f-ceea-467e-bd7b-6a35c5d18ea9",
"industry_category": "4522",
"tax_id": "116963",
"registration_code": "64543302",
"address": {
"city": "Oslo",
"country": "AO",
"street_address": "Storgata 56",
"zip": "0563"
},
"average_transaction": "250",
"average_daily_transactions": "5",
"documentation": [],
"created_at": "2022-02-08 09:22:14",
"updated_at": "2022-02-08 09:22:14"
},
"payout": {
"id": "c9b1c1c1-6f2a-4f2a-8e2a-1a2b3c4d5e6f",
"account_name": "Payout account",
"bic": "NORWNOK1",
"iban": "NO1111111111111",
"currency": "NOK",
"country": "NO",
"city": "Oslo",
"name": "Bank",
"documentation": [],
"created_at": "2022-02-08 09:22:14",
"updated_at": "2022-02-08 09:22:14"
},
"shareholders": [
{
"id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
"role": "procurator",
"is_signatory": true,
"ownership_percentage": 0,
"procurator_is_confirmed": true,
"first_name": "John",
"last_name": "Doe",
"gender": "male",
"date_of_birth": "1966-01-31",
"job_title": null,
"address": {
"city": "Oslo",
"country": "NO",
"street_address": "Storgata 56",
"zip": "0563",
"phone": "040123456"
},
"email": "customer@com.com",
"nationality": "NO",
"documentation": null,
"created_at": "2022-02-08 09:22:01",
"updated_at": "2022-02-08 09:22:01"
}
],
"created_at": "2022-02-08 09:21:28",
"updated_at": "2022-02-08 09:21:28"
},
"event": "ONBOARDING_STATUS_UPDATED",
"message": "Status changed from IN_PROGRESS to COMPLETED"
}data has the same shape as in ONBOARDING_CREATED above.ONBOARDING_ERROR_REMOVED and the current ones as ONBOARDING_ERROR_ADDED.{
"data": {
"step": "receivePayments",
"field": "companyRegistrationNumber",
"notes": "The company registration number is invalid.",
"created_at": "2022-02-08T08:53:26.1234567Z",
"onboarding": {
"id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
"account_id": 3,
"status": "STARTED",
"status_changed_at": "2022-02-08 09:21:28",
"ownership_category": "ownership_no_major",
"company": {
"id": "8f14e45f-ceea-467e-bd7b-6a35c5d18ea9",
"industry_category": "4522",
"tax_id": "116963",
"registration_code": "64543302",
"address": {
"city": "Oslo",
"country": "AO",
"street_address": "Storgata 56",
"zip": "0563"
},
"average_transaction": "250",
"average_daily_transactions": "5",
"documentation": [],
"created_at": "2022-02-08 09:22:14",
"updated_at": "2022-02-08 09:22:14"
},
"payout": {
"id": "c9b1c1c1-6f2a-4f2a-8e2a-1a2b3c4d5e6f",
"account_name": "Payout account",
"bic": "NORWNOK1",
"iban": "NO1111111111111",
"currency": "NOK",
"country": "NO",
"city": "Oslo",
"name": "Bank",
"documentation": [],
"created_at": "2022-02-08 09:22:14",
"updated_at": "2022-02-08 09:22:14"
},
"shareholders": [
{
"id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
"role": "procurator",
"is_signatory": true,
"ownership_percentage": 0,
"procurator_is_confirmed": true,
"first_name": "John",
"last_name": "Doe",
"gender": "male",
"date_of_birth": "1966-01-31",
"job_title": null,
"address": {
"city": "Oslo",
"country": "NO",
"street_address": "Storgata 56",
"zip": "0563",
"phone": "040123456"
},
"email": "customer@com.com",
"nationality": "NO",
"documentation": null,
"created_at": "2022-02-08 09:22:01",
"updated_at": "2022-02-08 09:22:01"
}
],
"created_at": "2022-02-08 09:21:28",
"updated_at": "2022-02-08 09:21:28"
},
"updated_at": "2022-02-08T08:53:26.1234567Z"
},
"event": "ONBOARDING_ERROR_ADDED",
"message": ""
}data:step: the capability the problem belongs to, for example receivePayments (the field name when none is known).field: the field with the problem, or the capability when no field is named.notes: the error text, followed by the suggested fix when there is one.created_at, updated_at: when the error was created and last changed.onboarding: the full onboarding, in the same shape as ONBOARDING_CREATED above.{
"data": {
"step": "receivePayments",
"field": "companyRegistrationNumber",
"notes": "The company registration number is invalid.",
"created_at": "2022-02-08T08:53:26.1234567Z",
"onboarding": {
"id": "3f2504e0-4f89-41d3-9a0c-0305e82c3301",
"account_id": 3,
"status": "STARTED",
"status_changed_at": "2022-02-08 09:21:28",
"ownership_category": "ownership_no_major",
"company": {
"id": "8f14e45f-ceea-467e-bd7b-6a35c5d18ea9",
"industry_category": "4522",
"tax_id": "116963",
"registration_code": "64543302",
"address": {
"city": "Oslo",
"country": "AO",
"street_address": "Storgata 56",
"zip": "0563"
},
"average_transaction": "250",
"average_daily_transactions": "5",
"documentation": [],
"created_at": "2022-02-08 09:22:14",
"updated_at": "2022-02-08 09:22:14"
},
"payout": {
"id": "c9b1c1c1-6f2a-4f2a-8e2a-1a2b3c4d5e6f",
"account_name": "Payout account",
"bic": "NORWNOK1",
"iban": "NO1111111111111",
"currency": "NOK",
"country": "NO",
"city": "Oslo",
"name": "Bank",
"documentation": [],
"created_at": "2022-02-08 09:22:14",
"updated_at": "2022-02-08 09:22:14"
},
"shareholders": [
{
"id": "d4e5f6a7-b8c9-4d0e-9f1a-2b3c4d5e6f7a",
"role": "procurator",
"is_signatory": true,
"ownership_percentage": 0,
"procurator_is_confirmed": true,
"first_name": "John",
"last_name": "Doe",
"gender": "male",
"date_of_birth": "1966-01-31",
"job_title": null,
"address": {
"city": "Oslo",
"country": "NO",
"street_address": "Storgata 56",
"zip": "0563",
"phone": "040123456"
},
"email": "customer@com.com",
"nationality": "NO",
"documentation": null,
"created_at": "2022-02-08 09:22:01",
"updated_at": "2022-02-08 09:22:01"
}
],
"created_at": "2022-02-08 09:21:28",
"updated_at": "2022-02-08 09:21:28"
},
"updated_at": "2022-02-08T08:53:26.1234567Z"
},
"event": "ONBOARDING_ERROR_REMOVED",
"message": ""
}data has the same fields as in ONBOARDING_ERROR_ADDED above.step is one of organization_legal_entity, shareholder_legal_entity, bank_transfer_instrument, document_upload, or business_line, identifying which part of the submission failed. onboarding_id is the onboarding's numeric identifier, not the UUID id used by the onboarding endpoints. It cannot be looked up through the public API.{
"data": {
"step": "bank_transfer_instrument",
"onboarding_id": 1,
"errors": [
{ "field": "iban", "message": "The IBAN could not be validated by the payment provider." }
]
},
"event": "ONBOARDING_PROCESSING_FAILED",
"message": "The IBAN could not be validated by the payment provider."
}message is the joined text of every entry in errors (semicolon-separated when there's more than one).REPORT_AVAILABLE{
"data": {
"id": 1,
"uuid": "98fb7eb8-64dc-4d37-a5f8-502fe25b0c4c",
"reference": "8916497364063763",
"currency": "NOK",
"amount": 632519,
"status": "Completed",
"creation_date": "2022-04-12",
"updated_at": "2022-04-13T15:15:07",
"created_at": "2022-04-13T15:15:07",
"account_id": 1,
"account_name": "Acme Merchant AS",
"processed_at": "2022-04-13T15:15:07",
"credited_amount": 1433181,
"rounding": 0,
"balance_transfer": 0,
"refund": 0,
"refund_cost": 0,
"chargeback": -757881,
"chargeback_cost": -23359,
"chargeback_reversed": 160,
"chargeback_reversed_cost": 5,
"second_chargeback": -89,
"second_chargeback_cost": -3,
"fees": -19495,
"platform_fee": 0,
"deposit_correction": 0,
"next_balance_transfer": 0,
"scheduled_at": null,
"batch": null,
"modification_reference": null,
"transactions_count": 6
},
"event": "REPORT_AVAILABLE",
"message": "Payout report is available."
}creation_date is a plain date (no time component) - different from every other timestamp field here, which are full date-times. batch and modification_reference are reserved and always null. status is one of Pending, Processing, Completed, Failed, Returned. transactions_count appears only on this webhook payload, not on GET /v1/payouts or GET /v1/payouts/{payout_id_or_uuid}.