​
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, we will require the following credentials.
  • 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 our instructions on Webhooks below.

​
Webhooks

To fully function, our Arcus SPEI connector will require webhooks to be set up from Arcus to our servers. We require this in order to know if a payment was received. Next, set up a webhook endpoint, first set up the connector in our dashboard, setting a secret value defined by you as the Subscription Secret. Note and copy the webhook subscription URL in our 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 will return 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 will not be 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 our hosted screen, a webhook will be sent from SPEI to our system, after which we will update the status of the transaction and notify your system 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. We will mark the capture_amount accordingly.
  • A buyer may send multiple payments for the same CLABE number. Our system will not handle this situation but will monitor and notify our support team.