Octopus
Beta
Last updated: December 11, 2024
Octopus enables customers to pay using their contactless cards and digital wallets.
Information
To enable Octopus payments on your account, contact your Account Manager or [email protected].
Model | Gateway |
|---|---|
Payment flow | Redirect |
Payment method type | Digital wallet |
Auto-capture payment | |
Authorization | |
Capture | |
Refund | |
Partial refund | |
Chargeback | |
Recurring payment |
Octopus payment flow follows a two-step process:
post
https://api.checkout.com/payments
For the full API specification, see the API reference.
If you receive a 202 Accepted response code, your request was successful.
The redirection step varies depending on where you are requesting the payment:
- a desktop browser
- an application on a mobile phone
To request a payment from a desktop browser:
- Ensure that the Octopus App is installed on your customer's phone.
- Redirect your customer to the
_links.self.hrefURL provided in the response.
The URL will display a QR code. - Your customer must scan the code using their Octopus App and authorize the payment on their device.
- After authorizing the payment, they'll be redirected to either your success or failure URL.
To request a payment from an application:
- Ensure that the Octopus App is installed on your customer's phone.
If the application is not installed, instruct your customers to install it. - Obtain the necessary token from the
processingobject in the response:- for Android: Pass the
processing.octopus_urivalue to the Octopus App - for iOS: Use the
processing.tokenvalue to construct a URL using a custom URL scheme to invoke the Octopus App
- for Android: Pass the
- The Octopus App is launched on your customer's phone, so they can authorize the payment there.
After you've requested the payment, you can use the id found in the payment response to retrieve details about the payment.
For more details, see Get payment details and our API reference.
Octopus supports both partial and full refunds.
You can process refunds using the Dashboard or the Refund API.
In your test environment:
- Download the test version of the Octopus App for Android and iOS.
- Contact Octopus to top-up your test wallet.
- Perform a payment flow using the test Octopus App.
The following table lists the response codes you may receive when processing Octopus payments:
| Response code | Description |
|---|---|
| Refer to card issuer |
| Over daily limit |
| Customer cancellation |
| Declined Payment - Transaction has expired |
| Internal error |
| Webhook | Description |
|---|---|
| Occurs when an asynchronous payment request has successfully initiated. View a payment pending webhook example. |
| Occurs when the customer has approved the payment on the Octopus App. |
| Occurs when a capture is successful. View a payment captured webhook example. |
| Occurs when a capture is declined. |
| Occurs when a payment authorization request times out, or if there is a rejection during authorization. For example, due to insufficient funds, the issuer blocking the card, or a Do Not Honor instruction. View a payment declined webhook example. |
| Occurs when an APM payment has expired (not applicable to 3DS payment expiries). View a payment expired webhook example. |