Exemples
Exemple de réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking soumise
L'exemple ci-dessous illustre une réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking soumise (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>"
}
}
Exemple de réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking approuvée
L'exemple ci-dessous illustre une réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking approuvée (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>"
}
}
Exemple de réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking en attente
L'exemple ci-dessous illustre une réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking en attente (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>"
}
}
Exemple de réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking non prise en charge
L'exemple ci-dessous illustre une réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking lorsque 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>"
}
}
Exemple de réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking interrompue
L'exemple ci-dessous illustre une réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking interrompue (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>"
}
}
Exemple de réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking lorsque les fonds sont insuffisants
L'exemple ci-dessous illustre une réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking lorsque 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>"
}
}
Exemple de réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking refusée
L'exemple ci-dessous illustre une réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking refusée lorsque 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>"
}
}
Exemple de réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking lorsque l'authentification a échoué
L'exemple ci-dessous illustre une réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking lorsque 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>"
}
Exemple de réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking annulée
L'exemple ci-dessous illustre une réponse Retrieve Transaction (Extraire la transaction) pour une interaction Open Banking lorsque 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>"
}
Remboursements
Conditions préalables
Pour lancer une demande de remboursement, votre <<paymentServiceProvider>> doit vous configurer pour le privilège Remboursement.
Pour utiliser les remboursements, utilisez la version 1.3.0 de JS-SDK prise en charge à compter de la version 68 de WSAPI.
Les remboursements ne sont pris en charge que pour les transactions nationales. Vous pouvez soumettre des demandes Refund (Rembourser) à l'aide de l'opération Refund (Rembourser) ou via le portail Merchant Administration. Pour les paiements Open Banking, vous pouvez rembourser partiellement ou totalement les paiements traités pour les transactions collectées. Les paiements par virement Open Banking ne prennent pas en charge les remboursements excessifs.
Informations de règlement
Pour afficher les détails du règlement de la transaction Open Banking Bank Transfer, extrayez les détails de la commande/de la transaction en utilisant les opérations Retrieve Order (Extraire la commande)/Retrieve Transaction (Extraire la transaction) et vérifiez le numéro de référence dans le champ transaction.receipt. Le même numéro de référence sera affiché au payeur sur le reçu de paiement.
Notifications Webhook
Souscrire aux notifications Webhook vous permet de recevoir sur votre système des notifications lorsqu'une transaction concernant une commande est créée ou mise à jour sur la passerelle. Cela vous permet de mettre à jour le système de votre commerçant en conséquence. La notification Webhook contient la réponse de l'opération Retrieve Transaction (Extraire la transaction).
Détails des notifications Webhook
Exemple de réponse Webhook
{
"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>"
}
Description de la réponse Webhook
Le tableau suivant propose une description de chaque élément de la réponse Webhook.
Élément |
Description |
Valeurs |
| BrowserPayment |
Informations requises par la passerelle pour gérer les interactions avec le site Web d'un prestataire de services de paiement avec redirection. |
- |
| Interaction |
Fournit des détails sur l'interaction de votre système et des systèmes des prestataires lors du lancement du paiement avec redirection, de la redirection du navigateur du client vers le système du prestataire, du retour sur le site Web du commerçant et de la fin du paiement avec redirection. |
- |
| Status |
Statut de l'interaction entre le système du commerçant et le système du prestataire de services de paiement. |
COMPLETED : ce paiement avec redirection a été effectué, c'est-à-dire que la passerelle a été informée du résultat du paiement.
INITIATED : ce paiement avec redirection a été lancé avec succès.
REDIRECTED_TO_PROVIDER : le navigateur du payeur a été redirigé vers le site Web du prestataire de services de paiement.
RETURNED_TO_MERCHANT : le navigateur du payeur a été redirigé du site Web du prestataire de services de paiement vers le site Web du commerçant.
|
| Time Initiated |
Date et heure auxquelles le paiement avec redirection a été initié. |
Par exemple, la valeur suivante utilise le format : 2021-02-18T10:59:26.772Z. |
| Time Redirected |
Date et heure auxquelles le navigateur du client a été reçu du site Web du commerçant et redirigé vers le site Web du prestataire. |
Par exemple, la valeur suivante utilise le format : 2021-02-18T10:59:31.236Z. |
| Time Returned |
Date et heure auxquelles le navigateur du client a été reçu du site Web du prestataire et redirigé vers le site Web du commerçant. |
Par exemple, la valeur suivante utilise le format : 2021-02-18T11:00:01.577Z. |
| Operation |
Type de la transaction créée pour ce paiement. |
PAY (Payer) |
| Redirect URL |
URL du site Web du commerçant vers laquelle le navigateur du payeur sera redirigé lorsque le payeur choisit le mode de paiement « Open Banking Bank Transfer ». |
- |
| Return URL |
URL vers laquelle vous souhaitez que le navigateur du payeur soit redirigé lorsque le paiement sur le site Web du prestataire de services de paiement avec redirection a eu lieu. La même URL de redirection sera utilisée par la passerelle pour rediriger le navigateur du payeur, que le paiement réussisse ou non. Le commerçant peut créer une solution pour interroger la réponse de réussite ou autre résultat pour afficher un message spécifique au payeur. |
- |
| Customer |
Informations sur le client. Par exemple, ses coordonnées, son adresse électronique, etc. |
- |
| Email |
Adresse électronique du client. Garantit que l'adresse électronique comporte plus de 3 caractères et adhère à un sous-ensemble important d'adresses électroniques RFC 2822 valides. |
Par exemple : JohnDoe@yahoo.com. |
| Device |
Informations sur l'appareil utilisé par le payeur pour cette transaction. |
- |
| Browser |
En-tête de l'agent utilisateur du navigateur utilisé par le client pour passer la commande. |
Par exemple : « Mozilla/5.0 (Windows NT 10.0 ; Win64 ; x64) AppleWebKit/537.36 (KHTML, comme Gecko) Chrome/88.0.4324.150 Safari/537.36 Edge/88.0.705.68 ». |
| IP Address |
Adresse IP de l'appareil utilisé par le payeur, au format nnn.nnn.nnn.nnn. |
- |
| GatewayEntryPoint |
Interface via laquelle la transaction est soumise à la passerelle. |
La valeur par défaut est « WEB_SERVICE_API ». |
| Merchant |
Identifiant unique qui vous est délivré par votre prestataire de services de paiement. Également appelé « ID du commerçant ». |
Nom du commerçant |
| Order |
Informations sur la commande associée à cette transaction. |
- |
| Amount |
Montant total de la commande. Montant net plus tout surcoût. Si vous indiquez des sous-totaux, la somme de ces montants (order.itemAmount, order.taxAmount, order.shippingAndHandlingAmount, order.cashbackAmount, order.gratuityAmount), moins order.discountAmount doit être égale au montant net. |
Par exemple : 5,00 |
| Chargeback |
Ne s'applique pas à Open Banking Bank Transfer, mais le montant et la devise doivent être spécifiés comme suit : |
- |
| Amount |
- |
Zéro |
| Currency |
- |
GBP |
| Creation Time |
Date et heure de la passerelle sur laquelle la commande a été créée. |
Par exemple, la valeur suivante utilise le format : 2021-02-18T10:59:26.728Z |
| Currency |
Devise de la commande exprimée en code alpha ISO 4217. |
GBP |
| ID |
Identifiant unique de cette commande permettant de la différencier des autres commandes que vous créez. Utilisez cet identifiant lorsque vous faites référence à cette commande dans les transactions ultérieures et dans les opérations de récupération. Cette valeur doit être unique pour chaque commande créée par votre profil de commerçant. |
ID de commande généré |
| Last updated time |
Date et heure de la passerelle sur laquelle a eu lieu la dernière mise à jour de la commande. Horodatage exprimé au format date + heure ISO8601 : « AAAA-MM-JJThh:mm:ss.SSSZ » |
Par exemple, la valeur suivante utilise le format : 2021-02-18T11:00:31.905Z. |
| Merchant amount |
Montant total de la commande. |
Par exemple : 5,00 |
| Merchant currency |
Devise de la commande exprimée en code alpha ISO 4217. |
GBP |
| Status |
Progression actuelle de cette commande dans le processus de paiement. |
CANCELLED : l'annulation de la transaction initiale pour cette commande a réussi.
CAPTURED : la collecte du montant autorisé pour cette commande, en totalité ou en excès, a réussi.
FAILED : le paiement a échoué.
INITIATED : un paiement qui a été lancé avec succès pour cette commande. Aucun paiement n'a encore été effectué.
|
| Total Authorized Amount |
Montant autorisé avec succès pour cette commande. |
Pour Open Banking Bank Transfer, il doit toujours être égal au montant de la commande. |
| Total Captured Amount |
Montant collecté avec succès pour cette commande. |
Pour Open Banking Bank Transfer, il doit toujours être égal au montant de la commande. |
| Total Refunded Amount |
Montant remboursé avec succès pour cette commande. |
Pour Open Banking Bank Transfer, il doit toujours être égal à zéro. |
| Response |
Réponse de la passerelle pour cette transaction. |
- |
| Gateway Code |
Résumé du succès ou non de l'opération. |
ACQUIRER_SYSTEM_ERROR : une erreur système de l'acquéreur s'est produite au cours du traitement de la transaction.
APPROVED : transaction approuvée.
AUTHENTICATION_FAILED : l'authentification du payeur a échoué.
CANCELLED : transaction annulée par le payeur.
DECLINED : L'opération demandée a échoué. Par exemple, un paiement a été refusé par l'émetteur ou l'authentification du payeur a échoué.
INSUFFICIENT_FUNDS : transaction refusée en raison de fonds insuffisants.
NOT_SUPPORTED : type de transaction non pris en charge.
PENDING : la transaction est en attente.
SUBMITTED : la transaction a été créée avec succès sur la passerelle. Soit elle est en attente de soumission à l'acquéreur, soit elle a été soumise à l'acquéreur, mais la passerelle n'a pas encore reçu de réponse concernant la réussite ou non du paiement.
TIMED_OUT : la passerelle a fait expirer la requête adressée à l'acquéreur car elle n'a pas reçu de réponse. Le rachat de points ne doit pas être proposé au payeur.
UNKNOWN : la transaction a été soumise à l'acquéreur, mais la passerelle n'a pas été en mesure de savoir si le paiement a réussi. Si la passerelle découvre par la suite que le paiement a réussi, elle mettra à jour le code de réponse.
UNSPECIFIED_FAILURE : impossible de traiter la transaction.
|
| Results |
Résultat global de haut niveau de l'opération généré par le système. |
FAILURE : l'opération a été refusée ou rejetée par la passerelle, l'acquéreur ou l'émetteur.
PENDING : l'opération est actuellement en cours ou en attente de traitement.
SUCCESS : l'opération a été traitée avec succès.
UNKNOWN : le résultat de l'opération est inconnu.
|
| Risk |
Les informations relatives à l'évaluation des risques ne s'appliquent pas à Open Banking Bank Transfer. Ignorez les détails sous cet objet. |
- |
| SourceOfFunds |
Informations sur le type de paiement sélectionné par le payeur pour ce paiement et sur la source des fonds. |
- |
| Provided |
Informations sur la source des fonds lorsqu'elles sont fournies directement (par opposition à via un jeton ou une session). |
- |
| Open Banking Bank Transfer |
Détails supplémentaires liés à Open Banking Bank Transfer. |
- |
| ID ASPSP |
Identifiant de la banque du payeur, également appelé ASPSP (Account Servicing Payment Services Provider). |
- |
| Type |
Mode de paiement utilisé pour ce paiement. |
Open Banking Bank Transfer |
| TimeOfLastUpdated |
Date et heure de la passerelle sur laquelle a eu lieu la dernière mise à jour de la transaction. |
Par exemple, la valeur suivante utilise le format : 2021-02-18T11:00:31.905Z. |
| TimeOfRecord |
Date et heure de la passerelle sur laquelle a eu lieu la création de la transaction. |
Par exemple, la valeur suivante utilise le format : 2021-02-18T10:59:26.768Z. |
| Transaction |
Informations sur cette transaction. |
- |
| Acquirer |
Informations sur cet acquéreur. |
- |
| ID |
L'ID de l'acquéreur utilisé pour traiter la transaction. |
Open Banking |
| Merchant ID |
Identifiant attribué par un acquéreur au commerçant. |
Lloyds |
| Amount |
Montant total de la transaction. |
Par exemple : 5,00 |
| Currency |
Devise de la transaction exprimée en code alpha ISO 4217. |
GBP |
| ID |
Identifiant unique de cette transaction qui la différencie de toutes les autres transactions pour la commande. |
ID de transaction généré. |
| Receipt |
Référence unique générée par l'acquéreur pour une interaction spécifique avec le commerçant. |
Numéro de référence généré pour le commerçant. |
| Source |
Indique le canal par lequel vous avez reçu de la part du payeur l'autorisation de paiement de cette commande. |
INTERNET |
| STAN |
Numéro d'audit de suivi du système (STAN) pour la transaction. |
Zéro |
| Type |
Indique le type d'action effectuée sur la commande. |
PAYMENT |
| Version |
Version de l'API des services Web dans laquelle la demande a été soumise. |
Version par défaut - 63 |
Test de votre intégration Open Banking Bank Transfer
<<paymentGateway>> propose un exemple d'émulateur pour Open Banking Bank Transfer qui vous permet de tester votre intégration avec une banque et des montants de test. Une fois votre intégration effectuée avec le SDK JavaScript Open Banking, vous pouvez lancer des transactions de test en utilisant les montants de transaction de test avec la banque Copernicium, comme indiqué dans le tableau ci-dessous. Si vous souhaitez poursuivre avec la banque de test Ozone Modelo, sélectionnez le scénario (succès/échec) que vous souhaitez tester à l'aide des options de la liste déroulante affichée à l'écran.
Scénario |
Montant de la transaction |
Statut de la transaction |
Statut de la commande |
| Scénarios de réussite (par défaut) |
80111,11 GBP |
SUBMITTED |
INITIATED |
| Scénarios de réussite (par défaut) |
81112,12 GBP |
PENDING RESPONSE |
CAPTURED |
| Scénarios de réussite (par défaut) |
92123,23 GBP |
APPROVED |
CAPTURED |
| Scénarios d'échec (par défaut) |
83114,14 GBP |
UNSPECIFIED FAILURE |
FAILED |
| Accès refusé |
85116,16 GBP |
AUTHENTICATION FAILED |
FAILED |
| Expiration de la demande de transaction |
84115,15 GBP |
TIMED OUT |
FAILED |
| Transaction annulée |
86117,17 GBP |
CANCELLED |
FAILED |
| Scénarios d'échec - expiration du traitement des paiements |
87118,18 GBP |
TIMED OUT |
FAILED |
| Fonds insuffisants |
88119,19 GBP |
INSUFFICIENT FUNDS |
FAILED |
| Montant non valide |
89120,20 GBP |
NOT SUPPORTED |
FAILED |
| Devise non valide |
89120,20 GBP |
NOT SUPPORTED |
FAILED |