Payment webhooks

Webhooks allow your server to automatically receive notifications about events in our system. Instead of periodically polling the API, you configure one endpoint and we send you an HTTP request for each important event.

To connect webhooks, you need:

Create an HTTPS endpoint that accepts JSON requests.
Send us the URL of this endpoint.
Choose which events you want to receive.
Accept and test webhook.

Possible payment events

Reason

Event

Action

Outcome

To get information about a successful authorization of funds on the customer’s account.

charge_authorize

authorize

The funds are placed on hold in the customer’s account; a new subscription is created or the existing subscription is renewed.

To get information about a successful capture of funds from the customer’s account.

charge_capture

capture

The previously held funds are debited from the customer’s account; a new subscription is created or the existing subscription is renewed.

To get information about a successful withdrawal of funds from the customer’s account.

charge_settle

settle

The funds are debited from the customer’s account and transferred to the merchant’s account; a new subscription is created or the existing subscription is renewed.

{
  "type": "charge",
  "action": "charge_settle",
  "merchant": "lasta",
  "buyer": {
    "id": "UUID",
    "email": "email@email.email",
    "metaData": {
      "key": "value from buyer meta"
    }
  },
  "chargeData": {
    "id": "UUID",
    "status": "settled",
    "buyerId": "UUID",
    "buyerEmail": "email@email.email",
    "buyerMetaData": {
      "key": "value from buyer meta"
    },
    "firstName": "first name",
    "lastName": "last name",
    "createdAt": "2024-03-30 23:35:00.123456",
    "isServiceFee": true,
    "order": {
      "id": "UUID",
      "type": "initial",
      "currency": "USD",
      "amount": "123.12",
      "metaData": {
        "key": "value from order meta"
      },
      "locale": "en"
    },
    "paymentMethod": {
      "type": "card",
      "data": {
        "bin": "123456",
        "lastFour": "1234"
      },
      "binData": {
        "bin": "123456",
        "brand": "visa",
        "issuer": "WELLS FARGO BANK NA",
        "cardType": "DEBIT",
        "cardLevel": "CLASSIC",
        "countryIsoTwo": "US"
      }
    },
    "provider": {
      "name": "provider",
      "mid": {
        "name": "mid"
      }
    }
  }
}

Webhook-request format

Attribute

Type

Requirement

Description

Standard

type

string

mandatory

Type of event.
There will always be a charge.

action

string

mandatory

Indicates event (charge_authorize, charge_settle, etc)

merchant

string

mandatory

Merchant's name