3.34. /api/3ds/v1/upload-method-url-result
After completing the 3DS Method and gathering customer browser fingerprint, upload the results using HTTP POST request to URLs and the parameters specified below.
API URLs
| Integration | Production |
|---|---|
| https://sandbox.billblend.com/checkout/api/3ds/v1/upload-method-url-result/ENDPOINTID | https://pay.billblend.com/checkout/api/3ds/v1/upload-method-url-result/ENDPOINTID |
| https://sandbox.billblend.com/checkout/api/3ds/v1/upload-method-url-result/ENDPOINTGROUPID | https://pay.billblend.com/checkout/api/3ds/v1/upload-method-url-result/ENDPOINTGROUPID |
Request Parameters
| Parameter Name | Length | Description |
|---|---|---|
| orderid | max 128 | Order id assigned to the order by Billblend. |
| login | max 20 | Merchant login name. |
| client-order-id | max 128 | Merchant order identifier. |
| control | max 40 | Checksum generated by SHA-1. Control string is represented as concatenation of the following parameters:1. login2. client_orderid3. orderid4. merchant_control (Control key assigned to Merchant account in the Billblend gateway system) |
| threeDSServerTransID | max 36 | 3DS Server Transaction ID. Universally unique transaction identifier assigned by the 3DS Server to identify a single transaction. |
| browserAcceptHeader | max 2048 | Browser Accept Headers. Exact content of the HTTP accept headers as sent to the 3DS Requestor from the Cardholder’s browser. |
| browserIP | max 45 | Browser IP Address.* |
| browserJavaEnabled | min 4, max 5 | true/false Browser Java Enabled. Boolean that represents the ability of the cardholder browser to execute java. Value is returned from the navigator.javaEnabled property. |
| browserJavascriptEnabled | min 4, max 5 | true/false Browser JavaScript Enabled. Boolean that represents the ability of the cardholder browser to execute javascript. |
| browserLanguage | max 8 | Value representing the browser language as defined in IETF BCP47. Returned from navigator.language property. |
| browserColorDepth | max 2 | Browser Screen Color Depth. Value representing the bit depth of the colour palette for displaying images, in bits per pixel. Obtained from Cardholder browser using the screen.colorDepth property |
| browserScreenHeight | max 6 | Browser Screen Height. Total height of the cardholder’s screen in pixels. Value is returned from the screen.height property. |
| browserScreenWidth | max 6 | Browser Screen Width. Total width of the cardholder’s screen in pixels. Value is returned from the screen.width property. |
| browserTZ | max 5 | Browser Time Zone. Time difference between UTC time and the cardholder browser local time, in minutes. Value is returned from the getTimezoneOffset() method. |
| browserUserAgent | max 2048 | Browser User-Agent. Exact content of the HTTP user-agent header. Note: If the total length of the User-Agent sent by the browser exceeds 2048 characters, the 3DS Server truncates the excess portion. |
| threeDSCompInd | max 1 | 3DS Method Completion. Indicates whether the 3DS Method was successfully completed.Values accepted:Y = Successfully completedN = Did not successfully complete. The 3DS Method was not completed within 10 seconds.U = Unavailable — tds-method-url-frame-3ds-method-url was not present in Status response. |
| notificationURL | max 256 | Fully qualified URL of merchant system that will receive the CRes message or Error Message. The CRes message is posted by the ACS through the Cardholder browser at the end of the challenge. |
Note
* IP address of the browser as returned by the HTTP headers to the 3DS Requestor IPv4 address is represented in the dotted decimal format of 4 sets of decimal numbers separated by dots.
The decimal number in each and every set is in the range 0 to 255.
Example IPv4 address: 1.12.123.255
IPv6 address is represented as eight groups of four hexadecimal digits, each group representing 16 bits (two octets. The groups are separated by colons (:).
Example IPv6 address: 2011:0db8:85a3:0101:0101:8a2e:0370:7334
Response Parameters
| Parameter Name | Description |
|---|---|
| type | The type of response. May be async-response, validation-error, error. If type equals validation-error or error, error-message and error-code parameters contain error details. |
| paynet-order-id | Order id assigned to the order by Billblend. |
| merchant-order-id | Merchant order id. |
| serial-number | Unique number assigned by Billblend server to particular request from the Merchant. |
| error-message | If status is error this parameter contains the reason for decline or error details. |
| error-code | The error code is case of error status. |
| end-point-id | Endpoint id used for the transaction. |
Request Example
POST /checkout/api/3ds/v1/upload-method-url-result/39529 HTTP/1.1 User-Agent: curl/7.83.0 Accept: */* Content-Length: 721 Content-Type: application/x-www-form-urlencoded Connection: close notificationURL=https://merchant.com/shop/notification/1e21f041-871d-4642-a6d9-968457df47a0 &browserLanguage=en-us &orderid=6684126 &browserColorDepth=24 &browserJavaEnabled=false &control=24dc828de77bae41b9c4bf4dcbdb5c80158eb2db &login=test_merchant &browserIP=10.25.8.19 &browserUserAgent=Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0 Safari/605.1.15 &browserAcceptHeader=text/html,application/xhtml+xml,application/xml;q=0.9,*/*;q=0.8 &browserTZ=-180 &browserScreenHeight=900 &browserJavascriptEnabled=true &threeDSCompInd=Y &browserScreenWidth=1440 &client-order-id=1e21f041-871d-4642-a6d9-968457df47a0 &threeDSServerTransID=d00a7afe-2a4d-46b4-8f7f-f4efadf142b3
Success Response Example
HTTP/1.1 200 Server: server Date: Wed, 17 Nov 2021 11:03:17 GMT Content-Type: text/html;charset=utf-8 Transfer-Encoding: chunked Connection: keep-alive Keep-Alive: timeout=60 Vary: Accept-Encoding X-XSS-Protection: 1 Strict-Transport-Security: max-age=31536000 Content-Language: ru-RU P3P: CP="NOI ADM DEV COM NAV OUR STP" Content-Encoding: gzip type=async-response &serial-number=00000000-0000-0000-0000-000002d62029 &merchant-order-id=1e21f041-871d-4642-a6d9-968457df47a0 &paynet-order-id=6684126
Fail Response Example
HTTP/1.1 200 Server: server Date: Wed, 17 Nov 2021 11:03:17 GMT Content-Type: text/html;charset=utf-8 Transfer-Encoding: chunked Connection: keep-alive Keep-Alive: timeout=60 Vary: Accept-Encoding X-XSS-Protection: 1 Strict-Transport-Security: max-age=31536000 Content-Language: ru-RU P3P: CP="NOI ADM DEV COM NAV OUR STP" Content-Encoding: gzip type=validation-error &serial-number=00000000-0000-0000-0000-000002b36f64 &merchant-order-id=inv4097763 &error-message=End+point+with+id+22903+not+found &error-code=3
Postman Collection
Postman Collection is available at this link – https://doc.billblend.com/integration/API_commands/upload-method-url-result.html#postman-collection
Request Builder
Request Builder is available at this link – https://doc.billblend.com/integration/API_commands/upload-method-url-result.html#request-builder
| URL | |
|---|---|
| login | input Login |
| client_orderid | input Invoice Number |
| orderid | input sandbox.billblend.com Transaction Number |
| merchant_control | input Control Key |
| threeDSServerTransID | input 3DS Server Transaction ID |
| browserAcceptHeader | input Browser Accept Headers |
| browserIP | input Browser IP Address |
| browserJavaEnabled | input true/false |
| browserJavascriptEnabled | input true/false |
| browserLanguage | input browser language |
| browserColorDepth | input Browser Screen Color Depth |
| browserScreenHeight | input Browser Screen Height |
| browserScreenWidth | input Browser Screen Width |
| browserTZ | input Browser Time Zone |
| browserUserAgent | input Browser User-Agent |
| threeDSCompInd | input Y, N or U |
| notificationURL | input URL of merchant system |
curl --data "URL=https://sandbox.billblend.com/checkout/api/3ds/v1/upload-method-url-result/ENDPOINTID&login=logic&client_orderid=902B4FF5&orderid=159884&threeDSServerTransID=8abd5b41-3a24-4be3-86c7-049542e53e10&browserAcceptHeader=text&browserIP=65.153.12.232&browserJavaEnabled=true&browserJavascriptEnabled=true&browserLanguage=en&browserColorDepth=48&browserScreenHeight=768&browserScreenWidth=768&browserTZ=0&browserUserAgent=Mozilla%2F5.0%20(Macintosh%3B%20Intel%20Mac%20OS%20X%2010_15_6)%20AppleWebKit%2F537.36%20(KHTML%2C%20like%20Gecko)%20Chrome%2F89.0.4389.90%20Safari%2F537.36&threeDSCompInd=Y¬ificationURL=https://doc.billblend.com//doc/dummy.htm&control=6ef9cae82e765a7f43d4b596f8186cf20962e349" https://sandbox.billblend.com/checkout/api/3ds/v1/upload-method-url-result/ENDPOINTID
