GANDYAMPAY API Documentation

Show Public Routes Only

action-history

/admin/action-history

GET Auth Required

Description: Get all action history items

Accessible by: Admin Super Admin

Try it out

actionLog

/action-logs

GET Auth Required

Description: Get action logs

Accessible by:

Try it out

/action-logs/search

GET Auth Required

Description: Search user action logs

Accessible by:

Try it out

affiliation

/affiliations

GET Auth Required

Description: Get all affiliations

Accessible by:

Try it out

/affiliations/user

GET Auth Required

Description: Get all affiliations from a user

Accessible by:

Try it out

application-update-infos

/application-update-infos

GET

Description: Get all application update infos

Accessible by:

Try it out

/application-update-infos/latest

GET

Description: Get lastest application update infos

Accessible by:

Try it out

/application-update-infos

POST Auth Required

Description: Create new application update infos

Accessible by: Admin Super Admin

Try it out

/application-update-infos

PUT Auth Required

Description: Update existing application update infos

Accessible by: Admin Super Admin

Try it out

auth

/user/register

POST

Description: Create a new user

Accessible by:

Try it out

/login

POST

Description: Authenticate existing user

Accessible by:

Try it out

/user/create

POST Auth Required

Description: Create a new custom user as an admin or superadmin

Accessible by:

Try it out

/user/auth/refresh

GET

Description: Refresh user token

Accessible by:

Try it out

blog

/blog/add

POST Auth Required

Description: Create new blog post

Accessible by:

Try it out

/blog/all

GET Auth Required

Description: Get all blog posts

Accessible by:

Try it out

/blog/delete

DELETE Auth Required

Description: Delete blog post

Accessible by:

Try it out

/blog/update

POST Auth Required

Description: Update blog post

Accessible by:

Try it out

/blog/:blog_id/comments

GET Auth Required

Description: Get blog post comments by id

Accessible by:

Try it out

/blog/comments/add

POST Auth Required

Description: Create blog post comment

Accessible by:

Try it out

/blog/comments/:id/delete

DELETE Auth Required

Description: Delete blog post comment

Accessible by:

Try it out

chat

/chat/add

POST Auth Required

Description: Add new chat

Accessible by:

Try it out

/chat/admin/add

POST Auth Required

Description: Create new chat

Accessible by: Admin Super Admin

Try it out

/chat/paginated/get

GET Auth Required

Description: Get all chats with pagination

Accessible by:

Try it out

/chat/get/single/:user_id

GET Auth Required

Description: Get a chat from a user

Accessible by:

Try it out

/chat/paginated/get/single/:user_id

GET Auth Required

Description: Get a chat from a user with pagination

Accessible by:

Try it out

/chat/update

PUT Auth Required

Description: Update a chat

Accessible by:

Try it out

/chat/content/add

POST Auth Required

Description: Add new content to a chat

Accessible by:

Try it out

/chat/content_file/add

POST Auth Required

Description: Add new file content to a chat

Accessible by:

Try it out

/chat/content/get/:chat_id

GET Auth Required

Description: Get a chat content

Accessible by:

Try it out

/chat/content/user/get

GET Auth Required

Description: Get a chat content from a user

Accessible by:

Try it out

/chat/content/update/:id

PUT Auth Required

Description: Update a chat content

Accessible by:

Try it out

/chat/close/:chat_id

PUT Auth Required

Description: Close a chat

Accessible by:

Try it out

/chat/read/:chat_id

POST Auth Required

Description: Read a chat

Accessible by:

Try it out

/chat/getUnreadMessagesCount

GET Auth Required

Description: Get getUnreadMessagesCount

Accessible by:

Try it out

/chat/get/:chat_id

GET Auth Required

Description: Get a chat by chat id

Accessible by:

Try it out

content

/videos/verificationTutorial

GET

Description: Get video tutorial for verification

Accessible by:

Try it out

countries

/countries

GET

Description: Get all countries

Accessible by:

Try it out

/countries/get_by_name

GET Auth Required

Description: Get countries by name

Accessible by:

Try it out

/countries/paginated/get_by_filter

POST Auth Required

Description: Get countries by filter with pagination

Accessible by:

Try it out

/country/add

POST Auth Required

Description: Create country

Accessible by: Super Admin

Try it out

/country/update

POST Auth Required

Description: Update country

Accessible by: Super Admin

