Skip to main content

​
Sign-up

Arcus does not provide self-service sign-up for a sandbox account. Please reach out to Arcus to set up an account.

​
Credentials

When setting up SPEI via Arcus, the following credentials are required.
  • Your Customer ID representing your merchant account
  • Your User Name and Password used to connect to the API
  • Your Subscription Secret to verify the webhooks received from Arcus
You can request all these details via your Arcus dashboard once you are set up with an account. The Subscription Secret is a value defined by you when you set up the account. See the instructions on Webhooks below.

​
Webhooks

To fully function, the Arcus SPEI connector requires webhooks to be set up from Arcus to the servers. This is required to know if a payment was received. Next, set up a webhook endpoint, first set up the connector in the dashboard, setting a secret value defined by you as the Subscription Secret. Note and copy the webhook subscription URL in the dashboard once the connection is set up. Then, use the Arcus POST /notification-subscriptions API endpoint with the webhook URL you copied, and the subscription_secret you set earlier. 
{
  "url": "https://api.example.spider.gr4vy.app/i/Xz9q_HKzTSe4CN_0lRA9jmFyY3Vc3BlaQ/R6DEA6oG3vtPI=OSU1PsRS9lmn4z-jey-SrY",
  "description":"Notifications - Sandbox",
  "subscription_secret": "my-super-secret-value",
  "subscribed_events": [
    "accounts.transactions.type.credit"
  ]
}

​
Push payments

SPEI is a push payment method. This means that any SPEI transaction created returns a transaction resource with a status of processing and an payment_method.approval_url. This approval URL can be displayed in a popup, iframe, or redirected to, but buyers are not redirected back to the redirect_url you provided when the transaction was created. Once the buyer has made the payment to the CLABE number provided on the hosted screen, a webhook is sent from SPEI to the system, after which the status of the transaction is updated and your system is notified via a webhook.

​
Limitations

Please note, push payments have a few limitations.
  • A buyer may never send a payment for various reasons, including when they copy over the CLABE number incorrectly.
  • A buyer may send the wrong amount, resulting in either an over or under payment. The capture_amount is marked accordingly.
  • A buyer may send multiple payments for the same CLABE number. The system does not handle this situation, but it is monitored and the support team is notified.