Our Rate Card API is designed to facilitate the setup and maintenance of rate cards, enabling lenders and merchants to effectively generate revenue from transactions. This API allows you to determine the appropriate percentage rates, either as a subsidy (income earned by the lender) or a commission (income earned by the merchant), to apply to each transaction.
Rate Card Management
To manage the lifecycle of a Rate Cards, use our Rate Card Management endpoints.
| Endpoint | Description |
|---|---|
| Create Rate Card | Use the Create Rate Card From Records endpoint to establish a new rate card. |
| Activate Rate Card | Activate your Rate Card with the Activate RateCard endpoint, making it ready for use. |
| Update Rate Card | If changes are needed before activation, utilise the Update RateCard From Records endpoint. Note that once activated, no further changes can be made. |
| Expire Rate Card | To discontinue a rate card, use the Expire RateCard endpoint. |
| Retrieve Rate Card | Access a specific rate card using the Retrieve RateCard endpoint. |
| Retrieve All Rate Cards | Get a list of all rate cards with the Retrieve All RateCards endpoint. |
Merchant to Rate Card Association
Once a rate card is created and activated, it can be associated with a merchant. Use our Association endpoints to manage this relationship.
| Endpoint | Description |
|---|---|
| Create Rate Card Association | Use the Create RateCard Association endpoint to link a merchant to an activated rate card. |
| Update Rate Card Association | If you need to change the association start date, use the Update RateCard Association endpoint. |
| Remove Rate Card Association | To unlink a merchant from a rate card, utilize the Remove RateCard Association endpoint. |
| Retrieve All Rate Card Associations | Get a comprehensive list of all rate card associations for a merchant using the Retrieve all RateCard Associations endpoint. |
| Retrieve Current Rate Card Association | Check the current association between a merchant and a rate card with the Retrieve Current RateCard Association endpoint. |
You may also like:
Still have questions?
Can’t find the answer to your question? Our friendly team are more than happy to help
Was this page helpful?