Try it out

/country/delete

DELETE Auth Required

Description: Delete country

Accessible by: Super Admin

Try it out

/country/actif/update

POST Auth Required

Description: Update country actif or not

Accessible by:

Try it out

/countries/clean-duplicates

POST Auth Required

Description: Clean duplicate countries from database (ADMIN ONLY)

Accessible by: Super Admin

Try it out

documents

/user/documents/add

POST Auth Required

Description: Create new documents for a user

Accessible by:

Try it out

/user/documents/update

POST Auth Required

Description: Update documents for a user

Accessible by:

Try it out

/user/documents/process

POST Auth Required

Description: Process documents for a user

Accessible by:

Try it out

/user/documents/get/:user

GET Auth Required

Description: Get documents for a user

Accessible by:

Try it out

/user/documents/delete/:user

POST Auth Required

Description: Delete documents for a user

Accessible by:

Try it out

entrepot

/entrepot/add

POST Auth Required

Description: Create a entrepot trajet

Accessible by:

Try it out

/entrepot/update

POST Auth Required

Description: Update a entrepot trajet

Accessible by:

Try it out

/entrepot/get_all

GET Auth Required

Description: Get all entrepot

Accessible by:

Try it out

/entrepot/get_all_by_country/:idPays

GET Auth Required

Description: Get all entrepot by country

Accessible by:

Try it out

/entrepot/delete/:id

DELETE Auth Required

Description: Delete a entrepot by ID

Accessible by:

Try it out

/entrepot/actif/update

POST Auth Required

Description: Update entrepot actif or not

Accessible by:

Try it out

facture

/facture/get_all

GET Auth Required

Description: Get all Facture

Accessible by:

Try it out

/facture/:userId/get_all

GET Auth Required

Description: Get all user Facture

Accessible by:

Try it out

/facture/:id

GET Auth Required

Description: Get Facture by id

Accessible by:

Try it out

/facture/delete/:id

DELETE Auth Required

Description: Delete a Facture by ID

Accessible by:

Try it out

/facture/isPayed/update

POST Auth Required

Description: Update facture payed or not

Accessible by:

Try it out

faq

/faq/add

POST Auth Required

Description: Add a new Faq

Accessible by:

Try it out

/faq/update

POST Auth Required

Description: Add a new Faq

Accessible by:

Try it out

/faq/get_all

GET Auth Required

Description: Get all Faq

Accessible by:

Try it out

/faq/delete/:id

DELETE Auth Required

Description: Delete a Faq by ID

Accessible by:

Try it out

flash-news

/flashNews/create

POST Auth Required

Description: Create a flash news

Accessible by: Super Admin

Try it out

/flashNews/update

POST Auth Required

Description: Update a flash news

Accessible by: Super Admin

Try it out

/flashNews/delete

POST Auth Required

Description: Delete a flash news

Accessible by: Super Admin

Try it out

/flashNews/userUnread

GET Auth Required

Description: Get user flash news

Accessible by:

Try it out

/flashNews/view

POST Auth Required

Description: User view flash news

Accessible by:

Try it out

/flashNews/clicked

POST Auth Required

Description: User clicked on flash news

Accessible by:

Try it out

/flashNews/all

GET Auth Required

Description: Get all flash news with stats

Accessible by:

Try it out

maintenance

/trigger-maintenance

POST Auth Required

Description: Set Maintenance mode

Accessible by:

Try it out

/trigger-maintenance

GET Auth Required

Description: Get Maintenance mode

Accessible by:

Try it out

marge

/marge/create

POST Auth Required

Description: Create a marge

Accessible by: Admin Super Admin

Try it out

/marge/update

POST Auth Required

Description: Update marge

Accessible by: Admin Super Admin

Try it out

/marge/delete

POST Auth Required

Description: Delete a marge

Accessible by: Admin Super Admin

Try it out

/marge/all

POST Auth Required

Description: Get all marge

Accessible by: Admin Super Admin

Try it out

moyen_payemeny_trajet

/moyen_paiement_trajet/add

POST Auth Required

Description: Create a payment method trajet

Accessible by:

Try it out

/moyen_paiement_trajet/update

POST Auth Required

Description: Update a payment method trajet

Accessible by:

Try it out

/moyen_paiement_trajet/get_all

GET Auth Required

Description: Get all payment methods trajet by payment ID

