Examples
Sample retrieve transaction response for a submitted Open Banking
Interaction
Here's an example of a Retrieve Transaction response showing a
submitted Open Banking interaction (response.gatewayCode =
SUBMITTED)
{
"amount":82113.13,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-08-17T09:35:27.250Z",
"currency":"EUR",
"customer":{
"email":"John@example.com"
},
"device":{
"browser":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36"
},
"id":"992608474",
"lastUpdatedTime":"2020-08-17T09:36:04.146Z",
"lineOfBusiness":"AIR_TICKETS",
"merchant":"TESTMERCHANT1",
"merchantAmount":82113.13,
"merchantCurrency":"EUR",
"reference":"TEST-SUCCEED",
"result":"SUCCESS",
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"John@example.com",
"firstName":"John",
"lastName":"Doe"
}
},
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"12345XXX-XXXX-4156-XXXX-f6eeef0478cf"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"status":"INITIATED",
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0,
"transaction":
{
"browserPayment":{
"interaction":{
"status":"RETURNED_TO_MERCHANT",
"timeInitiated":"2020-08-17T09:35:27.272Z",
"timeRedirected":"2020-08-17T09:35:59.967Z",
"timeReturned":"2020-08-17T09:36:04.061Z"
},
"operation":"PAY",
"redirectUrl":"<hostname>/bpui/ob/out/BP-06f552c44de094aca21ee0abdf82303b",
"returnUrl":"<hostname>/apmDemoApp/complete.html"
},
"customer":{
"email":"John@example.com"
},
"device":{
"browser":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/83.0.4103.116 Safari/537.36"
},
"gatewayEntryPoint":"WEB_SERVICES_API",
"lineOfBusiness":"AIR_TICKETS",
"merchant":" TESTMERCHANT1",
"order":{
"amount":82113.13,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-08-17T09:35:27.250Z",
"currency":"EUR",
"id":"992608474",
"lastUpdatedTime":"2020-08-17T09:36:04.146Z",
"merchantAmount":82113.13,
"merchantCurrency":"EUR",
"reference":"TEST-SUCCEED",
"status":"INITIATED",
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"SUBMITTED"
},
"result":"SUCCESS",
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"John@gmail.com",
"firstName":"John",
"lastName":"Doe"
}
},
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"12345XXX-XXXX-4156-XXXX-f6eeef0478cf"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"timeOfLastUpdate":"2020-08-17T09:36:04.146Z",
"timeOfRecord":"2020-08-17T09:35:27.270Z",
"transaction":{
"acquirer":{
"id":"OPEN_BANKING_SEPA",
"merchantId":"Open Banking SEPA "
},
"amount":82113.13,
"currency":"EUR",
"id":"106172951",
"receipt":"162c0482b774b3e1",
"source":"INTERNET",
"stan":"0",
"type":"PAYMENT"
},
"version":"<latest_gateway_version>"
}
}
Sample retrieve transaction response for an approved Open Banking
Interaction
Here's an example of a Retrieve Transaction response showing an
approved Open Banking interaction (response.gatewayCode = APPROVED)
{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-24T01:01:09.584Z",
"currency":"EUR",
"device":{
"browser":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36"
},
"id":"86f293d3-1eb5-4003-9f30-7d9fbe7f1384",
"item":[
{
"brand":"MC",
"category":"NA",
"detail":{
"unitDiscountRate":0,
"unitTaxRate":0
},
"name":"item0",
"quantity":1,
"sku":"sku",
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item1",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-24T01:01:46.769Z",
"merchant":"TESTMERCHANT1",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"sample",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"company":"ABC",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"John@gmail.com",
"firstName":"John",
"lastName":"Doe",
"mobilePhone":"9999999999",
"phone":"9999999999"
},
"method":"SAME_DAY"
},
"shippingAndHandlingAmount":4.99,
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff "
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"status":"CAPTURED",
"taxAmount":10.47,
"totalAuthorizedAmount":123.46,
"totalCapturedAmount":123.46,
"totalRefundedAmount":0,
"transaction":
{
"browserPayment":{
"interaction":{
"status":"COMPLETED",
"timeCompleted":"2020-06-24T01:01:10.007Z",
"timeInitiated":"2020-06-24T01:01:09.599Z",
"timeRedirected":"2020-06-24T01:01:09.705Z",
"timeReturned":"2020-06-24T01:01:09.991Z"
},
"operation":"PAY",
"redirectUrl":"<hostname>/bpui/ob/out/BP-9099d773edb0e2d3d1e86c4bd9d9b867",
"returnUrl":"<hostname>/api/documentation/integrationGuidelines/index.html"
},
"device":{
"browser":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36"
},
"gatewayEntryPoint":"WEB_SERVICES_API",
"merchant":"TESTMERCHANT1",
"order":{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-24T01:01:09.584Z",
"currency":"EUR",
"id":"86f293d3-1eb5-4003-9f30-7d9fbe7f1384",
"item":[
{
"brand":"MC",
"category":"NA",
"detail":{
"unitDiscountRate":0,
"unitTaxRate":0
},
"name":"item0",
"quantity":1,
"sku":"sku",
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item1",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-24T01:01:46.769Z",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"sample",
"shippingAndHandlingAmount":4.99,
"status":"CAPTURED",
"taxAmount":10.47,
"totalAuthorizedAmount":123.46,
"totalCapturedAmount":123.46,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"APPROVED"
},
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"company":"ABC",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"John@gmail.com",
"firstName":"John",
"lastName":"Doe",
"mobilePhone":"9999999999",
"phone":"9999999999"
},
"method":"SAME_DAY"
},
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff "
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"timeOfLastUpdate":"2020-06-24T01:01:46.769Z",
"timeOfRecord":"2020-06-24T01:01:09.596Z",
"transaction":{
"acquirer":{
"id":"OPEN_BANKING_SEPA",
"merchantId":"Open Banking SEPA"
},
"amount":123.46,
"currency":"EUR",
"id":"1",
"reference":"sample",
"source":"INTERNET",
"stan":"0",
"type":"PAYMENT"
},
"version":"<latest_gateway_version>"
}
}
Sample retrieve transaction response for a pending Open Banking
Interaction
Here's an example of a Retrieve Transaction response showing a
pending Open Banking interaction (response.gatewayCode = PENDING)
{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-26T07:09:16.846Z",
"currency":"EUR",
"customer":{
"email":"johmith@example.com"
},
"device":{
"browser":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36"
},
"id":"888190454",
"item":[
{
"detail":{
"unitTaxRate":0
},
"name":"Spud",
"quantity":1,
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item2",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-26T07:10:57.230Z",
"merchant":"TESTMERCHANT1",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"TEST-SUCCEED",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"johnsmith@example.com",
"firstName":"Shipfirst",
"lastName":"McShiplast"
}
},
"shippingAndHandlingAmount":4.99,
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"status":"CAPTURED",
"taxAmount":10.47,
"totalAuthorizedAmount":123.46,
"totalCapturedAmount":123.46,
"totalRefundedAmount":0,
"transaction":[
{
"browserPayment":{
"interaction":{
"status":"RETURNED_TO_MERCHANT",
"timeInitiated":"2020-06-26T07:09:16.864Z",
"timeRedirected":"2020-06-26T07:10:53.329Z",
"timeReturned":"2020-06-26T07:11:03.827Z"
},
"operation":"PAY",
"redirectUrl":"<hostname>/bpui/ob/out/BP-65318d39a0c3b8000f07b7939561b819",
"returnUrl":"<hostname>/apmDemoApp/complete.html"
},
"customer":{
"email":"johmith@example.com"
},
"device":{
"browser":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36"
},
"gatewayEntryPoint":"WEB_SERVICES_API",
"merchant":"TESTMERCHANT1",
"order":{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-26T07:09:16.846Z",
"currency":"EUR",
"id":"888190454",
"item":[
{
"detail":{
"unitTaxRate":0
},
"name":"Spud",
"quantity":1,
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item2",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-26T07:10:57.230Z",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"TEST-SUCCEED",
"shippingAndHandlingAmount":4.99,
"status":"CAPTURED",
"taxAmount":10.47,
"totalAuthorizedAmount":123.46,
"totalCapturedAmount":123.46,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"PENDING"
},
"result":"PENDING",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"johnsmith@example.com",
"firstName":"Shipfirst",
"lastName":"McShiplast"
}
},
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"timeOfLastUpdate":"2020-06-26T07:10:57.230Z",
"timeOfRecord":"2020-06-26T07:09:16.861Z",
"transaction":{
"acquirer":{
"id":"OPEN_BANKING_SEPA",
"merchantId":"Open Banking SEPA"
},
"amount":123.46,
"currency":"EUR",
"id":"148341288",
"source":"INTERNET",
"stan":"0",
"type":"PAYMENT"
},
"version":"<latest_gateway_version>"
}
}
Sample retrieve transaction response for an unsupported Open Banking
interaction
Here's an example of a Retrieve Transaction response showing a Open
Banking interaction where response.gatewayCode = NOT_SUPPORTED
{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-11T07:04:16.222Z",
"currency":"EUR",
"device":{
"browser":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36"
},
"id":"575d3ae0-2b28-4a68-892e-688ae7e3d344",
"item":[
{
"brand":"MC",
"category":"NA",
"detail":{
"unitDiscountRate":0,
"unitTaxRate":0
},
"name":"item0",
"quantity":1,
"sku":"sku",
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item1",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-11T07:04:03.364Z",
"merchant":"TESTMERCHANT1",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"sample",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"John@gmail.com",
"firstName":"John",
"lastName":"Doe",
"mobilePhone":"9999999999",
"phone":"9999999999"
},
"method":"SAME_DAY"
},
"shippingAndHandlingAmount":4.99,
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"status":"FAILED",
"taxAmount":10.47,
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0,
"transaction":
{
"browserPayment":{
"interaction":{
"status":"COMPLETED",
"timeCompleted":"2020-06-11T07:04:16.708Z",
"timeInitiated":"2020-06-11T07:04:16.234Z",
"timeRedirected":"2020-06-11T07:04:15.257Z",
"timeReturned":"2020-06-11T07:04:16.679Z"
},
"operation":"PAY",
"redirectUrl":"<hostname>/bpui/ob/out/BP-bcd3a9b079f6a66581c3429dcbec386b",
"returnUrl":"<hostname>/api/documentation/integrationGuidelines/index.html"
},
"device":{
"browser":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36"
},
"gatewayEntryPoint":"WEB_SERVICES_API",
"merchant":"TESTMERCHANT1",
"order":{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-11T07:04:16.222Z",
"currency":"EUR",
"id":"575d3ae0-2b28-4a68-892e-688ae7e3d344",
"item":[
{
"brand":"MC",
"category":"NA",
"detail":{
"unitDiscountRate":0,
"unitTaxRate":0
},
"name":"item0",
"quantity":1,
"sku":"sku",
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item1",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-11T07:04:03.364Z",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"sample",
"shippingAndHandlingAmount":4.99,
"status":"FAILED",
"taxAmount":10.47,
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"NOT_SUPPORTED"
},
"result":"FAILURE",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"John@gmail.com",
"firstName":"John",
"lastName":"Doe",
"mobilePhone":"9999999999",
"phone":"9999999999"
},
"method":"SAME_DAY"
},
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"timeOfLastUpdate":"2020-06-11T07:04:03.364Z",
"timeOfRecord":"2020-06-11T07:04:16.232Z",
"transaction":{
"acquirer":{
"id":"OPEN_BANKING_SEPA",
"merchantId":"Open Banking SEPA"
},
"amount":123.46,
"currency":"EUR",
"id":"1",
"reference":"sample",
"source":"INTERNET",
"stan":"0",
"type":"PAYMENT"
},
"version":"<latest_gateway_version>"
}
}
Sample retrieve transaction response for a timed out Open Banking
interaction
Here's an example of a Retrieve Transaction response showing a timed
out Open Banking interaction (response.gatewayCode = TIMED_OUT)
{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-26T07:17:48.608Z",
"currency":"EUR",
"customer":{
"email":"johmith@example.com"
},
"device":{
"browser":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36"
},
"id":"246119218",
"item":[
{
"detail":{
"unitTaxRate":0
},
"name":"Spud",
"quantity":1,
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item2",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-26T07:18:27.894Z",
"merchant":"TESTMERCHANT1",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"TEST-SUCCEED",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"johnsmith@example.com",
"firstName":"Shipfirst",
"lastName":"McShiplast"
}
},
"shippingAndHandlingAmount":4.99,
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"status":"FAILED",
"taxAmount":10.47,
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0,
"transaction":
{
"browserPayment":{
"interaction":{
"status":"COMPLETED",
"timeCompleted":"2020-06-26T07:18:39.485Z",
"timeInitiated":"2020-06-26T07:17:49.654Z",
"timeRedirected":"2020-06-26T07:18:18.595Z",
"timeReturned":"2020-06-26T07:18:39.439Z"
},
"operation":"PAY",
"redirectUrl":"<hostname>/bpui/ob/out/BP-bd0d14660fc5bd0a98578a73e83713cd",
"returnUrl":"<hostname>/apmDemoApp/complete.html"
},
"customer":{
"email":"johmith@example.com"
},
"device":{
"browser":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/79.0.3945.130 Safari/537.36"
},
"gatewayEntryPoint":"WEB_SERVICES_API",
"merchant":"TESTMERCHANT1",
"order":{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-26T07:17:48.608Z",
"currency":"EUR",
"id":"246119218",
"item":[
{
"detail":{
"unitTaxRate":0
},
"name":"Spud",
"quantity":1,
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item2",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-26T07:18:27.894Z",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"TEST-SUCCEED",
"shippingAndHandlingAmount":4.99,
"status":"FAILED",
"taxAmount":10.47,
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"TIMED_OUT"
},
"result":"FAILURE",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"johnsmith@example.com",
"firstName":"Shipfirst",
"lastName":"McShiplast"
}
},
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"timeOfLastUpdate":"2020-06-26T07:18:27.894Z",
"timeOfRecord":"2020-06-26T07:17:49.641Z",
"transaction":{
"acquirer":{
"id":"OPEN_BANKING_SEPA",
"merchantId":"Open Banking SEPA"
},
"amount":123.46,
"currency":"EUR",
"id":"354434408",
"source":"INTERNET",
"stan":"0",
"type":"PAYMENT"
},
"version":"<latest_gateway_version>"
}
}
Sample retrieve transaction response for an Open Banking interaction
where funds are insufficient
Here's an example of a Retrieve Transaction response showing an Open
Banking interaction where response.gatewayCode = INSUFFICIENT_FUNDS
{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-11T07:04:25.661Z",
"currency":"EUR",
"device":{
"browser":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36"
},
"id":"38de9737-f394-484e-86ce-a6df45416a61",
"item":[
{
"brand":"MC",
"category":"NA",
"detail":{
"unitDiscountRate":0,
"unitTaxRate":0
},
"name":"item0",
"quantity":1,
"sku":"sku",
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item1",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-11T07:04:13.889Z",
"merchant":"TESTMERCHANT1",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"sample",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"John@gmail.com",
"firstName":"John",
"lastName":"Doe",
"mobilePhone":"9999999999",
"phone":"9999999999"
},
"method":"SAME_DAY"
},
"shippingAndHandlingAmount":4.99,
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"status":"FAILED",
"taxAmount":10.47,
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0,
"transaction":
{
"browserPayment":{
"interaction":{
"status":"COMPLETED",
"timeCompleted":"2020-06-11T07:04:26.110Z",
"timeInitiated":"2020-06-11T07:04:25.673Z",
"timeRedirected":"2020-06-11T07:04:25.798Z",
"timeReturned":"2020-06-11T07:04:26.079Z"
},
"operation":"PAY",
"redirectUrl":"<hostname>/bpui/ob/out/BP-dc04c5638e296c6fc3b2905a0607bbf9",
"returnUrl":"<hostname>/api/documentation/integrationGuidelines/index.html"
},
"device":{
"browser":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36"
},
"gatewayEntryPoint":"WEB_SERVICES_API",
"merchant":"TESTMERCHANT1",
"order":{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-11T07:04:25.661Z",
"currency":"EUR",
"id":"38de9737-f394-484e-86ce-a6df45416a61",
"item":[
{
"brand":"MC",
"category":"NA",
"detail":{
"unitDiscountRate":0,
"unitTaxRate":0
},
"name":"item0",
"quantity":1,
"sku":"sku",
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item1",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-11T07:04:13.889Z",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"sample",
"shippingAndHandlingAmount":4.99,
"status":"FAILED",
"taxAmount":10.47,
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"INSUFFICIENT_FUNDS"
},
"result":"FAILURE",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"John@gmail.com",
"firstName":"John",
"lastName":"Doe",
"mobilePhone":"9999999999",
"phone":"9999999999"
},
"method":"SAME_DAY"
},
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"timeOfLastUpdate":"2020-06-11T07:04:13.889Z",
"timeOfRecord":"2020-06-11T07:04:25.670Z",
"transaction":{
"acquirer":{
"id":"OPEN_BANKING_SEPA",
"merchantId":"Open Banking SEPA"
},
"amount":123.46,
"currency":"EUR",
"id":"1",
"reference":"sample",
"source":"INTERNET",
"stan":"0",
"type":"PAYMENT"
},
"version":"<latest_gateway_version>"
}
}
Sample retrieve transaction response for a declined Open Banking
interaction
Here's an example of a Retrieve Transaction response showing a
declined Open Banking interaction where response.gatewayCode =
DECLINED
{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-11T07:06:37.862Z",
"currency":"EUR",
"device":{
"browser":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36"
},
"id":"800b8d34-770d-4135-a1a4-0afe64c96352",
"item":[
{
"brand":"MC",
"category":"NA",
"detail":{
"unitDiscountRate":0,
"unitTaxRate":0
},
"name":"item0",
"quantity":1,
"sku":"sku",
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item1",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-11T07:06:24.923Z",
"merchant":"TESTMERCHANT1",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"sample",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"John@gmail.com",
"firstName":"John",
"lastName":"Doe",
"mobilePhone":"9999999999",
"phone":"9999999999"
},
"method":"SAME_DAY"
},
"shippingAndHandlingAmount":4.99,
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"status":"FAILED",
"taxAmount":10.47,
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0,
"transaction":
{
"browserPayment":{
"interaction":{
"status":"COMPLETED",
"timeCompleted":"2020-06-11T07:06:38.269Z",
"timeInitiated":"2020-06-11T07:06:37.871Z",
"timeRedirected":"2020-06-11T07:06:37.983Z",
"timeReturned":"2020-06-11T07:06:38.241Z"
},
"operation":"PAY",
"redirectUrl":"<hostname>/bpui/ob/out/BP-6c56d32fad0f0f11df57409b9728cb5c",
"returnUrl":"<hostname>/api/documentation/integrationGuidelines/index.html"
},
"device":{
"browser":"Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/68.0.3440.106 Safari/537.36"
},
"gatewayEntryPoint":"WEB_SERVICES_API",
"merchant":"TESTMERCHANT1",
"order":{
"amount":123.46,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-06-11T07:06:37.862Z",
"currency":"EUR",
"id":"800b8d34-770d-4135-a1a4-0afe64c96352",
"item":[
{
"brand":"MC",
"category":"NA",
"detail":{
"unitDiscountRate":0,
"unitTaxRate":0
},
"name":"item0",
"quantity":1,
"sku":"sku",
"unitDiscountAmount":3,
"unitPrice":21,
"unitTaxAmount":0.47
},
{
"detail":{
"unitTaxRate":0
},
"name":"item1",
"quantity":2,
"unitDiscountAmount":2,
"unitPrice":47,
"unitTaxAmount":5
}
],
"itemAmount":115,
"lastUpdatedTime":"2020-06-11T07:06:24.923Z",
"merchantAmount":123.46,
"merchantCurrency":"EUR",
"reference":"sample",
"shippingAndHandlingAmount":4.99,
"status":"FAILED",
"taxAmount":10.47,
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"DECLINED"
},
"result":"FAILURE",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"John@gmail.com",
"firstName":"John",
"lastName":"Doe",
"mobilePhone":"9999999999",
"phone":"9999999999"
},
"method":"SAME_DAY"
},
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"timeOfLastUpdate":"2020-06-11T07:06:24.923Z",
"timeOfRecord":"2020-06-11T07:06:37.869Z",
"transaction":{
"acquirer":{
"id":"OPEN_BANKING_SEPA",
"merchantId":"Open Banking SEPA"
},
"amount":123.46,
"currency":"EUR",
"id":"1",
"reference":"sample",
"source":"INTERNET",
"stan":"0",
"type":"PAYMENT"
},
"version":"<latest_gateway_version>"
}
}
Sample retrieve transaction Response for an Open Banking Interaction
Where Authentication Failed
Here's an example of a Retrieve Transaction response showing an Open
Banking interaction where response.gatewayCode =
AUTHENTICATION_FAILED
{
"browserPayment":{
"interaction":{
"status":"COMPLETED",
"timeInitiated":"2020-11-20T05:07:28.134Z",
"timeRedirected":"2020-11-20T05:07:34.498Z",
"timeReturned":"2020-11-20T05:07:43.449Z"
},
"operation":"PAY",
"redirectUrl":"<hostname>/bpui/ob/out/BP-b37b6e71a76bfa5f3847349684297033",
"returnUrl":"<hostname>/apmDemoApp/complete.html"
},
"customer":{
"email":"John@example.com"
},
"device":{
"browser":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.193 Safari/537.36"
},
"gatewayEntryPoint":"WEB_SERVICES_API",
"merchant":"TESTMERCHANT1",
"order":{
"amount":85116.16,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-11-20T05:07:28.085Z",
"currency":"EUR",
"id":"408124232",
"lastUpdatedTime":"2020-11-20T05:07:46.524Z",
"merchantAmount":85116.16,
"merchantCurrency":"EUR",
"reference":"TEST-SUCCEED",
"status":"FAILED",
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"AUTHENTICATION_FAILED"
},
"result":"FAILURE",
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"johnsmith@yahoo.com",
"firstName":"Shipfirst",
"lastName":"McShiplast"
}
},
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"timeOfLastUpdate":"2020-11-20T05:07:46.524Z",
"timeOfRecord":"2020-11-20T05:07:28.130Z",
"transaction":{
"acquirer":{
"id":"OPEN_BANKING_SEPA",
"merchantId":"Open Banking SEPA"
},
"amount":85116.16,
"currency":"EUR",
"id":"162988232",
"receipt":"16491f04ec662b0a",
"source":"INTERNET",
"stan":"0",
"type":"PAYMENT"
},
"version":"<latest_gateway_version>"
}
Sample retrieve transaction response for a cancelled Open Banking
interaction
Here's an example of a Retrieve Transaction response showing an Open
Banking interaction where response.gatewayCode = CANCELLED
{
"browserPayment":{
"interaction":{
"status":"COMPLETED",
"timeInitiated":"2020-11-20T05:17:33.076Z",
"timeRedirected":"2020-11-20T05:17:40.315Z",
"timeReturned":"2020-11-20T05:17:47.612Z"
},
"operation":"PAY",
"redirectUrl":"<hostname>/bpui/ob/out/BP-fdc97e608a425ec6cc535ae6a8dd9063",
"returnUrl":"<hostname>/apmDemoApp/complete.html"
},
"customer":{
"email":"John@example.com"
},
"device":{
"browser":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/86.0.4240.193 Safari/537.36"
},
"gatewayEntryPoint":"WEB_SERVICES_API",
"merchant":"TESTMERCHANT1",
"order":{
"amount":86117.17,
"chargeback":{
"amount":0,
"currency":"EUR"
},
"creationTime":"2020-11-20T05:17:33.039Z",
"currency":"EUR",
"id":"849804618",
"lastUpdatedTime":"2020-11-20T05:17:50.060Z",
"merchantAmount":86117.17,
"merchantCurrency":"EUR",
"reference":"TEST-SUCCEED",
"status":"FAILED",
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"CANCELLED"
},
"result":"FAILURE",
"shipping":{
"address":{
"city":"Kuressaare",
"country":"EE",
"postcodeZip":"93813",
"stateProvince":"Saare Maakond",
"street":"Tolli 25a",
"street2":"Jack Road"
},
"contact":{
"email":"johnsmith@yahoo.com",
"firstName":"Shipfirst",
"lastName":"McShiplast"
}
},
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"123456-xxxx-4dd4-b4f2-12234vgb43bff"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"timeOfLastUpdate":"2020-11-20T05:17:50.060Z",
"timeOfRecord":"2020-11-20T05:17:33.073Z",
"transaction":{
"acquirer":{
"id":"OPEN_BANKING_SEPA",
"merchantId":"Open Banking SEPA"
},
"amount":86117.17,
"currency":"EUR",
"id":"921434587",
"receipt":"16491f91c5986259",
"source":"INTERNET",
"stan":"0",
"type":"PAYMENT"
},
"version":"<latest_gateway_version>"
}
Refunds
Open Banking Bank Transfer does not support full or partial refund
payments.
Settlement Information
To view the details of the Open Banking Bank Transfer transaction
settlement, retrieve the order/transaction details using
Retrieve Order/Retrieve Transaction
operations, and check the transaction.receipt field for
the reference number. The same reference number will be displayed to
the payer on the payment receipt.
Testing Your Open Banking Bank Transfer Integration
The <<paymentGateway>> provides an Open Banking Bank Transfer
sample emulator that allows you to test your integration with a test
bank and test amounts. Once you complete your integration with the
Open Banking JavaScript SDK, you can perform test transactions using
the test transaction amounts with Emporium bank as shown in the table
below. If you wish to proceed with AS TBB pank bank, select the
scenario (success/failure) that you want to test using the options
from the drop-down list on the screen.
|
Use Case
|
Transaction Amount |
Transaction Status |
Order Status |
|
Verify retrieved order response for sepa successful transaction
with ACSC status
|
80111.10 EUR |
APPROVED |
CAPTURED |
|
Verify retrieved order response for sepa successful transaction
with RCVD status
|
80111.11 EUR |
SUBMITTED |
INITIATED |
|
Verify retrieved order response for sepa successful transaction
with PDNG status
|
81112.12 EUR |
PENDING |
CAPTURED |
|
Verify retrieved order response for sepa successful transaction
with ACSP status
|
82113.13 EUR |
PENDING |
CAPTURED |
|
Verify retrieved order response for sepa error transaction with
error as inactive provider
|
83114.14 EUR |
UNSPECIFIED_FAILURE |
FAILED |
|
Verify retrieved order response for sepa error transaction with
error as provider error
|
85116.16 EUR |
ACQUIRER_SYSTEM_ERROR |
FAILED |
|
Verify retrieved order response for sepa error transaction with
error as timeout
|
84115.15 EUR |
TIMED_OUT |
FAILED |
|
Verify retrieved order response for sepa rejected transaction with
reason code as authorized user has cancelled the order
|
86117.17 EUR |
CANCELLED |
FAILED |
|
Verify retrieved order response for sepa rejected transaction with
reason code as wait time expired due to incomplete order
|
87118.18 EUR |
TIMED_OUT |
FAILED |
|
Verify retrieved order response for sepa rejected transaction with
reason code as amount is invalid or missing
|
88119.19 EUR |
INSUFFICIENT_FUNDS |
FAILED |
|
Verify retrieved order response for sepa rejected transaction with
reason code as amount is invalid or missing
|
89120.20 EUR |
NOT_SUPPORTED |
FAILED |
|
Verify retrieved order response for sepa rejected transaction with
reason code as currency of the payment is incorrect
|
90121.21 EUR |
NOT_SUPPORTED |
FAILED |
|
Verify retrieved order response for sepa rejected transaction with
no reason code
|
97129.29 EUR |
NOT_SUPPORTED |
FAILED |
|
Verify retrieved order response for sepa error transaction with
incorrect aspsp id
|
83114.14 EUR |
UNSPECIFIED_FAILURE |
FAILED |
|
Verify retrieved order response for sepa error transaction with
aspsp id from unsupported profile
|
98129.29 EUR |
UNSPECIFIED_FAILURE |
FAILED |
|
Verify retrieved order response for sepa successful transaction
with get status as RCVD - ACSC
|
92123.23 EUR |
APPROVED |
CAPTURED |
|
Verify retrieved order response for sepa rejected transaction with
get status as PDNG - RJCT with reason as insufficient funds
|
94125.25 EUR |
INSUFFICIENT_FUNDS |
FAILED |
|
Verify retrieved order response for sepa successful transaction
with get status as PDNG - PDNG
|
95126.26 EUR |
PENDING |
CAPTURED |
|
Verify retrieved order response for sepa successful transaction
with get status as ACSP - ACSC
|
97128.28 EUR |
APPROVED |
CAPTURED |
|
Verify retrieved order response for sepa successful transaction
with get status as PDNG - ACSP
|
91122.22 EUR |
PENDING |
CAPTURED |
|
Verify retrieved order response for sepa rejected transaction with
get status as PDNG - RJCT with reason as authentication failure
|
93124.24 EUR |
AUTHENTICATION_FAILED |
FAILED |