Creating a quotation.

post

https://gateway-am.apps.ins.inswhub.com/quotations/1.0/quotations/type/{transactionType}

With a valid object representation, this endpoint allows creating a new quotation for a specific type sent through a URL.

Path Params

transactionType

string

enum

required

Identifies the type of transaction to create a quotation for

Body Params

Represents the request body of a quotation.

amount

string

required

length between 1 and 23

Transaction amount.

currency

string

enum

required

Currency of the transaction amount.

subType

string

length between 0 and 256

A non-harmonised sub-classification of the transaction type. Values are not fixed and usage will vary depending on the provider.

debitParty

required

creditParty

required

descriptionText

string

length between 0 and 160

Free format text description of the transaction provided by the client. This can be sent in a notification SMS and an account statement as a reference for the receiver.

requestDate

date-time

Creation date and time of the object as supplied by the client.

requestingOrganisationTransactionReference

string

length between 0 and 256

Reference provided by the requesting organization that will be associated with the transaction.

country

string

enum

required

geoCode

string

length between 0 and 256

Shows the geographic location where the transaction was initiated.

senderKyc

recipientKyc

metadata

array of objects

length ≤ 20

A collection of key/value pairs. These can be used to populate additional object properties.

metadata

Headers

X-Date

date-time

Header parameter that informs the date and time when the message was originated. It is used for basic message integrity checks, to ensure the request is not stale. Note that the header was previously referenced as 'Date' in version 1.0 of the Mobile Money API.

apikey

string

It is used to send the pre-shared client's API key to the server.

X-User-Bearer

string

required

It is used to send the user’s access token when OAuth 2.0/OIDC authorization framework is used for end-user authentication.

Responses

Language

Credentials

OAuth2

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201Represents a quotation response.

400Represents an error caused by a business rule violation.

401Represents an error caused by an authorization failure.

404Represents an error caused by a failure to identify the target resource.

500Represents an error caused by a general server-side issue.

503Represents an error caused by system unavailability.