Accessible by:

Try it out

/moyen_paiement_trajet/get_all_by_trajet/:idTrajet

GET Auth Required

Description: Get all payment methods by trajet

Accessible by:

Try it out

/moyen_paiement_trajet/delete/:id

DELETE Auth Required

Description: Delete a payment method by ID

Accessible by:

Try it out

notification

/notification/add

POST Auth Required

Description: Create notification

Accessible by:

Try it out

/notification/get

GET Auth Required

Description: Get notification

Accessible by:

Try it out

/notification/get/unread/:user

GET Auth Required

Description: Get unread notification

Accessible by:

Try it out

/notification/get/read/:user

GET Auth Required

Description: Get read notification

Accessible by:

Try it out

/notification/user/all/:user

GET Auth Required

Description: Get user notification

Accessible by:

Try it out

/notification/get/:id

GET Auth Required

Description: Get notification by id

Accessible by:

Try it out

/notification/update

POST Auth Required

Description: Update notification

Accessible by:

Try it out

/notification/user/update

POST Auth Required

Description: Update user notification

Accessible by:

Try it out

/notification/send-group-msg

POST Auth Required

Description: Send push or email notifications to a group

Accessible by:

Try it out

payment

/paiement/add

POST Auth Required

Description: Create payment for a facture

Accessible by:

Try it out

/paiement/update

POST Auth Required

Description: Update payment for a facture

Accessible by:

Try it out

/paiement/validatorId/update

POST Auth Required

Description: Update validatorId for a facture

Accessible by:

Try it out

/paiement/rejectReason/add

POST Auth Required

Description: Update reject reason for a facture

Accessible by:

Try it out

/paiement/add/invoice

POST Auth Required

Description: Attache an invice to Payment

Accessible by:

Try it out

/paiement/get_all

GET Auth Required

Description: Get all payments

Accessible by:

Try it out

/paiement/get/:id

GET Auth Required

Description: Get payment by id

Accessible by:

Try it out

/paiement/get/by_facture/:factureId

GET Auth Required

Description: Get payment by facture id

Accessible by:

Try it out

/paiement/delete/:id

DELETE Auth Required

Description: Delete payment by id

Accessible by:

Try it out

/paiement/delete/:id/invoice

DELETE Auth Required

Description: Delete payment invoice

Accessible by:

Try it out

payment-config

/payment-config/add

POST

Description: Create Payment Configuration for a Country

Accessible by:

Try it out

/payment-config/:countryId

PUT

Description: Update Payment Configuration for a Country

Accessible by:

Try it out

/payment-config/:countryId

GET

Description: Get Payment Configuration for a Country

Accessible by:

Try it out

/payment-config

GET

Description: Create all Payment Configuration for all Countries

Accessible by:

Try it out

payment-inputs

/payment_inputs/generate

POST Auth Required

Description: Generate payment inputs

Accessible by:

Try it out

/payment_inputs/get_all

GET Auth Required

Description: Get all payment inputs

Accessible by:

Try it out

/pays_payment_inputs/add

POST Auth Required

Description: Add payment inputs for a country

Accessible by:

Try it out

/pays_payment_inputs/get/:pays_id

GET Auth Required

Description: Get payment inputs by country ID

Accessible by:

Try it out

/pays_payment_inputs/delete/:pays_id/:input_id

DELETE Auth Required

Description: Delete a specific payment input by country ID and input ID

Accessible by:

Try it out

payment-methods

/moyen_paiement/add

POST Auth Required

Description: Create a payment method

Accessible by:

Try it out

/moyen_paiement/update

POST Auth Required

Description: Update a payment method

Accessible by:

Try it out

/moyen_paiement/get_all/:payId

GET Auth Required

Description: Get all payment methods by payment ID

Accessible by:

Try it out

/moyen_paiement/get_all

GET Auth Required

Description: Get all payment methods by payment ID

Accessible by:

Try it out

/moyen_paiement/get_all_by_type

GET Auth Required

Description: Get all payment methods by type

Accessible by:

Try it out

/moyen_paiement/delete/:id

DELETE Auth Required

Description: Delete a payment method by ID

Accessible by:

Try it out

/moyen_paiement/actif/update

POST Auth Required

Description: Update moyen_paiement actif or not

Accessible by:

Try it out

/moyen_paiement/isAutomate/update

POST Auth Required

