deprecated
Webhook

EfakturaRegistration Webhook

​

Webhook endpoint for receiving E-faktura registration events.

Deprecated: This section is about E-faktura in Sweden. For other markets but Sweden, see E-invoice registration callbacks.

When a recipient has registered or deregistered for E-faktura a callback POST request is sent to the specified callback URL. This request will occur instantly with the registration_type field set to Registration or Deregistration. During the night, another request will be sent with the field registration_type set to ForwardedEfakturaRegistration that will include an EFA file with all registrations that have happened during the day.

Body·
required
application/json
  • callback_id
    Type: string
    required

    Unique identifier generated for each callback.

  • callback_timestamp
    Type: stringFormat: date-time
    required

    An ISO 8601 compliant timestamp for the callback.

  • callback_type
    const:  
    EfakturaRegistration
    required

    The type of callback. Value is "EfakturaRegistration" for E-faktura registration and deregistration callbacks.

  • efaktura_registration
    Type: object ·
    required
Responses
  • application/json
Request Example for postEfakturaRegistration
{
  "callback_id": "9ec1c43a-0272-46f0-b4c2-9fe53acdb861",
  "callback_timestamp": "2021-11-03T13:28:51.706784Z",
  "callback_type": "EfakturaRegistration",
  "efaktura_registration": {
    "registration_type": "Registration",
    "fmi": "199001013030.SHB.SE",
    "bank_name": "Handelsbanken",
    "bank_code": "SHB",
    "id_number": "199001013030",
    "recipient_type": "individual",
    "ocr": "12345678",
    "billogram_customer_number": 1234,
    "customer_supplied_billogram_customer_no": 1234,
    "full_name": "Jane Doe",
    "email": "example@billogram.com",
    "file_contents": "QUFBQUJCQkJDQ0NDRERERA==",
    "file_name": "ANMALAN_20211111112121_14926164417564.TXT"
  }
}

{
  "status": "OK"
}

Webhook received successfully.

Required: Your endpoint must return HTTP 200 OK for the webhook to be considered successfully delivered. Any other status code will cause the webhook to be marked as failed and retried.