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":"GBP"
},
"creationTime":"2020-08-17T09:35:27.250Z",
"currency":"GBP",
"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":"GBP",
"reference":"TEST-SUCCEED",
"result":"SUCCESS",
"shipping":{
"address":{
"city":"Shipsville",
"country":"GBR",
"postcodeZip":"EH67DX",
"stateProvince":"Scotland",
"street":"2ShippingHeights",
"street2":"ShipsDrive"
},
"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":"GBP"
},
"creationTime":"2020-08-17T09:35:27.250Z",
"currency":"GBP",
"id":"992608474",
"lastUpdatedTime":"2020-08-17T09:36:04.146Z",
"merchantAmount":82113.13,
"merchantCurrency":"GBP",
"reference":"TEST-SUCCEED",
"status":"INITIATED",
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"SUBMITTED"
},
"result":"SUCCESS",
"shipping":{
"address":{
"city":"Shipsville",
"country":"GBR",
"postcodeZip":"EH67DX",
"stateProvince":"Scotland",
"street":"2ShippingHeights",
"street2":"ShipsDrive"
},
"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",
"merchantId":"Lloyds"
},
"amount":82113.13,
"currency":"GBP",
"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":"GBP"
},
"creationTime":"2020-06-24T01:01:09.584Z",
"currency":"GBP",
"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":"GBP",
"reference":"sample",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"London",
"company":"ABC",
"country":"GBR",
"postcodeZip":"90001",
"stateProvince":"ENG",
"street":"2nd Main",
"street2":"lane 2"
},
"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":"GBP"
},
"creationTime":"2020-06-24T01:01:09.584Z",
"currency":"GBP",
"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":"GBP",
"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":"London",
"company":"ABC",
"country":"GBR",
"postcodeZip":"90001",
"stateProvince":"ENG",
"street":"2nd Main",
"street2":"lane 2"
},
"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",
"merchantId":"Lloyds"
},
"amount":123.46,
"currency":"GBP",
"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":"GBP"
},
"creationTime":"2020-06-26T07:09:16.846Z",
"currency":"GBP",
"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":"GBP",
"reference":"TEST-SUCCEED",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Shipsville",
"country":"GBR",
"postcodeZip":"EH67DX",
"stateProvince":"Scotland",
"street":"2ShippingHeights",
"street2":"ShipsDrive"
},
"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":"GBP"
},
"creationTime":"2020-06-26T07:09:16.846Z",
"currency":"GBP",
"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":"GBP",
"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":"Shipsville",
"country":"GBR",
"postcodeZip":"EH67DX",
"stateProvince":"Scotland",
"street":"2ShippingHeights",
"street2":"ShipsDrive"
},
"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",
"merchantId":"Lloyds"
},
"amount":123.46,
"currency":"GBP",
"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":"GBP"
},
"creationTime":"2020-06-11T07:04:16.222Z",
"currency":"GBP",
"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":"GBP",
"reference":"sample",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"London",
"company":"ABC",
"country":"GBR",
"postcodeZip":"90001",
"stateProvince":"ENG",
"street":"2nd Main",
"street2":"lane 2"
},
"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":"GBP"
},
"creationTime":"2020-06-11T07:04:16.222Z",
"currency":"GBP",
"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":"GBP",
"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":"London",
"company":"ABC",
"country":"GBR",
"postcodeZip":"90001",
"stateProvince":"ENG",
"street":"2nd Main",
"street2":"lane 2"
},
"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",
"merchantId":"Lloyds"
},
"amount":123.46,
"currency":"GBP",
"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":"GBP"
},
"creationTime":"2020-06-26T07:17:48.608Z",
"currency":"GBP",
"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":"GBP",
"reference":"TEST-SUCCEED",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"Shipsville",
"country":"GBR",
"postcodeZip":"EH67DX",
"stateProvince":"Scotland",
"street":"2ShippingHeights",
"street2":"ShipsDrive"
},
"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":"GBP"
},
"creationTime":"2020-06-26T07:17:48.608Z",
"currency":"GBP",
"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":"GBP",
"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":"Shipsville",
"country":"GBR",
"postcodeZip":"EH67DX",
"stateProvince":"Scotland",
"street":"2ShippingHeights",
"street2":"ShipsDrive"
},
"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",
"merchantId":"Lloyds"
},
"amount":123.46,
"currency":"GBP",
"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":"GBP"
},
"creationTime":"2020-06-11T07:04:25.661Z",
"currency":"GBP",
"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":"GBP",
"reference":"sample",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"London",
"company":"ABC",
"country":"GBR",
"postcodeZip":"90001",
"stateProvince":"ENG",
"street":"2nd Main",
"street2":"lane 2"
},
"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":"GBP"
},
"creationTime":"2020-06-11T07:04:25.661Z",
"currency":"GBP",
"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":"GBP",
"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":"London",
"company":"ABC",
"country":"GBR",
"postcodeZip":"90001",
"stateProvince":"ENG",
"street":"2nd Main",
"street2":"lane 2"
},
"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",
"merchantId":"Lloyds"
},
"amount":123.46,
"currency":"GBP",
"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":"GBP"
},
"creationTime":"2020-06-11T07:06:37.862Z",
"currency":"GBP",
"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":"GBP",
"reference":"sample",
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED"
}
},
"shipping":{
"address":{
"city":"London",
"company":"ABC",
"country":"GBR",
"postcodeZip":"90001",
"stateProvince":"ENG",
"street":"2nd Main",
"street2":"lane 2"
},
"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":"GBP"
},
"creationTime":"2020-06-11T07:06:37.862Z",
"currency":"GBP",
"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":"GBP",
"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":"London",
"company":"ABC",
"country":"GBR",
"postcodeZip":"90001",
"stateProvince":"ENG",
"street":"2nd Main",
"street2":"lane 2"
},
"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",
"merchantId":"Lloyds"
},
"amount":123.46,
"currency":"GBP",
"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":"GBP"
},
"creationTime":"2020-11-20T05:07:28.085Z",
"currency":"GBP",
"id":"408124232",
"lastUpdatedTime":"2020-11-20T05:07:46.524Z",
"merchantAmount":85116.16,
"merchantCurrency":"GBP",
"reference":"TEST-SUCCEED",
"status":"FAILED",
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"AUTHENTICATION_FAILED"
},
"result":"FAILURE",
"shipping":{
"address":{
"city":"Shipsville",
"country":"GBR",
"postcodeZip":"EH67DX",
"stateProvince":"Scotland",
"street":"2ShippingHeights",
"street2":"ShipsDrive"
},
"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",
"merchantId":"Lloyds"
},
"amount":85116.16,
"currency":"GBP",
"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":"GBP"
},
"creationTime":"2020-11-20T05:17:33.039Z",
"currency":"GBP",
"id":"849804618",
"lastUpdatedTime":"2020-11-20T05:17:50.060Z",
"merchantAmount":86117.17,
"merchantCurrency":"GBP",
"reference":"TEST-SUCCEED",
"status":"FAILED",
"totalAuthorizedAmount":0,
"totalCapturedAmount":0,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"CANCELLED"
},
"result":"FAILURE",
"shipping":{
"address":{
"city":"Shipsville",
"country":"GBR",
"postcodeZip":"EH67DX",
"stateProvince":"Scotland",
"street":"2ShippingHeights",
"street2":"ShipsDrive"
},
"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",
"merchantId":"Lloyds"
},
"amount":86117.17,
"currency":"GBP",
"id":"921434587",
"receipt":"16491f91c5986259",
"source":"INTERNET",
"stan":"0",
"type":"PAYMENT"
},
"version":"<latest_gateway_version>"
}
Refunds
Prerequisites
To initiate a refund request, <<paymentServiceProvider>> must configure you for the Refund privilege.
To use refunds, use the JS-SDK version 1.3.0 that is supported from the WSAPI version 68.
Refunds are supported for only domestic transactions. You can submit the Refund requests either through the Refund operation or the Merchant Administration portal. For the Open Banking payments, you can partially or completely refund the processed payments for the captured transactions.
The Open banking transfer payments do not support excessive refunds.
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.
Webhook notifications
Subscribing to Webhook notifications enables you to receive notifications on your system when a transaction for an order is created or updated in the gateway. This allows you to update your merchant system accordingly. The Webhook notification contains the response of the Retrieve Transaction operation.
Webhook Notifications Details
Sample Webhook Response
{
"browserPayment":{
"interaction":{
"status":"COMPLETED",
"timeInitiated":"2021-02-18T10:59:26.772Z",
"timeRedirected":"2021-02-18T10:59:31.236Z",
"timeReturned":"2021-02-18T11:00:01.577Z"
},
"operation":"PAY",
"redirectUrl":"https://lloydsbankpayfrombank.gateway.mastercard.com/bpui/ob/out/BP-5da80e52dd990b1970ae8bdfc6fddb36",
"returnUrl":"https://prd-mastercard.airbakery.eu/Return.aspx"
},
"customer":{
"email":"johnsmith@yahoo.com"
},
"device":{
"browser":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36 Edg/88.0.705.68",
"ipAddress":"101.00.100.00"
},
"gatewayEntryPoint":"WEB_SERVICES_API",
"merchant":"AIRBAKERY",
"order":{
"amount":5.00,
"chargeback":{
"amount":0,
"currency":"GBP"
},
"creationTime":"2021-02-18T10:59:26.728Z",
"currency":"GBP",
"id":"TESTORD12345",
"lastUpdatedTime":"2021-02-18T11:00:31.905Z",
"merchantAmount":5.00,
"merchantCurrency":"GBP",
"status":"CAPTURED",
"totalAuthorizedAmount":5.00,
"totalCapturedAmount":5.00,
"totalRefundedAmount":0
},
"response":{
"gatewayCode":"APPROVED"
},
"result":"SUCCESS",
"risk":{
"response":{
"gatewayCode":"ACCEPTED",
"review":{
"decision":"NOT_REQUIRED",
"note":""
},
"rule":[
{
"data":"100.00.100.01",
"name":"MSO_IP_ADDRESS_RANGE",
"recommendation":"NO_ACTION",
"type":"MSO_RULE"
},
{
"data":"GBR",
"name":"MSO_IP_COUNTRY",
"recommendation":"NO_ACTION",
"type":"MSO_RULE"
}
]
}
},
"sourceOfFunds":{
"provided":{
"openBankingBankTransfer":{
"aspspId":"12345-23abc-a2g-a8e7-5653886af4"
}
},
"type":"OPEN_BANKING_BANK_TRANSFER"
},
"timeOfLastUpdate":"2021-02-18T11:00:31.905Z",
"timeOfRecord":"2021-02-18T10:59:26.768Z",
"transaction":{
"acquirer":{
"id":"OPEN_BANKING",
"merchantId":"Lloyds"
},
"amount":5.00,
"currency":"GBP",
"id":" TESTTRX12345",
"receipt":"52345667731732aa",
"source":"INTERNET",
"stan":"0",
"type":"PAYMENT"
},
"version":"<latest_gateway_version>"
}
Webhook Response Description
The following table provides description about each element in the Webhook response
Item |
Description |
Values |
| BrowserPayment |
Information required by the gateway to manage interactions with a browser payment provider's website. |
- |
| Interaction |
Provides details about the interaction of your system and the providers system when initiating the browser payment, redirecting the customer's browser to the provider's system, back to the merchant's website and completing the browser payment |
- |
| Status |
The status of the interaction between the merchant's system and the payment provider's system. |
COMPLETED:
This browser payment has been completed, i.e. the gateway has been informed about the payment result.
INITIATED:
This browser payment has successfully been initiated.
REDIRECTED_TO_PROVIDER:
The payer's browser has been redirected to the payment provider's website.
RETURNED_TO_MERCHANT:
The payer's browser has been redirected back from the payment provider's website to the merchant's website.
|
| Time Initiated |
The date and time the browser payment was initiated. |
For example, below is the sample value to refer the format:
2021-02-18T10:59:26.772Z |
| Time Redirected |
The date and time the customer's browser were received from the merchant's website and redirected to the
provider's website. |
For example, below is the sample value to refer the format:
2021-02-18T10:59:31.236Z |
| Time Returned |
The date and time the customer's browser were received from the provider's website and redirected back to the merchant's website |
For example, below is the sample value to refer the format:
2021-02-18T11:00:01.577Z |
| Operation |
The type of transaction created for this payment. |
PAY |
| Redirect URL |
The URL within merchant's website to which the payer's browser will be redirected when payer choose “Open Banking Bank Transfer” payment method. |
- |
| Return URL |
The URL to which you want the payer's browser to be redirected to on completing the payment at the payment provider's website. The same redirect URL will be used by the gateway to redirect the payer's browser irrespective of the success or otherwise of the payment. Merchant can build solution to interrogate the response of success or otherwise to display specific message to payer. |
- |
| Customer |
Information about the customer. For example, their contact details, email address, and so on. |
- |
| Email |
The email address of the customer. Ensures that the email address is longer than 3 characters and adheres to a generous subset of valid RFC 2822 email addresses. |
For example – JohnDoe@yahoo.com |
| Device |
Information about the device used by the payer for this transaction |
- |
| Browser |
The User-Agent header of the browser the customer used to place the order |
For example – “Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/88.0.4324.150 Safari/537.36 Edg/88.0.705.68" |
| IP Address |
The IP address of the device used by the payer, in nnn.nnn.nnn.nnn format |
- |
| GatewayEntryPoint |
The interface through which the transaction is submitted to the gateway. |
Defaults to “WEB_SERVICE_API” |
| Merchant |
The unique identifier issued to you by your payment provider. In other terms the “Merchant ID”. |
Merchant name |
| Order |
Information about the order associated with this transaction. |
- |
| Amount |
The total amount for the order. This is the net amount plus any surcharge. If you provide any sub-total amounts, then the sum of these amounts (order.itemAmount, order.taxAmount, order.shippingAndHandlingAmount, order.cashbackAmount, order.gratuityAmount), minus the order.discountAmount must equal the net amount. |
For example - 5.00 |
| Chargeback |
Not applicable to Open Banking Bank Transfer but Amount and Currency should be specified as follows |
- |
| Amount |
- |
Zero |
| Currency |
- |
GBP |
| Creation Time |
The date and time from the Gateway that the order was created |
For example, below is the sample value to refer the format:
2021-02-18T10:59:26.728Z |
| Currency |
The currency of the order expressed as an ISO 4217 alpha code |
GBP |
| ID |
A unique identifier for this order to distinguish it from any other order you create. Use this identifier when referring to this order in subsequent transactions and in retrieval operations. This value must be unique for every order created by your merchant profile. |
The generated Order ID |
| Last updated time |
The date and time from the gateway the order was last updated. An instant in time expressed in ISO8601 date + time format - "YYYY-MM-DDThh:mm:ss.SSSZ" |
For example , below is the sample value to refer the format:
2021-02-18T11:00:31.905Z |
| Merchant amount |
The total amount for the order |
For example – 5.00 |
| Merchant currency |
The currency of the order expressed as an ISO 4217 alpha code. |
GBP |
| Status |
The current progression of this order through the payment process. |
CANCELLED:
The initial transaction for this order has been voided successfully.
CAPTURED:
The authorized amount for this order, in full or excess, has been captured successfully
FAILED:
The payment has not been successful
INITIATED:
A payment that has successfully been initiated for this order. No payment has yet been made.
|
| Total Authorized Amount |
The amount that has been successfully authorized for this order. |
For Open Banking Bank Transfer it would always be equal to order amount. |
| Total Captured Amount |
The amount that has been successfully captured for this order. |
For Open Banking Bank Transfer it would always be equal to order amount. |
| Total Refunded Amount |
The amount that has been successfully refunded for this order. |
For Open Banking Bank Transfer it would always be zero. |
| Response |
Gateway response for this transaction. |
- |
| Gateway Code |
Summary of the success or otherwise of the operation. |
ACQUIRER_SYSTEM_ERROR:
Acquirer system error occurred processing the transaction
APPROVED:
Transaction Approved
AUTHENTICATION_FAILED:
Payer authentication failed
CANCELLED:
Transaction cancelled by payer
DECLINED:
The requested operation was not successful. For example, a payment was declined by issuer or payer
authentication was not able to be successfully completed.
INSUFFICIENT_FUNDS:
Transaction declined due to insufficient funds
NOT_SUPPORTED:
Transaction type not supported
PENDING:
Transaction is pending
SUBMITTED:
The transaction has successfully been created in the gateway. It is either awaiting submission to the acquirer
or has been submitted to the acquirer, but the gateway has not yet received a response about the success or
otherwise of the payment.
TIMED_OUT:
The gateway has timed out the request to the acquirer because it did not receive a response. Points
redemption should not be offered to the payer.
UNKNOWN:
The transaction has been submitted to the acquirer, but the gateway was not able to find out about the
success or otherwise of the payment. If the gateway subsequently finds out about the success of the payment
it will update the response code.
UNSPECIFIED_FAILURE:
Transaction could not be processed
|
| Results |
A system-generated high level overall result of the operation. |
FAILURE:
The operation was declined or rejected by the gateway, acquirer or issuer.
PENDING:
The operation is currently in progress or pending processing.
SUCCESS:
The operation was successfully processed.
UNKNOWN:
The result of the operation is unknown
|
| Risk |
Information relevant to risk assessment is not applicable for Open Banking Bank Transfer. Ignore the details under this object. |
- |
| SourceOfFunds |
Information about the payment type selected by the payer for this payment and the source of the funds. |
- |
| Provided |
Information about the source of funds when it is directly provided (as opposed to via a token or session). |
- |
| Open Banking Bank Transfer |
Additional details related to Open Banking Bank Transfer also known as Open Banking Bank Transfer. |
- |
| ASPSP ID |
Identifier of the payer's bank, also known as ASPSP (Account Servicing Payment Services Provider |
- |
| Type |
The payment method used for this payment |
Open Banking Bank Transfer |
| TimeOfLastUpdated |
The date and time from the gateway when the transaction was last updated. |
For example, below is the sample value to refer the format:
2021-02-18T11:00:31.905Z |
| TimeOfRecord |
The date and time from the gateway when the transaction was created. |
For example, below is the sample value to refer the format:
2021-02-18T10:59:26.768Z |
| Transaction |
Information about this transaction. |
- |
| Acquirer |
Information about this acquirer. |
- |
| ID |
The ID for the acquirer used to process the transaction |
Open Banking |
| Merchant ID |
An identifier allocated by an acquirer to the merchant |
Lloyds |
| Amount |
The total amount for the transaction. |
For example – 5.00 |
| Currency |
The currency of the transaction expressed as an ISO 4217 alpha code |
GBP |
| ID |
Unique identifier for this transaction to distinguish it from any other transaction on the order. |
The generated transaction ID. |
| Receipt |
A unique reference generated by the acquirer for a specific merchant interaction. |
The generated reference number for merchant. |
| Source |
Indicates the channel through which you received authorization for the payment for this order from the payer |
INTERNET |
| STAN |
The System Trace Audit Number (STAN) for the transaction. |
Zero |
| Type |
Indicates the type of action performed on the order. |
PAYMENT |
| Version |
The Web Services API version in which the request was submitted. |
Default version – 63 |
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 Copernicium bank as shown in the table below. If you wish to proceed with Ozone Modelo Test Bank, select the scenario (success/failure) that you want to test using the options from the drop-down list on the screen.
Scenario |
Transaction Amount |
Transaction Status |
Order Status |
| Success scenarios (default) |
80111.11 GBP |
SUBMITTED |
INITIATED |
| Success scenarios (default) |
81112.12 GBP |
PENDING RESPONSE |
CAPTURED |
| Success scenarios (default) |
92123.23 GBP |
APPROVED |
CAPTURED |
| Failure scenarios (default) |
83114.14 GBP |
UNSPECIFIED FAILURE |
FAILED |
| Access denied |
85116.16 GBP |
AUTHENTICATION FAILED |
FAILED |
| Transaction Request Timeout |
84115.15 GBP |
TIMED OUT |
FAILED |
| Transaction Cancelled |
86117.17 GBP |
CANCELLED |
FAILED |
| Failure scenarios - payment processing timeout |
87118.18 GBP |
TIMED OUT |
FAILED |
| Insufficient funds |
88119.19 GBP |
INSUFFICIENT FUNDS |
FAILED |
| Invalid Amount |
89120.20 GBP |
NOT SUPPORTED |
FAILED |
| Invalid Currency |
89120.20 GBP |
NOT SUPPORTED |
FAILED |