Description: Update moyen_paiement actif or not

Accessible by:

Try it out

permissions

/user/permission/add

POST Auth Required

Description: Add permission to a user

Accessible by: Super Admin

Try it out

/user/permission/update

POST Auth Required

Description: Update user permission

Accessible by: Super Admin

Try it out

/user/permission/:id

GET Auth Required

Description: Get a user's permission by ID

Accessible by:

Try it out

promo-code

/promoCode/create

POST Auth Required

Description: Create a promo code

Accessible by: Super Admin

Try it out

/promoCode/update

POST Auth Required

Description: Update a promo code

Accessible by: Super Admin

Try it out

/promoCode/delete

POST Auth Required

Description: Delete a promo code

Accessible by: Super Admin

Try it out

/promoCode/get/:code

GET Auth Required

Description: Get one promo code with code

Accessible by:

Try it out

/promoCode/get_all

GET Auth Required

Description: Get all promo code

Accessible by: Admin Super Admin

Try it out

/promoCode/filter

POST Auth Required

Description: Filter promo code

Accessible by: Admin Super Admin

Try it out

/promoCode/hasValidPromoCode

POST Auth Required

Description: Check if valid promoCode

Accessible by:

Try it out

tickets

/ticket

POST Auth Required

Description: Create new ticket

Accessible by:

Try it out

/ticket/:ticketId

PUT Auth Required

Description: Update ticket

Accessible by:

Try it out

/ticket

GET Auth Required

Description: Get all tickets

Accessible by:

Try it out

/ticket/:ticketId

GET Auth Required

Description: Get ticket by ID

Accessible by:

Try it out

/user/:userId/tickets

GET Auth Required

Description: Get all tickets for a user

Accessible by:

Try it out

/ticket/:ticketId/reopen

PUT Auth Required

Description: Reopen a ticket

Accessible by:

Try it out

/ticket/:ticketId

DELETE Auth Required

Description: Delete ticket

Accessible by:

Try it out

/ticket/:ticketId/close

PUT Auth Required

Description: Close a ticket

Accessible by:

Try it out

/ticket/:ticketId/assign

PUT Auth Required

Description: Assign a ticket to an admin

Accessible by:

Try it out

/ticket/:ticketId/rate

PUT Auth Required

Description: Rate a ticket

Accessible by:

Try it out

trajet

/trajet/all

GET

Description: Get all trajet

Accessible by:

Try it out

/trajet/:id

GET

Description: Get trajet by name

Accessible by:

Try it out

/trajet/by-pays-envoi/:id_pays_envoi

GET

Description: Get trajets by id pays envoi

Accessible by:

Try it out

/trajet/add

POST Auth Required

Description: Create country

Accessible by: Super Admin

Try it out

/trajet/update

POST Auth Required

Description: Update trajet

Accessible by: Super Admin

Try it out

/trajet/delete

DELETE Auth Required

Description: Delete trajet

Accessible by: Super Admin

Try it out

transaction_lock_unlock

/open-transaction

POST Auth Required

Description: Ouvre une transaction pour un admin

Accessible by:

Try it out

/close-transaction

POST Auth Required

Description: Ferme une transaction ouverte par un admin

Accessible by:

Try it out

/is-locked-transaction

GET Auth Required

Description: Vérifie si une transaction est verrouillée (ouverte par un admin)

Accessible by:

Try it out

transactions

/transaction/add

POST Auth Required

Description: Create new transaction for a user

Accessible by:

Try it out

/transaction/update

POST Auth Required

Description: Update transaction for a user

Accessible by:

Try it out

/transaction/get_all

GET Auth Required

Description: Get all transactions

Accessible by:

Try it out

/transaction/get/:id

GET Auth Required

Description: Get transaction by id

Accessible by:

Try it out

/transaction/delete

DELETE Auth Required

Description: Delete transaction by id

Accessible by:

Try it out

/transaction/:user/find_with_filters

GET Auth Required

Description: Get user and filtered transactions

Accessible by:

Try it out

/transaction/paginated/find_with_filters

POST Auth Required

Description: Get all filtered transactions with pagination

Accessible by:

Try it out

/transaction/statut/update

POST Auth Required

Description: Update Commande status

Accessible by:

Try it out

/transaction/canceled

POST Auth Required

Description: canceled Commande

Accessible by:

Try it out

