# MagicPay Documentation ## MagicPay Documentation - [MagicPay Documentation](https://hilals-organization.gitbook.io/magicpay-documentation/magicpay-documentation.md) - [Testing Environments](https://hilals-organization.gitbook.io/magicpay-documentation/testing-environments.md): In this page you will find some values that will be necessary throughout testing. - [Authentication](https://hilals-organization.gitbook.io/magicpay-documentation/authentication.md): Every request must have the following authentication headers in order to receive answer from the MagicPay API. - [1.Payments and Wallet](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet.md) - [1.1 Create Card Payment](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.1-create-card-payment.md): Initiates a card payment transaction. - [1.2 3D Secure Payment Initialization](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.2-3d-secure-payment-initialization.md): Initiates a 3d secure card payment transaction. - [1.3 3D Secure Payment Completion](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.3-3d-secure-payment-completion.md): Completes a 3d secure card payment transaction. - [1.4 Query Payment](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.4-query-payment.md): Retrieves details of a specific payment. - [1.5 Reward Inquiry](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.5-reward-inquiry.md): Retrieves loyalty information. - [1.6 Create Wallet](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.6-create-wallet.md): Creates member wallet. - [1.7 Get Member Wallet](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.7-get-member-wallet.md): Returns the member wallet with the given member id. - [1.8 Make Deposit](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.8-make-deposit.md): Makes deposit on the given wallet using 2D payment. - [1.9 Search Wallet Transactions](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.9-search-wallet-transactions.md): Returns the wallet transaction of given member . - [1.10 Send Remittance](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.10-send-remittance.md): Sends remittance to the given member's wallet. - [1.11 Receive Remittance](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.11-receive-remittance.md): Receives remittance from the given member's wallet. - [1.12 Retrieve Remittance](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.12-retrieve-remittance.md) - [1.13 Get Refundable Amount](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.13-get-refundable-amount.md): Returns the refundable amount of the given transaction. - [1.14 Make Deposit (3D Init)](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.14-make-deposit-3d-init.md): Initiates deposit request on the given wallet using 3D payment. - [1.15 Make Deposit (3D Complete)](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.15-make-deposit-3d-complete.md): Completes deposit request on the given wallet using 3D payment. - [1.16 Retrieve Merchant Wallet](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.16-retrieve-merchant-wallet.md): Returns the merchants wallet information. - [1.17 Create Refund Transaction](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.17-create-refund-transaction.md): Created refund transaction for the given transaction id. - [1.18 Get Refunds](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.18-get-refunds.md): Created refund transaction for the given transaction id. - [1.19 Reset Merchant Wallet Balance](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.19-reset-merchant-wallet-balance.md): Created refund transaction for the given transaction id. - [1.20 Refund Payment](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.20-refund-payment.md): Initiate refund payments with detailed parameters - [1.21 Get Refund By Id](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.21-get-refund-by-id.md) - [1.22 Get Refund Transaction By Id](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.22-get-refund-transaction-by-id.md) - [1.23 Refund Payment Transaction](https://hilals-organization.gitbook.io/magicpay-documentation/1.payments-and-wallet/1.23-refund-payment-transaction.md) - [2.Users](https://hilals-organization.gitbook.io/magicpay-documentation/2.users.md) - [2.1 User Authenticate](https://hilals-organization.gitbook.io/magicpay-documentation/2.users/2.1-user-authenticate.md) - [2.2 Create User](https://hilals-organization.gitbook.io/magicpay-documentation/2.users/2.2-create-user.md) - [2.3 Update User](https://hilals-organization.gitbook.io/magicpay-documentation/2.users/2.3-update-user.md) - [3. Members](https://hilals-organization.gitbook.io/magicpay-documentation/3.-members.md) - [3.1 Create Member](https://hilals-organization.gitbook.io/magicpay-documentation/3.-members/3.1-create-member.md): Creates a new member for the given merchant. - [3.2 Update Member](https://hilals-organization.gitbook.io/magicpay-documentation/3.-members/3.2-update-member.md): Updates the member for the given merchant. - [3.3 Get Member](https://hilals-organization.gitbook.io/magicpay-documentation/3.-members/3.3-get-member.md): Return the member with the given id. - [3.4 Query Member](https://hilals-organization.gitbook.io/magicpay-documentation/3.-members/3.4-query-member.md): Return the member with the given parameters. - [4. Installments](https://hilals-organization.gitbook.io/magicpay-documentation/4.-installments.md) - [4.1 Query Bins](https://hilals-organization.gitbook.io/magicpay-documentation/4.-installments/4.1-query-bins.md): Return the bins - [4.2 Installment Query](https://hilals-organization.gitbook.io/magicpay-documentation/4.-installments/4.2-installment-query.md): Return the installments - [5. Products](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products.md) - [5.1 Get Menu](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.1-get-menu.md): Returns the contents of the menu . - [5.2 Get Products](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.2-get-products.md) - [5.3 Get Campaigns](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.3-get-campaigns.md) - [5.4 Get Rules](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.4-get-rules.md) - [5.5 Get Story](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.5-get-story.md) - [5.6 Get Category](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.6-get-category.md) - [5.7 Get Category By Id](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.7-get-category-by-id.md) - [5.8 Get Rules By Id](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.8-get-rules-by-id.md) - [5.9 Get Campaigns By Id](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.9-get-campaigns-by-id.md) - [5.10 Get Stories By Id](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.10-get-stories-by-id.md) - [5.11 Get Products By Id](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.11-get-products-by-id.md) - [5.12 Create Products](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.12-create-products.md) - [5.13 Create Campaigns](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.13-create-campaigns.md) - [5.14 Create Stories](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.14-create-stories.md) - [5.15 Create Rules](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.15-create-rules.md) - [5.16 Create Category](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.16-create-category.md) - [5.17 Update Products](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.17-update-products.md) - [5.18 Update Rules](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.18-update-rules.md) - [5.19 Update Stories](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.19-update-stories.md) - [5.20 Update Campaigns](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.20-update-campaigns.md) - [5.21 Update Category](https://hilals-organization.gitbook.io/magicpay-documentation/5.-products/5.21-update-category.md) - [6. Links](https://hilals-organization.gitbook.io/magicpay-documentation/6.-links.md) - [6.1 Create Custom Links](https://hilals-organization.gitbook.io/magicpay-documentation/6.-links/6.1-create-custom-links.md) - [6.2 Update Custom Links](https://hilals-organization.gitbook.io/magicpay-documentation/6.-links/6.2-update-custom-links.md) - [6.3 Get Custom Links By Id](https://hilals-organization.gitbook.io/magicpay-documentation/6.-links/6.3-get-custom-links-by-id.md) - [6.4 Delete Custom Links](https://hilals-organization.gitbook.io/magicpay-documentation/6.-links/6.4-delete-custom-links.md) - [6.5 Get Custom Links](https://hilals-organization.gitbook.io/magicpay-documentation/6.-links/6.5-get-custom-links.md) - [7. Magic Links](https://hilals-organization.gitbook.io/magicpay-documentation/7.-magic-links.md) - [7.1 Create Magic Links](https://hilals-organization.gitbook.io/magicpay-documentation/7.-magic-links/7.1-create-magic-links.md) - [7.2 Update Magic Links](https://hilals-organization.gitbook.io/magicpay-documentation/7.-magic-links/7.2-update-magic-links.md) - [7.3 Get Magic Links](https://hilals-organization.gitbook.io/magicpay-documentation/7.-magic-links/7.3-get-magic-links.md) - [7.4 Delete Magic Links](https://hilals-organization.gitbook.io/magicpay-documentation/7.-magic-links/7.4-delete-magic-links.md) - [8. Merchants](https://hilals-organization.gitbook.io/magicpay-documentation/8.-merchants.md) - [8.1 Create Merchants](https://hilals-organization.gitbook.io/magicpay-documentation/8.-merchants/8.1-create-merchants.md) - [8.2 Update Merchants](https://hilals-organization.gitbook.io/magicpay-documentation/8.-merchants/8.2-update-merchants.md) - [9. Payment Facility](https://hilals-organization.gitbook.io/magicpay-documentation/9.-payment-facility.md) - [9.1 Create PF](https://hilals-organization.gitbook.io/magicpay-documentation/9.-payment-facility/9.1-create-pf.md) - [9.2 Get PF](https://hilals-organization.gitbook.io/magicpay-documentation/9.-payment-facility/9.2-get-pf.md) - [9.3 Update PF](https://hilals-organization.gitbook.io/magicpay-documentation/9.-payment-facility/9.3-update-pf.md) - [9.4 Delete PF](https://hilals-organization.gitbook.io/magicpay-documentation/9.-payment-facility/9.4-delete-pf.md) - [10. POS](https://hilals-organization.gitbook.io/magicpay-documentation/10.-pos.md) - [10.1 Create POS](https://hilals-organization.gitbook.io/magicpay-documentation/10.-pos/10.1-create-pos.md) - [10.2 Update POS](https://hilals-organization.gitbook.io/magicpay-documentation/10.-pos/10.2-update-pos.md) - [10.3 Get POS](https://hilals-organization.gitbook.io/magicpay-documentation/10.-pos/10.3-get-pos.md) - [10.4 Update POS By Id](https://hilals-organization.gitbook.io/magicpay-documentation/10.-pos/10.4-update-pos-by-id.md) - [10.5 Get POS Metadata](https://hilals-organization.gitbook.io/magicpay-documentation/10.-pos/10.5-get-pos-metadata.md) - [10.6 Get Commission By Id](https://hilals-organization.gitbook.io/magicpay-documentation/10.-pos/10.6-get-commission-by-id.md) - [10.7 Create Commission By Id](https://hilals-organization.gitbook.io/magicpay-documentation/10.-pos/10.7-create-commission-by-id.md) - [10.8 Change POS Status](https://hilals-organization.gitbook.io/magicpay-documentation/10.-pos/10.8-change-pos-status.md) - [10.9 Delete POS](https://hilals-organization.gitbook.io/magicpay-documentation/10.-pos/10.9-delete-pos.md) - [10.10 Get Merchant POS By Id](https://hilals-organization.gitbook.io/magicpay-documentation/10.-pos/10.10-get-merchant-pos-by-id.md) - [11. Submerchants](https://hilals-organization.gitbook.io/magicpay-documentation/11.-submerchants.md) - [11.1 Get Submerchants](https://hilals-organization.gitbook.io/magicpay-documentation/11.-submerchants/11.1-get-submerchants.md) - [11.2 Get Submerchants By Id](https://hilals-organization.gitbook.io/magicpay-documentation/11.-submerchants/11.2-get-submerchants-by-id.md) - [11.3 Submerchant Transaction Approve](https://hilals-organization.gitbook.io/magicpay-documentation/11.-submerchants/11.3-submerchant-transaction-approve.md) - [12. Reports](https://hilals-organization.gitbook.io/magicpay-documentation/12.-reports.md) - [12.1 Get Report](https://hilals-organization.gitbook.io/magicpay-documentation/12.-reports/12.1-get-report.md) - [12.2 Export By Id](https://hilals-organization.gitbook.io/magicpay-documentation/12.-reports/12.2-export-by-id.md) - [12.3 Create Reports](https://hilals-organization.gitbook.io/magicpay-documentation/12.-reports/12.3-create-reports.md) - [12.4 Get Daily POS Reports Daily Summaries](https://hilals-organization.gitbook.io/magicpay-documentation/12.-reports/12.4-get-daily-pos-reports-daily-summaries.md) - [12.5 Get Daily Apm Reports Daily Summaries](https://hilals-organization.gitbook.io/magicpay-documentation/12.-reports/12.5-get-daily-apm-reports-daily-summaries.md) - [13. Subscription](https://hilals-organization.gitbook.io/magicpay-documentation/13.-subscription.md) - [13.1 Get Subscription](https://hilals-organization.gitbook.io/magicpay-documentation/13.-subscription/13.1-get-subscription.md) - [13.2 Get Subscription By Id](https://hilals-organization.gitbook.io/magicpay-documentation/13.-subscription/13.2-get-subscription-by-id.md) - [13.3 Get Subscription Products](https://hilals-organization.gitbook.io/magicpay-documentation/13.-subscription/13.3-get-subscription-products.md) - [14. API Key](https://hilals-organization.gitbook.io/magicpay-documentation/14.-api-key.md) - [14.1 Create API Key](https://hilals-organization.gitbook.io/magicpay-documentation/14.-api-key/14.1-create-api-key.md) - [14.2 Get API Key By Id](https://hilals-organization.gitbook.io/magicpay-documentation/14.-api-key/14.2-get-api-key-by-id.md) - [14.3 Create API Key By Permission](https://hilals-organization.gitbook.io/magicpay-documentation/14.-api-key/14.3-create-api-key-by-permission.md) - [14.4 Delete Permission By API Key](https://hilals-organization.gitbook.io/magicpay-documentation/14.-api-key/14.4-delete-permission-by-api-key.md) - [14.5 Update API Key By Id](https://hilals-organization.gitbook.io/magicpay-documentation/14.-api-key/14.5-update-api-key-by-id.md) - [14.6 Delete API Key By Id](https://hilals-organization.gitbook.io/magicpay-documentation/14.-api-key/14.6-delete-api-key-by-id.md)