Docs

Rate Card

Ratecard allows Clients to configure subsidy or commission to be applied to Settle, Refund and Chargeback transactions.

api reference

Environment URLs

EnvironmentBase URL
Staginghttps://mtapi.stg-newdaytechnology.net/cl/rate-card-service
Productionhttps://mtapi.newdaytechnology.net/cl/rate-card-service

Endpoints

post
/merchants/{merchantId}/rate-cards/{rateCardId}/association
delete
/merchants/{merchantId}/rate-cards/{rateCardId}/association
get
/merchants/{merchantId}/rate-cards/associations
get
/merchants/{merchantId}/rate-card
post
/rate-cards/grid
put
/rate-cards/{rateCardId}/grid
get
/rate-cards/{rateCardId}/grid
post
/rate-cards/records
put
/rate-cards/{rateCardId}/records
put
/rate-cards/{rateCardId}/activate
put
/rate-cards/{rateCardId}/expire
get
/rate-cards/{rateCardId}
get
/rate-cards

RateCard Association

Creates or updates a rate card assocation between a merchant and a rate card. If the association already exists, it is updated. If the association does not already exist, it is created.

post

/merchants/{merchantId}/rate-cards/{rateCardId}/association

Remove RateCard Association

Remove a rate card assocation between a merchant and a rate card.

delete

/merchants/{merchantId}/rate-cards/{rateCardId}/association

Retrieve all RateCard Associations

Retrieve all the rate card assocations for a merchant.

get

/merchants/{merchantId}/rate-cards/associations

Retrieve Current RateCard Association

Get the current rate card associated with a merchant.

get

/merchants/{merchantId}/rate-card

CreateRateCardFromGrid

Creates a complete rate card, using the grid specification.

post

/rate-cards/grid

UpdateRateCardFromGrid

Updates rate card details, using the grid specification.

put

/rate-cards/{rateCardId}/grid

RetrieveRateCardGrid

Gets the details of the rate card, in a grid format.

get

/rate-cards/{rateCardId}/grid

CreateRateCardFromRecords

Creates a complete rate card, from a list of rate card records.

post

/rate-cards/records

UpdateRateCardFromRecords

Updates rate card details, from a list of rate card records.

put

/rate-cards/{rateCardId}/records

ActivateRateCard

Activates a rate card.

put

/rate-cards/{rateCardId}/activate

ExpireRateCard

Expires a rate card.

put

/rate-cards/{rateCardId}/expire

RetrieveRateCard

Retrieves a rate card.

get

/rate-cards/{rateCardId}

RetrieveAllRateCards

Retrieves all rate cards.

get

/rate-cards

Models

Request to complete a rate card grid specification.

Request to complete a rate card

Request to create a rate card from records

Response sent when a rate card is created.

Response sent when a rate card grid is retrieved.

Rate card grid specification.

Response when a rate card is requested.

Spend details for an item on the rate card.

The response sent when a list of rate card details has been requested.

Rate card details.

Response sent when the spend details are requested.

Subsidy Commission Value.

Transaction details.

Used when associating a rate card with a merchant.

Request to create a rate card record specification.

RateCardStatus•
string enum

Rate card status.

The spend details for a rate card.

SpendType•
string enum

Spend Type

Subsidy commission associated with the rate card.

Details of the transaction that can be applied to the rate card.

Was this page helpful?