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/add

POST

Description: Create a new user

Accessible by:

Try it out

/login

POST

Description: Authenticate existing user

Accessible by:

Try it out

/custom_user

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

automation

/automation/createPaymentIntent

POST Auth Required

Description: Create payment intent for a automate payment method

Accessible by:

Try it out

blog

/blog/add

POST Auth Required

Description: Create new blog post

Accessible by:

Try it out

/blog/all

GET

Description: Get all blog posts

Accessible by:

Try it out

/blog/delete

GET 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/: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

GET 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

POST Auth Required

Description: Get all chats with pagination

Accessible by:

Try it out

/chat/paginated/get/single/:user_id

POST Auth Required

Description: Get a chat from a user with pagination

Accessible by:

Try it out

/chat/update

POST 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

GET 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

/chat/content/delete/:id

POST Auth Required

Description: Delete a chat content

Accessible by:

Try it out

content

/videos/verificationTutorial

GET

Description: Get video tutorial for verification

Accessible by:

Try it out

countries

/country

POST Auth Required

Description: Create country

Accessible by: Super Admin

Try it out

/country

PATCH Auth Required

Description: Update country

Accessible by: Super Admin

Try it out

/country

DELETE Auth Required

Description: Delete country

Accessible by: Super Admin

Try it out

/countries/all

GET Auth Required

Description: Get all countries

Accessible by:

Try it out

/countries/filter

POST Auth Required

Description: Get countries paginated with filters

Accessible by:

Try it out

/countries/sending

GET

Description: Get sending countries

Accessible by:

Try it out

/country/enableSending

POST Auth Required

Description: Change a country enableSending value

Accessible by: Super Admin

Try it out

/countries/get_by_name

GET Auth Required

Description: Get countries by name

Accessible by:

Try it out

currency

/currencies

GET

Description: Get all currencies

Accessible by:

Try it out

/currency/add_currency

POST Auth Required

Description: Add new currency

Accessible by: Super Admin

Try it out

/currency/upd_currency

POST Auth Required

Description: Update currency

Accessible by: Super Admin

Try it out

/currency/del_currency

GET Auth Required

Description: Delete currency

Accessible by: Super Admin

Try it out

/currency/restore_currency

GET Auth Required

Description: Restore currency

Accessible by: Super Admin

Try it out

/currency/get_by_name

GET

Description: Get currency by name

Accessible by:

Try it out

/currency/get_by_abbr

GET

Description: Get currency bu abbr

Accessible by:

Try it out

/currency/paginated/all_with_filters

POST

Description: Get all currencies with filters with pagination

Accessible by:

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

exchange-rate

/exchange_rate/add_rate

POST Auth Required

Description: Add Exchange rate

Accessible by: Super Admin

Try it out

/exchange_rate/get_single

GET

Description: Get Exchange rate

Accessible by:

Try it out

/exchange_rate/get_by_currency

GET

Description: Get Exchange rate by currency

Accessible by:

Try it out

/exchange_rate/del_rest

GET Auth Required

Description: Delete Exchange rate

Accessible by: Super Admin

Try it out

/exchange_rate/update_rate

POST Auth Required

Description: Update Exchange rate

Accessible by: Super Admin

Try it out

/exchange_rate/get_all

GET

Description: Get all Exchange rate

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/:id/view

POST Auth Required

Description: User view flash news

Accessible by:

Try it out

/flashNews/:id/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

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/read/: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/get/update

POST Auth Required

Description: Update notification

Accessible by:

Try it out

/notification/get/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

payment

/paiement/add

POST Auth Required

Description: Create payment for a transaction

Accessible by:

Try it out

/paiement/update

POST Auth Required

Description: Update payment for a transaction

Accessible by:

Try it out

/paiement/update/:id/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/delete/:id

GET 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

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/:id

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-method

/paymentMethod/create

POST Auth Required

Description: Create a payment method

Accessible by: Admin Super Admin

Try it out

/paymentMethod/update

POST Auth Required

Description: Update a payment method

Accessible by: Admin Super Admin

Try it out

/paymentMethod/delete

POST Auth Required

Description: Delete a payment method

Accessible by: Admin Super Admin

Try it out

/paymentMethod/getByCountryAndType

POST Auth Required

Description: Get payment method with params

Accessible by:

Try it out

/paymentMethod/isActive

POST Auth Required

Description: Change a payment method isActive value

Accessible by: Admin Super Admin

Try it out

payment-motives

/motif/add

POST Auth Required

Description: Add a new motif

Accessible by:

Try it out

/motif/update

POST Auth Required

Description: Update a motif

Accessible by:

Try it out

/motif/get_all

GET Auth Required

Description: Get all motifs

Accessible by:

Try it out

/motif/delete/:id

GET Auth Required

Description: Delete a motif by ID

Accessible by:

Try it out

payment-relationships

/lien/add

POST Auth Required

Description: Add a new lien

Accessible by:

Try it out

/lien/update

POST Auth Required

Description: Add a new lien

Accessible by:

Try it out

/lien/get_all

GET Auth Required

Description: Get all liens

Accessible by:

Try it out

/lien/delete/:id

GET Auth Required

Description: Delete a lien by ID

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 for a taux transaction

Accessible by: Super Admin

Try it out

