Skip to content

DRAFT: docs: Update Bundled BAV create request API #414

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
abhijha-setu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

DRAFT: docs: Update Bundled BAV create request API #414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions api-playground/json/data/bav/bundled-bav/CreateBundledBAV.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
]
},
"body": {
"mobileNumber": "9876543210"
"mobileNumber": "9876543210",
"consent": "Y"
}
}
}
39 changes: 32 additions & 7 deletions api-references/data/bav/bundled-bav.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,9 @@
"paths": {
"/api/bundled-bav": {
"post": {
"tags": ["Bundled BAV"],
"tags": [
"Bundled BAV"
],
"summary": "Create Bundled BAV request",
"operationId": "CreateBundledBAV",
"parameters": [
Expand Down Expand Up @@ -58,14 +60,15 @@
}
],
"requestBody": {
"description": "Mobile number to verify",
"description": "Mobile number to verify and customer consent",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BundledBAVCreateRequestBody"
},
"example": {
"mobileNumber": "9876543210"
"mobileNumber": "9876543210",
"consent": "Y"
}
}
},
Expand Down Expand Up @@ -129,7 +132,9 @@
},
"/api/bundled-bav/{requestId}": {
"get": {
"tags": ["Bundled BAV"],
"tags": [
"Bundled BAV"
],
"summary": "Get Bundled BAV request status",
"operationId": "GetBundledBAVDetails",
"parameters": [
Expand Down Expand Up @@ -246,12 +251,24 @@
"BundledBAVCreateRequestBody": {
"title": "BundledBAVCreateRequestBody",
"type": "object",
"required": ["mobileNumber"],
"required": [
"mobileNumber",
"consent"
],
"properties": {
"mobileNumber": {
"type": "string",
"description": "Mobile number to verify (10 digits)",
"example": "9876543210"
},
"consent": {
"type": "string",
"description": "Must be \"Y\" to enable the Mobile to Bank flow. Other BAV methods do not need explicit consent here since they take user input directly.",
"enum": [
"Y",
"N"
],
"example": "Y"
}
}
},
Expand Down Expand Up @@ -333,7 +350,11 @@
},
"status": {
"type": "string",
"enum": ["BAV_SUCCESSFUL", "BAV_FAILED", "BAV_PENDING"]
"enum": [
"BAV_SUCCESSFUL",
"BAV_FAILED",
"BAV_PENDING"
]
},
"traceId": {
"type": "string",
Expand Down Expand Up @@ -422,7 +443,11 @@
"BundledBAVErrorResponse": {
"title": "BundledBAVErrorResponse",
"type": "object",
"required": ["success", "message", "traceId"],
"required": [
"success",
"message",
"traceId"
],
"properties": {
"success": {
"type": "boolean",
Expand Down
54 changes: 49 additions & 5 deletions content/data/bav/bundled-bav/api-integration.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ Integrating Bundled BAV into your application involves creating a verification r

Call the API to generate a verification URL for your customer.

**Request body**

| Field | Type | Required | Description |
| -------------- | ------ | -------- | -------------------------------------------------------------------------------------------- |
| `mobileNumber` | string | Yes | Customer's 10-digit mobile number |
| `consent` | string | Yes | Must be `"Y"` to enable the Mobile to Bank flow. Other BAV methods do not need explicit consent here since they take user input directly. |

<Row>
<Portion desktopSpan="whole">
<Tabs
Expand All @@ -33,7 +40,8 @@ Call the API to generate a verification URL for your customer.
<CodeBlockWithCopy language="json">
{`POST /api/bundled-bav
{
"mobileNumber": "9876543210"
"mobileNumber": "9876543210",
"consent": "Y"
}`}
</CodeBlockWithCopy>
<hr className="tertiary" />
Expand Down Expand Up @@ -65,15 +73,50 @@ Call the API to generate a verification URL for your customer.
<>
<p>
<Badge type="failure">BAD REQUEST</Badge>{" "}
Invalid product configuration or missing
required parameters.
Missing required fields or invalid product
configuration.
</p>
<hr className="tertiary" />
<h5>Request</h5>
<h5>Request — missing <code>consent</code></h5>
<CodeBlockWithCopy language="json">
{`POST /api/bundled-bav
{
"mobileNumber": "9876543210"
}`}
</CodeBlockWithCopy>
<hr className="tertiary" />
<h5>Response</h5>
<CodeBlockWithCopy language="json">
{`{
"success": false,
"message": "Bad request - consent is required",
"traceId": "1-1234567890"
}`}
</CodeBlockWithCopy>
<hr className="tertiary" />
<h5>Request — missing <code>mobileNumber</code></h5>
<CodeBlockWithCopy language="json">
{`POST /api/bundled-bav
{
"consent": "Y"
}`}
</CodeBlockWithCopy>
<hr className="tertiary" />
<h5>Response</h5>
<CodeBlockWithCopy language="json">
{`{
"success": false,
"message": "Bad request - mobileNumber is required",
"traceId": "1-1234567890"
}`}
</CodeBlockWithCopy>
<hr className="tertiary" />
<h5>Request — invalid product configuration</h5>
<CodeBlockWithCopy language="json">
{`POST /api/bundled-bav
{
"mobileNumber": "9876543210",
"consent": "Y"
}`}
</CodeBlockWithCopy>
<hr className="tertiary" />
Expand Down Expand Up @@ -104,7 +147,8 @@ Call the API to generate a verification URL for your customer.
<CodeBlockWithCopy language="json">
{`POST /api/bundled-bav
{
"mobileNumber": "9876543210"
"mobileNumber": "9876543210",
"consent": "Y"
}`}
</CodeBlockWithCopy>
<hr className="tertiary" />
Expand Down
2 changes: 1 addition & 1 deletion content/data/bav/bundled-bav/quickstart.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ You can simply create a request with the customer's phone number, which generate

### How does it work?

1. **Create a verification request** — Call the API with your customer's phone number to generate a verification URL
1. **Create a verification request** — Call the API with your customer's phone number and their consent (`"Y"`) to generate a verification URL
2. **Open URL in webview** — Display the URL in a webview within your app
3. **Customer completes verification** — The customer verifies their bank account using any of your enabled methods
4. **Receive webhook notification** — Once verification is complete, bank account details are sent to your configured webhook endpoint
Expand Down