Skip to main content

Webhook Payloads

This is what will be included in webhook notifications sent to your specified URL.

Returns

    id String
    Webhook unique identifier

    creationTime DateTime
    Webhook creation data and time

    eventType enum
    The event type (see below for a full list)

    clientReferenceId String
    Included if this was supplied in the original POST payment call

    resourceId String
    Link Money resource ID (customerId or paymentId)

    resourceType enum
    Resource type (Customer or Payment)

    paymentType enum
    Debit or Credit

    achReturnCode enum
    Supplied if the payment failed (event type: payment.failed)

Event Type

  • customer.created

    Customer was created in Link Money Backend

    Occurs when user initiates account linking. Does not necessarily mean that customer account is linked or ready for payments

  • customer.activated

    Customer is ready for payments

    Occurs when a customer has linked a financial institution and selected a preferred account. Customer is ready for payments at this point

  • customer.deactivated

    Customer account is deactivated

    Occurs when a customer can no longer initiate payments, typically because customer revoked authentication to the linked account. Customer must re-link with a financial institution to be able to initiate payments again. See #relink# for more information about re-linking accounts

  • customer.account.linked

    Customer account has been selected as the preferred account for payment by the customer

    Occurs when a customer has successfully linked with a financial institution and selected an account as preferred account for payments

  • customer.account.deactivated

    Customer account is no longer available for payments

    An account can be deactivated for many reasons such as customer revoking access, authentication expiring or user MFA changing

  • payment.created

    Payment request was received

    Occurs when a payment request was received and recorded in Link Money Backend

  • payment.pending

    Payment is waiting for authorized or failed status

    Occurs when a payment request is awaiting Link Money Intelligence decision; usually followed by payment.authorized, the final decision is returned within 15 minutes. This may result in a payment.failed

  • payment.authorized

    Payment will be scheduled with Link Money’s payment provider

    Occurs when the Link Money Backend has determined that a payment will be scheduled with the payment provider

  • payment.scheduled

    Payment provider has been informed to schedule the payment

    Occurs when a payment request is scheduled to be processed, T+1 Day or T+2 Days. This schedule is determined based on the time when the payment was submitted. If the payment was submitted within the cutoff time, T+1 Day. If the payment was submitted after the cutoff time, T+2 Days

  • payment.initiated

    Payment was successfully initiated

    Occurs when the payment is scheduled with Link Money's payment provider

  • payment.succeeded

    Customer account was successfully debited to satisfy the payment request

    Occurs when the payment amount has been successfully debited from customer account. The amount will be disbursed to merchant according to the normal schedule

  • payment.disbursed

    Payment has been made whole

    Occurs when the given payment has been disbursed to the merchant as part of the normal disbursement schedule

  • payment.canceled

    Payment has been canceled

    Occurs when the cancel API has been triggered to cancel a payment

  • payment.failed

    Payment has failed

    Occurs when the payment that was previously initiated has failed. To view the failure reason call Find Transaction by ID.

  • report.delivered

    Reconciliation Report successfully delivered

    Occurs if a merchant is configured to receive Reconciliation Reports via SFTP and had a successful delivery

  • report.delivery.failed

    Reconciliation Report encountered an issue in delivery

    Occurs if a merchant is configured to receive Reconciliation Reports via SFTP and there was an issue delivering the file

Response Body

Successful Payment Body
1{
2	"id": "b973a6e3b-a7d2-bb40-f811-be2df2d5d56",
3	"creationTime": "2023-12-08T17:30:42.505",
4	"eventType": "payment.authorized",
5	"metadata": {
6		"resourceId": "225f715c-a016-4222-8b8c-966e838deb66",
7		"resourceType": "payment",
8		"clientReferenceId": "898-jdhf-83784-jfss",
9		"transactionType": "DEBIT"
10	}
11}
Failed Payment Body
1{
2	"id":"b973a6e3b-a7d2-bb40-f811-be2df2d5d56",
3	"creationTime":"2023-12-08T17:30:42.505",
4	"eventType":"payment.failed",
5	"metadata":{
6		"resourceId":"225f715c-a016-4222-8b8c-966e838deb66",
7		"resourceType":"payment",
8		"clientReferenceId":"898-jdhf-83784-jfss",
9		"transactionType":"DEBIT",
10		"achReturnCode":"R03"
11	}
12}