/promoCode/update

POST Auth Required

Description: Update a promo code for a taux transaction

Accessible by: Super Admin

Try it out

/promoCode/delete

POST Auth Required

Description: Delete a promo code for a taux transaction

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/all

POST Auth Required

Description: Get all promo code for a taux transaction

Accessible by: Admin Super Admin

Try it out

/promoCode/filter

POST Auth Required

Description: Filter promo code for a taux transaction

Accessible by: Admin Super Admin

Try it out

/promoCode/hasValidPromoCode

POST Auth Required

Description: Check if a taux has a valid promoCode

Accessible by:

Try it out

receiver-infos

/receiver_infos/add

POST Auth Required

Description: Create receiver informations for a transaction

Accessible by:

Try it out

/receiver_infos/upd

POST Auth Required

Description: Update receiver informations for a transaction

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

transaction_lock_unlock

/open-transaction

POST Auth Required

Description: Ouvre une transaction pour un admin

Accessible by: Admin Super Admin

Try it out

/close-transaction

POST Auth Required

Description: Ferme une transaction ouverte par un admin

Accessible by: Admin Super Admin

Try it out

/is-locked-transaction

GET Auth Required

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

Accessible by: Admin Super Admin

Try it out

/getLockedTransactions

GET Auth Required

Description: Récuperer la liste des transactions verrouillées

Accessible by:

Try it out

transactions

/transaction/frais/add

POST Auth Required

Description: Add transaction fees

Accessible by:

Try it out

/transaction/frais/find_all

GET Auth Required

Description: Get all transaction fees

Accessible by:

Try it out

/transaction/frais/:baseOnTaux/:id

GET

Description: Get unique transaction fees

Accessible by:

Try it out

/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/:id

GET Auth Required

Description: Get transaction by id

Accessible by:

Try it out

/transaction/delete/:id

DELETE Auth Required

Description: Delete transaction by id

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/paginated/:userId/all

POST Auth Required

Description: Get all transactions with pagination for a user

Accessible by:

Try it out

/transaction/limit

POST Auth Required

Description: Get user transactions total amount

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

transfer-route

/transferRoute/create

POST Auth Required

Description: Create a transfer route

Accessible by: Admin Super Admin

Try it out

/transferRoute/delete

POST Auth Required

Description: Delete a transfer route

Accessible by: Admin Super Admin

Try it out

/transferRoute/getFromSenderCountry

POST Auth Required

Description: Get transfer route from senderCountry for admin

Accessible by:

Try it out

/transferRoute/getReceiveCountries

POST

Description: Get transfer route from senderCountry for user

Accessible by:

Try it out

/transferRoute/isActive

POST Auth Required

Description: Change a transfer route isActive value

Accessible by: Admin Super Admin

Try it out

transfer-route-payment

/transferRoutePayment/create

POST Auth Required

Description: Create a transfer route payment

Accessible by: Admin Super Admin

Try it out

/transferRoutePayment/delete

POST Auth Required

Description: Delete a transfer route payment

Accessible by: Admin Super Admin

Try it out

/transferRoutePayment/getPaymentMethods

POST Auth Required

Description: Get a transfer route payment methods

Accessible by:

Try it out

/transferRoutePayment/getPaymentMethodsByCountriesAndType

POST

Description: Get payment methods by countries and tyoe

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/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/update/newInfos

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/:id

GET Auth Required

Description: Get a single user by ID

Accessible by:

Try it out

/user/del

GET Auth Required

Description: Block a user

Accessible by:

Try it out

webDashboard

/dashboard/userStats

GET Auth Required

Description: Get dashboard user stats

Accessible by: Admin Super Admin

Try it out

/dashboard/transactionsStats

GET Auth Required

Description: Get dashboard transaction stats

Accessible by: Admin Super Admin

Try it out

/dashboard/transactionsStatsByCountry

GET Auth Required

Description: Get dashboard transaction stats by country

Accessible by: Admin Super Admin

Try it out

/dashboard/getUnpaidTransactions

GET Auth Required

Description: Get unpaid transaction

Accessible by: Admin Super Admin

Try it out

/dashboard/sendNewsWithUsersEmail

POST Auth Required

Description: Send news to users

Accessible by: Admin Super Admin

Try it out

/dashboard/sendNewsToUsersWithCountryId

POST Auth Required

Description: Send news to users

Accessible by: Admin Super Admin

Try it out

/dashboard/exportUsersFromTransactionCountryToExcel

GET Auth Required

Description: Export users to excel

Accessible by: Admin Super Admin

Try it out

/dashboard/getUsersFromMonnaieEnvoieAndReception

POST Auth Required

Description: Get user from transaction monnaies

Accessible by: Admin Super Admin

Try it out

/dashboard/getRejectReason

GET Auth Required

Description: Get reject reason

Accessible by:

Try it out

/dashboard/userCountByAgeRange

GET Auth Required

Description: Count user by age range

Accessible by:

Try it out

/dashboard/filterDashboardStats

POST Auth Required

Description: Filter dashboard users stats

Accessible by: Admin Super Admin

Try it out

/dashboard/getUsersFromMonnaieEnvoieAndReception

POST Auth Required

Description: Filter dashboard transactions

Accessible by: Admin Super Admin

Try it out