Create a charge request
Request for a QR code payment
curl --request POST \
--url https://api.paycashless.com/v1/chargeRequests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"expiry": "<string>",
"type": "qr",
"qr": {
"intentType": "static",
"merchantId": 123,
"merchantAccountId": 123,
"merchantAccountNumber": "<string>",
"merchantBankCode": "<string>",
"merchantCategoryCode": "<string>",
"countryCode": "<string>",
"merchantName": "<string>",
"merchantCity": "<string>",
"postalCode": "<string>",
"amount": 123,
"currency": "<string>",
"storeLabel": "<string>",
"customerLabel": "<string>",
"terminalLabel": "<string>",
"reference": "<string>",
"narration": "<string>",
"merchantChannel": "<string>"
}
}'{
"id": "<string>",
"qr": {
"intentType": "static",
"merchantId": 123,
"merchantAccountId": 123,
"merchantAccountNumber": "<string>",
"merchantBankCode": "<string>",
"merchantCategoryCode": "<string>",
"countryCode": "<string>",
"merchantName": "<string>",
"merchantCity": "<string>",
"postalCode": "<string>",
"amount": 123,
"currency": "<string>",
"storeLabel": "<string>",
"customerLabel": "<string>",
"terminalLabel": "<string>",
"reference": "<string>",
"narration": "<string>",
"merchantChannel": "<string>",
"checksum": "<string>"
},
"token": "<string>",
"url": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
When QR code should expire eg. never, 1h, 2h, 3h...
Type of payment
qr Content of the QR code
Static or dynamic QR code
static, dynamic Unique ID of the merchant
Unique Index of the merchant account details, if passed, merchantAccountNumber and merchantBankCode are ignored
Account number of the merchant where funds will be settled
Bank code of the merchant's bank
Merchant category code as defined by ISO 18245
2 character country code as defined by ISO 3166-1 alpha-2
Merchant name that can be recognised by payer
Merchant city where business resides
Postal code of merchant location
Amount to be charged (must be in smallest currency unit eg. kobo), use 0 to allow payer enter amount
Curency is to conform with ISO 4217 containing 3 digit numeric representation of the transaction currency
A label or string to identify the merchant store
A label or string to identify the customer if known
A label to identify the payment terminal in the merchant store
A reference to identify the payment, to be use for reconciliation
a description for purpose of payment
Merchant channel is a 3 chracter string each chracter in each position identifies the characteristic of the channel used for the transaction. The possible value of each character and its definition are listed below
Response
Charge request unique identifier
QR code contents
Static or dynamic QR code
static, dynamic Unique ID of the merchant
Unique Index of the merchant account details, if passed, merchantAccountNumber and merchantBankCode are ignored
Account number of the merchant where funds will be settled
Bank code of the merchant's bank
Merchant category code as defined by ISO 18245
2 character country code as defined by ISO 3166-1 alpha-2
Merchant name that can be recognised by payer
Merchant city where business resides
Postal code of merchant location
Amount to be charged (must be in smallest currency unit eg. kobo), use 0 to allow payer enter amount
Curency is to conform with ISO 4217 containing 3 digit numeric representation of the transaction currency
A label or string to identify the merchant store
A label or string to identify the customer if known
A label to identify the payment terminal in the merchant store
A reference to identify the payment, to be use for reconciliation
a description for purpose of payment
Merchant channel is a 3 chracter string each chracter in each position identifies the characteristic of the channel used for the transaction. The possible value of each character and its definition are listed below
Cyclic redundancy check to ensure content is not tampered with
A unique token of the QR code
Payment link to insert as content of the QR code
curl --request POST \
--url https://api.paycashless.com/v1/chargeRequests \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
"expiry": "<string>",
"type": "qr",
"qr": {
"intentType": "static",
"merchantId": 123,
"merchantAccountId": 123,
"merchantAccountNumber": "<string>",
"merchantBankCode": "<string>",
"merchantCategoryCode": "<string>",
"countryCode": "<string>",
"merchantName": "<string>",
"merchantCity": "<string>",
"postalCode": "<string>",
"amount": 123,
"currency": "<string>",
"storeLabel": "<string>",
"customerLabel": "<string>",
"terminalLabel": "<string>",
"reference": "<string>",
"narration": "<string>",
"merchantChannel": "<string>"
}
}'{
"id": "<string>",
"qr": {
"intentType": "static",
"merchantId": 123,
"merchantAccountId": 123,
"merchantAccountNumber": "<string>",
"merchantBankCode": "<string>",
"merchantCategoryCode": "<string>",
"countryCode": "<string>",
"merchantName": "<string>",
"merchantCity": "<string>",
"postalCode": "<string>",
"amount": 123,
"currency": "<string>",
"storeLabel": "<string>",
"customerLabel": "<string>",
"terminalLabel": "<string>",
"reference": "<string>",
"narration": "<string>",
"merchantChannel": "<string>",
"checksum": "<string>"
},
"token": "<string>",
"url": "<string>"
}