/transaction/add-reject-reason

POST Auth Required

Description: Add reject reason to transaction

Accessible by:

Try it out

/transaction/:user/all

GET Auth Required

Description: Get all transactions for a user

Accessible by:

Try it out

/transaction/paginated/:userId/all

POST Auth Required

Description: Get all transactions with pagination for a user

Accessible by:

Try it out

/transaction/check/:user/all

GET Auth Required

Description: Get all transactions for check for a user

Accessible by:

Try it out

/transaction/process

POST Auth Required

Description: Process (validate, reject) transaction for a user

Accessible by: Admin Super Admin

Try it out

/transaction/country

GET Auth Required

Description: Recupere les transactions par pays

Accessible by:

Try it out

/transaction/period

GET Auth Required

Description: Recupere les transactions par period

Accessible by:

Try it out

/transaction/total

GET Auth Required

Description: Recupere le Total de transactions

Accessible by:

Try it out

/transaction/active-countries

GET Auth Required

Description: Recupere les 5 pays avec le plus de transaction

Accessible by:

Try it out

/transaction/total-by-currency

GET Auth Required

Description: Recupere le nombre de transaction par devise

Accessible by:

Try it out

/transaction/approve

POST Auth Required

Description: Approve transaction by admin

Accessible by: Admin Super Admin

Try it out

/transaction/export

GET Auth Required

Description: export en un fichier csv

Accessible by:

Try it out

type_marchandise

/merchandiseCategory/add

POST Auth Required

Description: Add a new MerchandiseCategory

Accessible by:

Try it out

/merchandiseCategory/update

POST Auth Required

Description: Update a MerchandiseCategory

Accessible by:

Try it out

/merchandiseCategory/get_all

GET

Description: Get all MerchandiseCategories with subcategories and merchandises

Accessible by:

Try it out

/merchandiseCategory/delete/:id

DELETE Auth Required

Description: Delete a MerchandiseCategory by ID

Accessible by:

Try it out

/merchandiseSubcategory/add

POST Auth Required

Description: Add a new MerchandiseSubcategory

Accessible by:

Try it out

/merchandiseSubcategory/update

POST Auth Required

Description: Update a MerchandiseSubcategory

Accessible by:

Try it out

/merchandiseSubcategory/get_all

GET

Description: Get all MerchandiseSubcategories with categories and merchandises

Accessible by:

Try it out

/merchandiseSubcategory/delete/:id

DELETE Auth Required

Description: Delete a MerchandiseSubcategory by ID

Accessible by:

Try it out

/merchandise/add

POST Auth Required

Description: Add a new Merchandise

Accessible by:

Try it out

/merchandise/update

POST Auth Required

Description: Update a Merchandise

Accessible by:

Try it out

/merchandise/get_all

GET

Description: Get all Merchandises with subcategories and categories

Accessible by:

Try it out

/merchandise/delete/:id

DELETE Auth Required

Description: Delete a Merchandise by ID

Accessible by:

Try it out

upload

/upload/image

POST

Description: Upload a base64 image and get file url

Accessible by:

Try it out

users

/user/custom_user/update

POST Auth Required

Description: Update custom user

Accessible by:

Try it out

/user/resete_password

POST Auth Required

Description: Update custom user password

Accessible by:

Try it out

/user/update/picture

POST Auth Required

Description: Update user picture

Accessible by:

Try it out

/user/update/infos

POST Auth Required

Description: Update user infos

Accessible by:

Try it out

/user/complete/infos

POST Auth Required

Description: Update user infos

Accessible by:

Try it out

/clients/paginated

POST Auth Required

Description: Get all clients with pagination

Accessible by:

Try it out

/users/countUsersByVerificationStatus

GET Auth Required

Description: Count users by document status

Accessible by:

Try it out

/user/get

GET Auth Required

Description: Get a single user by ID

Accessible by:

Try it out

/user/block

POST Auth Required

Description: Block a user

Accessible by:

Try it out

/users/recent

GET Auth Required

Description: Get users registered in the last 7 days

Accessible by:

Try it out

/users/status/:status

GET Auth Required

Description: Get users filtered by document status

Accessible by:

Try it out

/user/delete/:id

DELETE Auth Required

Description: Delete a user by ID

Accessible by:

Try it out

/user/active/:email

GET

Description: Active a user by ID

Accessible by:

Try it out