FOfourthline
Webhooks

Bank Account Verification Webhooks

Webhook notifications for <a href="https://docs.fourthline.com/docs/bav-overview">Bank Account Verification</a>. For setup and authentication, see <a href="https://docs.fourthline.com/docs/webhooks">Webhooks</a>.

post/bav/{paymentId}

Request

  • Base URL
    https://mysite.com/api/fourthline
  • URL
    https://mysite.com/api/fourthline/bav/{paymentId}
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://example.com/token

Path parameters

paymentIdstring required

Our unique identifier for the reference payment. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0

Headers

Authorizationstring required

Your Basic or Bearer access token. <br />The examples we’ve provided show Bearer. <br /><br /><img src="https://files.readme.io/ad2486a-Inline_Note.svg" align="left"/>More information: Webhooks – Specify authentication method

Request body

clientIdstring required

Our unique identifier for the client. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0 <br />Validations: uuid format, clientId exists

paymentIdstring required

Our unique identifier for the reference payment. <br /><br />Format: uuid string <br /><br />Example: 790f325a-48c9-4b82-bb53-c0ea128236f0 <br />Validations: uuid format, paymentId exists <br />Errors: Format is incorrect or doesn’t exist

status'failed' | 'pending' required

The payment status. <br />Validation: Valid enum value <br />Errors: Invalid enum value.

messagestring

The status code.

Response

Return HTTP 2xx to acknowledge receipt. See Handle webhook deliveries.

object required

A successful response is empty.

Changes

No recorded changes to this operation across all 1 revision of this API.