This endpoint is designed to receive OTP (One-Time Password) for card validation purposes. Upon submission, if the OTP is deemed valid, the customer's payment institution is authorized to debit the customer's bank account. If the debit transaction is successful, you will be redirected accordingly.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"After receiving the gatewayReference as part of the response from the {{baseUrl}}/payment/cards/initialize endpoint, you have the option to initiate the OTP resend endpoint. This allows for the reissuance of the OTP (One-Time Password) associated with the transaction.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This request retrieves the details of a card transaction using the specified transaction reference.
\nDescription:
\nOur GET Card Details endpoint is used to retrieve the details of a card transaction based on the provided transaction reference. It requires authentication using a Bearer Token.This endpoint allows you to access comprehensive information about a card transaction, aiding in transaction monitoring, reconciliation, and auditing.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Our verify card transaction endpoint verifies a card transaction and confirms its validity.
\nDescription:
\n- \n
This POST request is used to verify the validity of a card transaction.
\n \nIt allows the system to confirm whether the card transaction is authentic and can proceed further.
\n \n
This endpoint is crucial for ensuring the security and integrity of card-based transactions within the system.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint allows you to initiate recurring payments for your customers directly from your system.
\n\n
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"
CARD TRANSACTION FLOW
\nThe card transaction procedures are determined by the type of card being used. When a transaction is initiated, our payment system identifies the card type and generates response codes, such as CO, C1, and C2. These codes indicate whether the payment process will involve a single or multiple layers before completion.
\nFor further clarification, please check the diagram provided below.
\nOur Initialize Bank Transfer endpoint is used to initialize a bank transfer request. It requires the transaction reference as a parameter in the URL path.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"When initiating a bank transfer, a virtual account will be generated for the customer. Subsequently, the customer is required to make payment to this account. Upon successful transfer, the customer must return to your custom checkout platform and click on an acknowledgment button labeled, for instance, \"I have made payment.\" This button should be configured to direct users to the Verify Transaction endpoint. Following this action, a response containing the status code and redirect URL will be dispatched. You can then utilize this response according to your requirements.
\nDescription:
\nThis request initiates a USSD (Unstructured Supplementary Service Data) code for the specified parameters.
\nUsage:
Use this request to trigger the initiation of a USSD code for a particular operation.
Ensure proper authentication by including a valid Bearer Token in the request headers.
The endpoint lets you fetch all the supported banks for USSD transfer
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"It is a technology used by GSM cellular telephones to communicate with the mobile network operator's computers.
\nWhen initiating a USSD transaction, a response containing the USSD code will be generated provided that no errors occurred during initialization. This code can then be dialed on the customer's phone. Upon successful payment by the customer via USSD, they would need to return to your custom checkout platform and click on a payment acknowledgment button, labeled with a caption such as \"I have made payment.\" This button should be configured to direct users to the Verify Transaction endpoint, ensuring seamless verification of the transaction.
\nDescription:
Our \"Fetch Transaction Details\" endpoint allows you to retrieve detailed information about a specific transaction. This request is essential for accessing comprehensive details regarding a particular transaction processed within the system.
Usage:
\nUtilize this request to obtain detailed information about a specific transaction identified by its unique transaction ID.
Replace {transactionId} in the endpoint URL with the actual ID of the transaction you wish to retrieve details for.
Ensure that the provided transaction ID corresponds to an existing transaction within the system.
Response:
The response returned by this request contains comprehensive details pertaining to the specified transaction. Information provided may include transaction amount, timestamp, involved parties, transaction status, and any additional metadata associated with the transaction.
We highly recommend that when you receive a notification from us, you should initiate a verify transaction request to us with the transactionReference to confirm the actual status of that transaction before updating the records on your database.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Our Fetch Transaction Status endpoint retrieves the status of a transaction using the specified transaction reference.
\nDescription:
\nThe GET Fetch Transaction Status endpoint is used to retrieve the status of a transaction based on the provided transaction reference. It requires authentication using a Bearer Token. This endpoint allows you to check the current status of a transaction, providing valuable insights into its progress and outcome.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint allows you to cancel a transaction that has not yet been marked as completed.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"This endpoint allows you to initialize a transaction on ErcasPay and it returns a checkout URL which you can load within a browser to display the payment form to your customer. The checkout URL has an expiry time of 90 minutes.
\n","urlObject":{"path":["third-party","payment","initiate"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"f29558d5-9b38-4b89-a45a-4c1b8314ac59","name":"Initiate","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer 72|0uAcSNKl4vVZinuOdtzbwsfLzt6R5ULZLMaFAAle","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"amount\": 3,\n \"paymentReference\": \"R5md7gd9b4s3h2j5d67g\",\n \"paymentMethods\": \"card,bank-transfer,ussd,qrcode\",\n \"customerName\": \"Olayemi Olaomo\",\n \"currency\": \"USD\",\n \"customerEmail\": \"ola@gmail.com\",\n \"customerPhoneNumber\": \"09061628409\",\n \"redirectUrl\": \"https://omolabakeventures.com\",\n \"description\": \"The description for this payment goes here\",\n \"metadata\": {\n \"firstname\": \"Ola\",\n \"lastname\": \"Benson\",\n \"email\": \"iie@mail.com\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/payment/initiate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx/1.25.1"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"X-Powered-By","value":"PHP/8.2.8"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Fri, 06 Oct 2023 16:57:16 GMT"},{"key":"X-RateLimit-Limit","value":"60"},{"key":"X-RateLimit-Remaining","value":"59"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"requestSuccessful\": true,\n \"responseMessage\": \"success\",\n \"responseCode\": \"00\",\n \"responseBody\": {\n \"paymentReference\": \"R5md7gd9b4s3h2j5d67g\",\n \"transactionReference\": \"ERCS|20231006175716|1696611436606\",\n \"checkoutUrl\": \"https://sandbox-checkout.ercaspay.com/ERCS|20231006175716|1696611436606\",\n \"whiteLabel\": {\n \"id\": 1,\n \"logo_url\": \"https://upload.wikimedia.org/wikipedia/commons/3/33/Vanamo_Logo.png\",\n \"primary_color\": \"#FF12E2\",\n \"accent_color\": \"#EF43AB\",\n \"font_family\": \"Sans-Pro\",\n \"font_color\": \"#FFFF01\",\n \"has_admin_approved\": true\n }\n }\n}"}],"_postman_id":"fcb929ed-525d-46a8-92e8-8533bc38fda0"}],"id":"331dd5a6-cd76-4f50-9da6-96f315c22e89","description":"You have the option to seamlessly integrate our Payment gateway directly into your platform. This method is particularly advantageous if you plan to establish a self-hosted Payment gateway instead of interfacing with our checkout system to facilitate payment processing.
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"Our webhook notifies merchants about transaction events in real-time. When a payment is processed, this webhook sends a payload containing details of the transaction, including the amount, transaction reference, payment reference, type, and status.
\nWebhook Setup
\nMerchants are required to provide their webhook URL where notifications will be sent.
\nTo add your webhook URL:
\n- \n
Login to your ErcasPay dashboard.
\n \nNavigate to Settings.
\n \nClick on API Keys & Webhook.
\n \nFill in the webhook URL field accordingly.
\n \n
Sample Webhook Response
\njsonCopyEdit{\n \"amount\": 100,\n \"transaction_reference\": \"ERCS|2025XXXX140332|174066141XXXX\",\n \"payment_reference\": \"R5md7gd9b4s3h2xxd67g\",\n \"type\": \"CREDIT\",\n \"service_type\": \"gateway\",\n \"settlement_amount\": 100,\n \"fee_bearer\": \"customer\",\n \"fee\": 1.4,\n \"channel\": \"BANK_TRANSFER\",\n \"status\": \"SUCCESSFUL\",\n \"currency\": \"NGN\",\n \"merchant_name\": \"MS Solutions\",\n \"customer_account_name\": null,\n \"metadata\": {\n \"firstname\": \"Ola\",\n \"lastname\": \"Michael\",\n \"email\": \"olamicxxx@gmail.com\"\n }\n}\n\n