Skip to content

Conversation

@ChayanBansal
Copy link
Contributor

  • added ValAdd & Mandate APIs [& webhooks]
  • updated Payment API
  • update List Billers API
  • one pager on FX Retail

Note: more exhaustive flows to be written once the PRD is shared

- added ValAdd & Mandate APIs [& webhooks]
- updated Payment API
- update List Billers API
- one pager on FX Retail
@github-actions
Copy link

github-actions bot commented Jan 9, 2026

Checklist to merge a PR 🚀

To merge this pull request, please take time to complete the checklist.

What action did you perform?

Review the corresponding checklist items for the action you performed and mark them done.

Edit an existing content (MDX) page

Checklist

  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • If a redirect is needed to the existing page, add a key, value pair in redirects.json

Edit an existing API reference page

Checklist


Add a new content (MDX) page

Checklist

  • Create a .mdx file with the path as its name in the content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Review changes using the MDX preview option
  • If the length of content >15000 chars, use the Content preview portal to view changes
  • Created a folder with the same name, if any children were to be added to the page
  • Once all changes are done, update the menu items by using the Menu Items option
  • Add a key, and value pair in redirects.json if you wish to have a redirect to the new page

Add a new API reference page

Checklist

  • Create a .json file with the product path as its name
  • Create an api-reference.mdx file in the respective product folder inside content folder
  • Add frontmatter with all the metadata
  • Review the order of items in Sidebar using the Sidebar preview option
  • Add API reference in JSON format (OpenAPI or Swagger) into created .json file.
  • Used the Content preview portal to view changes
  • Once all changes are done, update the menu items by using the Menu Items option


## Overview

**FX Retail** enables customers to buy (and in future, sell) foreign currency on the **FX Retail platform** via the **BBPS system**, directly from PSP apps that support BBPS (for example, CRED).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

are we okay with mentioning CRED?

- **`valAddFlag`**: whether value-added services are enabled for the biller
- **`valAddCustParams`**: required customer params for value-added flows (scoped by requestType)
- **`mandateRequirement`**: mandate requirement (e.g. `MANDATORY`)
- **`pseudoBiller`**: whether the biller is a pseudo biller
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do we have more info on what a "pseudo" biller actually means? let's add more info.

@@ -0,0 +1,123 @@
---
sidebar_title: FX Retail flow
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there any mention of FX Retail terminology anywhere in the spec? if not, I think sticking to "Forex" terminology is easier to understand. Should be a product call though.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants