post http://{{url}}/v1/charges/3ds
You can make pre-auth (3ds) for a charge, then accept with the client-sdk (Canvas3ds widget) and use this charge id to create a common charge
Flow
- API request
- Client SDK
Request body
field | required[flow] | type | description |
---|---|---|---|
amount | + | float | Amount of payment |
currency | + | string (iso4217 alpha-3) | Currency code |
description | - | string | Manually defined description for payments in payment systems |
reference | - | string | Manually defined reference for customer in payment systems |
token | + | string(UUID) | One-time token with all the payment source information |
_3ds | + | object | 3ds options. |
_3ds.redirect_url | - | string (url) | custom redirect url for canvas3ds |
_3ds.browser_details | +1 | object | 3ds browser options. Client SDK automatically generates this object |
_3ds.browser_details.name | + | string | Browser info https://developer.mozilla.org/en-US/docs/Web/API/Navigator |
_3ds.browser_details.java_enabled | + | string (bool) | Browser info https://developer.mozilla.org/en-US/docs/Web/API/Navigator |
_3ds.browser_details.language | + | string (BCP 47) | Browser info https://developer.mozilla.org/en-US/docs/Web/API/Navigator |
_3ds.browser_details.time_zone | + | string (numeric) | Browser info https://developer.mozilla.org/en-US/docs/Web/API/Navigator |
_3ds.browser_details.screen_height | + | string (numeric) | Browser info https://developer.mozilla.org/en-US/docs/Web/API/Screen |
_3ds.browser_details.screen_width | + | string (numeric) | Browser info https://developer.mozilla.org/en-US/docs/Web/API/Screen |
_3ds.browser_details.color_depth | + | string (numeric) | Browser info https://developer.mozilla.org/en-US/docs/Web/API/Screen |
shipping.address_line1 | - | string | Customer Address, line 1 |
shipping.address_line2 | - | string | Customer Address, line 2 |
shipping.address_state | - | string | Customer Address, State |
shipping.address_country | - | string | Customer Address, Country Code |
shipping.address_city | - | string | Customer Address, City |
shipping.address_postcode | - | string(numeric) | Customer Address, Postcode |
shipping.address_company | - | string | Customer Shipping Address, Company |
shipping.address_origin_postcode | - | string(numeric) | Origin Shipping Address Postcode |
shipping.contact.first_name | - | string | Customer first name |
shipping.contact.last_name | - | string | Customer last name |
shipping.contact.email | - | string | Customer email |
shipping.contact.phone | - | string(E.164) | Customer phone in E.164 international notation (Example: +12345678901) |
shipping.contact.phone2 | - | string(E.164) | Customer additional phone in E.164 international notation (Example: +12345678901) |
shipping.method | - | string | Shipping method for a transaction |