---
updatedAt: 2025-11-12T23:50:58.000Z
agentTools:
projectIndex: https://developer.pxp-solutions.com/llms.txt
---
# Alternative Payment Method (APM) Transaction
This Service is used to for Card / APM processing.
This request type can be used to process supported APMs transactions.
> **Note1:** The decimal separator/radix character used is the Period ('.') used to indicate decimal places. Other characters such as Comma (',') will not be recognised and may result in an unintended amount being processed.
# OpenAPI definition
```json
{
"openapi": "3.1.0",
"info": {
"title": "transaction-service",
"version": "1.0"
},
"servers": [
{
"url": "https://api-integration.pxp-solutions.net/transactionservice"
}
],
"components": {
"securitySchemes": {
"sec0": {
"type": "http",
"scheme": "basic"
}
}
},
"security": [
{
"sec0": []
}
],
"paths": {
"/api/v5/apmTransactions": {
"post": {
"summary": "Alternative Payment Method (APM) Transaction",
"description": "This Service is used to for Card / APM processing.\n\nThis request type can be used to process supported APMs transactions.",
"operationId": "processing-a-transaction-using-an-alternative-payment-method",
"parameters": [
{
"name": "Authorization",
"in": "header",
"schema": {
"type": "string",
"default": "Basic QkREVGVzdDpCRERUZXN0"
}
},
{
"name": "Content-Type",
"in": "header",
"schema": {
"type": "string",
"default": "application/json"
}
}
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
"required": [
"merchantId",
"storeId",
"userId",
"type",
"amount",
"currencyCode",
"clientSystemTransactionId"
],
"properties": {
"merchantId": {
"type": "string",
"description": "[Length=3] This is the customer code, a unique customer ID allocated to a customer when the service is set up"
},
"storeId": {
"type": "string",
"description": "[Length=12] This is the site identifier, a unique site ID allocated to a customer when the service is set up"
},
"userId": {
"type": "string",
"description": "[Length<=50] This is a username allocated to a service user when the service is set up; it refers to a service account not a person"
},
"type": {
"type": "string",
"description": "This is a combination of how the card was captured and transaction type of the transaction. i.e. mailorder.sale, internet.preAuthorization. Refer to Type under Elements"
},
"amount": {
"type": "string",
"description": "This is the monetary value of the transaction in minor units. See Note1"
},
"currencyCode": {
"type": "string",
"description": "[Length=3] This is the currency of the transaction. This is the currency code. A three character code in accordance with ISO 4217"
},
"clientSystemTransactionId": {
"type": "string",
"description": "[Length<=50] This is the merchant's own unique reference for the transaction"
},
"clientSystemInvoiceId": {
"type": "string",
"description": "[Length<=50] Required for AliPay/Wechat/Klarna, this is the clientSystemTransactionId from the original transaction"
},
"providerDiscretionaryData": {
"type": "string",
"description": "[Length<=50] This is the merchant's external facing order number with the consumer, which if supported, will be passed to the Provider as an additional descriptor."
},
"apmDetails": {
"properties": {
"apmProviderName": {
"type": "string",
"description": "This is the alternative payment method provider name. Refer to APM Providers under Elements"
},
"apmPayerAccountNumber": {
"type": "string",
"description": "[Length<=50] This is the unique account number of the payer for the chosen alternative payment method provider"
},
"apmPayerEmailAddress": {
"type": "string",
"description": "[Length<=255] This is the e-mail address of the payer for the chosen alternative payment method provider"
},
"apmBarQrCode": {
"type": "string",
"description": "[Length<=128] Required for AliPay/Wechat Sale transactions, this is the Bar or QR code scanned by the merchant device"
},
"apmOriginalAmount": {
"type": "string",
"description": "Required for AliPay/Wechat Refunds, this is the monetary value of the original transaction in minor units"
},
"apmProviderTransactionId": {
"type": "string",
"description": "[Length<=32] Required for AliPay/Wechat Refunds, this contains the Provider Transaction Id from the original transaction being refunded"
},
"apmScheme": {
"type": "string",
"description": "[Length<=6] Required for AliPay/Wechat Refunds"
}
},
"required": [
"apmProviderName",
"apmPayerAccountNumber",
"apmPayerEmailAddress",
"apmBarQrCode",
"apmOriginalAmount",
"apmProviderTransactionId"
],
"type": "object"
},
"details": {
"properties": {
"providerMerchantId": {
"type": "string",
"description": "[Length<=20] Optional for AliPay/Wechat, this is the Merchant Id that will be used when requesting authorization through the acquirer."
}
},
"required": [],
"type": "object"
},
"shoppingCartDetails": {
"properties": {
"itemDetails": {
"properties": {
"item": {
"properties": {
"productId": {
"type": "string",
"description": "[Length<=64] This is the client facing article number, SKU or similar.
Optional for Klarna"
},
"productName": {
"type": "string",
"description": "[Length<=100] This is the merchant's descriptive product name for the item line
Optional for Klarna"
},
"productDescription": {
"type": "string",
"description": "[Length<=100] This is the merchant's product description for the item line
Optional for Klarna"
},
"productType": {
"type": "string",
"description": "This is the type of product being sold for the item line
Supported values are \"physical\", \"digital\", \"giftCard\", \"surcharge\"
Optional for Klarna"
},
"productQuantity": {
"type": "integer",
"description": "[Length<=4] This is the quantity for the item line. Allowed values are 1-9999
Optional for Klarna",
"format": "int32"
},
"unitAmount": {
"type": "string",
"description": "This is the monetary value (Gross Amount) in minor units for the item line.
Must include tax if applicable, but exclude any discount
Optional for Klarna"
},
"unitTaxAmount": {
"type": "string",
"description": "This is the monetary value of the tax amount in minor units for the item line.
(Example: If the unitAmount is 20.00 and taxRate is 20%, then the unitTaxAmount would be 3.33 ) (((unitAmount/1.taxRate) - unitAmount) * -1)
Required if taxRate > 0 and unitAmount > 0
Conditional for Klarna"
},
"taxRate": {
"type": "string",
"description": "[Length<=5] This is the tax rate that that is being applied to the unitAmount for the item line.
(Example: VAT of 20% would mean a value of 20 being supplied)
If no tax applies, then send 0 or do not include this element
Conditional - Required if item.unitTaxAmount is supplied"
},
"totalAmount": {
"type": "string",
"description": "This is the monetary value of the total amount in minor units for the item line. ((unitAmount x productQuantity) - discountAmount)
Must include tax and any discount if applicable
(Example: If the unitAmount is 34.00, productQuantity is 2 and discountAmount is 5.00, then the totalAmount would be 63.00)
Optional for Klarna"
},
"totalTaxAmount": {
"type": "string",
"description": "This is the monetary value of the total tax amount in minor units for the item line. (totalAmount/1.taxRate) - totalAmount) * -1)
(Example: If the totalAmount is 63.00 and taxRate is 20%, then the totalTaxAmount would be 10.50 ) (((totalAmount/1.taxRate) - totalAmount) * -1)
Required if taxRate > 0"
},
"discountAmount": {
"type": "string",
"description": "This is the non-negative monetary value of the discount amount in minor units for the item line.
Optional for Klarna"
},
"discountName": {
"type": "string",
"description": "[Length<=100] This is the name of the discount or promotion being used for the item line.
Required if item.discountAmount > 0"
},
"discountTaxAmount": {
"type": "string",
"description": "This is the tax amount of the discount or promotion being used for the item line.
(Example: If the discountAmount is 5.00 and taxRate is 20%, then the discountTaxAmount would be 0.83 ) (((discountAmount/1.taxRate) - discountAmount) * -1)
Required if taxRate > 0 and discountAmount > 0"
}
},
"required": [],
"type": "object"
}
},
"required": [],
"type": "object"
},
"shippingDetails": {
"properties": {
"shippingName": {
"type": "string",
"description": "[Length<=100] This is the name of the Shipping service for the order (Example: DHL 24hr Next Day Express)
Required if shippingAmount > 0"
},
"shippingAmount": {
"type": "string",
"description": "This is the monetary value of the total shipping amount in minor units for the entire order."
},
"shippingTaxAmount": {
"type": "string",
"description": "This is the monetary value of the total shipping amount in minor units for the item line. (totalAmount * taxRate / 100)
(Example: If the shippingAmount is 5.00 and taxRate is 20%, then the shippingAmount would be 0.83 ) (((shippingAmount/1.taxRate) - shippingAmount) * -1)
Required if shippingTaxRate > 0 and shippingAmount > 0"
},
"shippingTaxRate": {
"type": "string",
"description": "[Length<=5] This is the tax rate that that is being applied to the shippingAmount for the entire order.
(Example: VAT of 20% would mean a value of 20 being supplied)"
}
},
"required": [],
"type": "object"
},
"discountDetails": {
"properties": {
"discount": {
"properties": {
"discountAmount": {
"type": "string",
"description": "This is the non-negative monetary value of the discount amount in minor units for the entire order.
Optional for Klarna"
},
"discountType": {
"type": "string",
"description": "This is the Type of the discount or promotion being used for the entire order.
Accepted values are discount, storeCredit and giftCard
Conditional - Required if discountDetails.discount.discountAmount is supplied"
},
"discountName": {
"type": "string",
"description": "[Length<=100] This is the Name of the discount or promotion being used for the entire order.
Conditional - Required if discountDetails.discount.discountAmount is supplied"
}
},
"required": [],
"type": "object"
}
},
"required": [],
"type": "object"
},
"totaltaxAmount": {
"type": "string",
"description": "This is the monetary value of the total tax amount in minor units for the entire order, including any shipping tax.
Sum of all itemDetails.item.totalTaxAmount already calculated at a per line level plus shippingTaxAmount)
Required if taxRate > 0 or shippingTaxRate > 0"
}
},
"required": [],
"type": "object"
}
}
},
"examples": {
"Paypal (Refund)": {
"value": {
"merchantId": "BDD",
"storeId": "BDD500000005",
"userId": "BDDTest",
"type": "ecom.refund",
"amount": "10.00",
"currencyCode": "GBP",
"clientSystemTransactionId": "UniqueTransactionRef01",
"apmDetails": {
"apmProviderName": "Paypal",
"apmPayerAccountNumber": "1ABCDEFGHIJKL",
"apmPayerEmailAddress": "joe_bloggs@testdomain.com"
}
}
},
"Alipay/Wechat (Refund)": {
"value": {
"merchantId": "BDD",
"storeId": "BDD500000005",
"userId": "BDDTest",
"type": "ecom.refund",
"amount": "10.00",
"currencyCode": "GBP",
"clientSystemTransactionId": "UniqueTransactionRef01",
"clientSystemInvoiceId": "UniqueGroupTransactionRef01",
"apmDetails": {
"apmProviderName": "Europass",
"apmBarQrCode": "5453535355665465644778999979799",
"apmOriginalAmount": "9.00",
"apmProviderTransactionId": "123456789",
"apmScheme": "Alipay"
},
"details": {
"ProviderMerchantId": "7623204161"
}
}
},
"Klarna (Capture)": {
"value": {
"merchantId": "BDD",
"storeId": "BDD500000005",
"userId": "BDDTest",
"type": "ecom.capture",
"amount": "112.61",
"currencyCode": "GBP",
"clientSystemInvoiceId": "UniqueTransactionRef1",
"clientSystemTransactionId": "UniqueTransactionRef1-capture",
"apmDetails": {
"apmProviderName": "klarna"
},
"shoppingCartDetails": {
"itemDetails": [
{
"productId": "ABC001",
"productName": "Blue Jeans",
"productDescription": "Stone Washed",
"productType": "physical",
"productQuantity": "1",
"unitAmount": "45.00",
"taxRate": "20.00",
"unitTaxAmount": "7.50",
"discountName": "10% Off Jeans",
"discountAmount": "4.50",
"discountTaxAmount": "0.75",
"totalAmount": "40.50",
"totalTaxAmount": "6.75"
},
{
"productId": "ABC002",
"productName": "Wooly Jumper",
"productDescription": "Black Cashmere",
"productType": "physical",
"productQuantity": "2",
"unitAmount": "34.00",
"taxRate": "20.00",
"unitTaxAmount": "5.67",
"discountName": "15% off Jumpers",
"discountAmount": "2.27",
"discountTaxAmount": "0.38",
"totalAmount": "65.73",
"totalTaxAmount": "10.96"
},
{
"productId": "ABC003",
"productName": "Kids T Shirt",
"productDescription": "White - Cartoon Print",
"productType": "physical",
"productQuantity": "1",
"unitAmount": "15.00",
"taxRate": "0",
"unitTaxAmount": "0",
"discountName": null,
"discountAmount": "0",
"discountTaxAmount": "0",
"totalAmount": "15.00",
"totalTaxAmount": "0"
}
],
"shippingDetails": {
"shippingName": "DHL Next Day Express",
"shippingAmount": "5.00",
"shippingTaxAmount": "0.83",
"shippingTaxRate": "20.00"
},
"discountDetails": [
{
"discountName": "5% Loyalty Discount",
"discountType": "discount",
"discountAmount": "12.62"
},
{
"discountName": "£1 Off Discount",
"discountType": "discount",
"discountAmount": "1.00"
}
],
"totaltaxAmount": "18.54"
}
}
},
"Klarna (Reversal)": {
"value": {
"merchantId": "BDD",
"storeId": "BDD500000005",
"userId": "BDDTest",
"type": "reversalPreAuthorization",
"amount": "112.61",
"currencyCode": "GBP",
"clientSystemInvoiceId": "UniqueTransactionRef1",
"clientSystemTransactionId": "UniqueTransactionRef1-reversal",
"apmDetails": {
"apmProviderName": "klarna"
}
}
},
"Klarna (Refund)": {
"value": {
"merchantId": "BDD",
"storeId": "BDD500000005",
"userId": "BDDTest",
"type": "ecom.refund",
"amount": "112.61",
"currencyCode": "GBP",
"clientSystemInvoiceId": "UniqueTransactionRef1",
"clientSystemTransactionId": "UniqueTransactionRef1-capture",
"providerDiscretionaryData": "ABC19642141",
"apmDetails": {
"apmProviderName": "klarna"
},
"shoppingCartDetails": {
"itemDetails": [
{
"productId": "ABC001",
"productName": "Blue Jeans",
"productDescription": "Stone Washed",
"productType": "physical",
"productQuantity": "1",
"unitAmount": "45.00",
"taxRate": "20.00",
"unitTaxAmount": "7.50",
"discountName": "10% Off Jeans",
"discountAmount": "4.50",
"discountTaxAmount": "0.75",
"totalAmount": "40.50",
"totalTaxAmount": "6.75"
},
{
"productId": "ABC002",
"productName": "Wooly Jumper",
"productDescription": "Black Cashmere",
"productType": "physical",
"productQuantity": "2",
"unitAmount": "34.00",
"taxRate": "20.00",
"unitTaxAmount": "5.67",
"discountName": "15% off Jumpers",
"discountAmount": "2.27",
"discountTaxAmount": "0.38",
"totalAmount": "65.73",
"totalTaxAmount": "10.96"
},
{
"productId": "ABC003",
"productName": "Kids T Shirt",
"productDescription": "White - Cartoon Print",
"productType": "physical",
"productQuantity": "1",
"unitAmount": "15.00",
"taxRate": "0",
"unitTaxAmount": "0",
"discountName": null,
"discountAmount": "0",
"discountTaxAmount": "0",
"totalAmount": "15.00",
"totalTaxAmount": "0"
}
],
"shippingDetails": {
"shippingName": "DHL Next Day Express",
"shippingAmount": "5.00",
"shippingTaxAmount": "0.83",
"shippingTaxRate": "20.00"
},
"discountDetails": [
{
"discountName": "5% Loyalty Discount",
"discountType": "discount",
"discountAmount": "12.62"
},
{
"discountName": "£1 Off Discount",
"discountType": "discount",
"discountAmount": "1.00"
}
],
"totaltaxAmount": "18.54"
}
}
},
"Klarna (Extend Authorization Time)": {
"value": {
"merchantId": "BDD",
"storeId": "BDD500000005",
"userId": "BDDTest",
"type": "ecom.extendAuth",
"amount": "112.61",
"currencyCode": "GBP",
"clientSystemInvoiceId": "UniqueTransactionRef1",
"clientSystemTransactionId": "UniqueTransactionRef1-extendAuth",
"apmDetails": {
"apmProviderName": "klarna"
}
}
},
"Bancontact (Refund)": {
"value": {
"merchantId": "BDD",
"storeId": "BDD500000005",
"userId": "BDDTest",
"type": "ecom.refund",
"amount": "100.00",
"currencyCode": "EUR",
"clientSystemInvoiceId": "UniqueTransactionRef1",
"clientSystemTransactionId": "UniqueTransactionRef1-Refund",
"providerDiscretionaryData": "ABC19642141",
"apmDetails": {
"apmProviderName": "bancontact"
}
}
},
"iDeal (Refund)": {
"value": {
"merchantId": "BDD",
"storeId": "BDD500000005",
"userId": "BDDTest",
"type": "ecom.refund",
"amount": "100.00",
"currencyCode": "EUR",
"clientSystemInvoiceId": "OriginalTransactionRef01",
"clientSystemTransactionId": "UniqueTransactionRef01-Refund",
"providerDiscretionaryData": "ABC19642141",
"apmDetails": {
"apmProviderName": "iDeal"
}
}
},
"GiroPay (Refund)": {
"value": {
"merchantId": "BDD",
"storeId": "BDD500000005",
"userId": "BDDTest",
"type": "ecom.refund",
"amount": "100.00",
"currencyCode": "EUR",
"clientSystemInvoiceId": "OriginalTransactionRef01",
"clientSystemTransactionId": "UniqueTransactionRef01-Refund",
"providerDiscretionaryData": "ABC19642141",
"apmDetails": {
"apmProviderName": "giroPay"
}
}
},
"Trustly (Refund)": {
"value": {
"merchantId": "BDD",
"storeId": "BDD500000005",
"userId": "BDDTest",
"type": "ecom.refund",
"amount": "100.00",
"currencyCode": "GBP",
"clientSystemInvoiceId": "OriginalTransactionRef01",
"clientSystemTransactionId": "UniqueTransactionRef01-Refund",
"providerDiscretionaryData": "ABC19642141",
"apmDetails": {
"apmProviderName": "trustly"
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "200",
"content": {
"application/json": {
"examples": {
"Paypal": {
"value": "{\n \"id\": \"57bc8107-0482-488d-8c0c-5021042124f2\",\n \"state\": \"Authorised\",\n \"providerStateCode\": \"AuthorisedByProvider\",\n \"currencyCode\": \"GBP\",\n \"apmDetails\": {\n \"apmProviderName\": \"Paypal\",\n \"apmPayerAccountNumber\": \"1ABCDEFGHIJKL\",\n \"apmPayerEmailAddress\": \"joe_bloggs@testdomain.com\"\n }\n}"
},
"Alipay/Wechat": {
"value": "{\n \"id\": \"57bc8107-0482-488d-8c0c-5021042124f2\",\n \"state\": \"Authorised\",\n \"providerStateCode\": \"AuthorisedByProvider\",\n \"currencyCode\": \"GBP\",\n \"apmDetails\": {\n \"apmProviderName\": \"EuroPass\",\n \"apmScheme\" : \"Alipay\",\n \"apmProviderTransactionId\" : \"4324522352\",\n \"apmSchemeTransactionId\" : \"3123123434\",\n \"apmProviderRefundId\" : \"5455346422322\"\n },\n \"details\": {\n \"providerMerchantId\": \"542929008043127\",\n \"providerTerminalId\": \"00630376\"\n }\n}"
},
"Klarna (Capture)": {
"value": "{\n \"id\": \"57bc8107-0482-488d-8c0c-5021042124f2\",\n \"state\": \"Authorised\",\n \"providerStateCode\": \"PendingToBeCaptured\",\n \"currencyCode\": \"GBP\",\n \"clientSystemTransactionId\": \"UniqueTransactionRef01\",\n \"apmDetails\": {\n \"apmProviderName\": \"Klarna\",\n \"apmPaymentMethod\": \"KlarnaFinancingCapture\"\n }\n}"
},
"Klarna (Reversal)": {
"value": "{\n \"id\": \"57bc8107-0482-488d-8c0c-5021042124f2\",\n \"state\": \"Reversed\",\n \"providerStateCode\": \"Cancelled\",\n \"currencyCode\": \"GBP\",\n \"clientSystemTransactionId\": \"UniqueTransactionRef01\",\n \"apmDetails\": {\n \"apmProviderName\": \"Klarna\",\n \"apmPaymentMethod\": \"KlarnaCancellation\"\n }\n}"
},
"Klarna (Refund)": {
"value": "{\n \"id\": \"57bc8107-0482-488d-8c0c-5021042124f2\",\n \"state\": \"Authorised\",\n \"providerStateCode\": \"Refunded\",\n \"currencyCode\": \"GBP\",\n \"clientSystemTransactionId\": \"UniqueTransactionRef01\", \n \"apmDetails\": {\n \"apmProviderName\": \"Klarna\",\n \"apmPaymentMethod\": \"KlarnaRefund\"\n }\n}"
},
"Klarna (Extend Authorization Time)": {
"value": "{\n \"id\": \"57bc8107-0482-488d-8c0c-5021042124f2\",\n \"state\": \"Authorised\",\n \"providerStateCode\": \"AuthorizationExtended\",\n \"currencyCode\": \"GBP\",\n \"clientSystemTransactionId\": \"UniqueTransactionRef01\", \n \"apmDetails\": {\n \"apmProviderName\": \"Klarna\",\n \"apmPaymentMethod\": \"KlarnaPayNowDeposit\"\n }\n}"
},
"Bancontact (Refund)": {
"value": "{\n \"id\": \"a00343e9-15f3-48de-ad4b-49960cc5aa57\",\n \"state\": \"Authorised\",\n \"providerStateCode\": \"0\",\n \"providerStateMessage\": \"Approved or completed successfully\",\n \"currencyCode\": \"EUR\",\n \"accountDetails\": {\n \"cardNumber\": \"411111******1517\"\n },\n \"stateDetails\": {\n \"approvalCode\": \"203415\"\n },\n \"cardSecurityResponseCode\": \"0\",\n \"addressVerificationResponseCode\": \"0\"\n}\n"
},
"iDeal/GiroPay (Refund)": {
"value": "{\n \"id\": \"57bc8107-0482-488d-8c0c-5021042124f2\",\n \"state\": \"Approved\",\n \"providerStateCode\": \"WithdrawnByProvider\",\n \"currencyCode\": \"EUR\",\n \"clientSystemTransactionId\": \"UniqueTransactionRef01-Refund\",\n \"apmDetails\": {\n \"apmProviderName\": \"PXP Financial\",\n \"apmPaymentMethod\": \"BankTransferWithdrawal\"\n }\n}\n"
},
"Trustly (Refund)": {
"value": "{\n \"id\": \"57bc8107-0482-488d-8c0c-5021042124f2\",\n \"state\": \"Approved\",\n \"providerStateCode\": \"Refunded\",\n \"currencyCode\": \"GBP\",\n \"clientSystemTransactionId\": \"UniqueTransactionRef01\",\n \"apmDetails\": {\n\t\t\t\t\"apmProviderName\": \"Trustly\",\n \"apmPaymentMethod\": \"TrustlyInstantBankRefund\",\n }\n}"
}
},
"schema": {
"oneOf": [
{
"title": "Paypal",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "57bc8107-0482-488d-8c0c-5021042124f2"
},
"state": {
"type": "string",
"example": "Authorised"
},
"providerStateCode": {
"type": "string",
"example": "AuthorisedByProvider"
},
"currencyCode": {
"type": "string",
"example": "GBP"
},
"apmDetails": {
"type": "object",
"properties": {
"apmProviderName": {
"type": "string",
"example": "Paypal"
},
"apmPayerAccountNumber": {
"type": "string",
"example": "1ABCDEFGHIJKL"
},
"apmPayerEmailAddress": {
"type": "string",
"example": "joe_bloggs@testdomain.com"
}
}
}
}
},
{
"title": "Alipay/Wechat",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "57bc8107-0482-488d-8c0c-5021042124f2"
},
"state": {
"type": "string",
"example": "Authorised"
},
"providerStateCode": {
"type": "string",
"example": "AuthorisedByProvider"
},
"currencyCode": {
"type": "string",
"example": "GBP"
},
"apmDetails": {
"type": "object",
"properties": {
"apmProviderName": {
"type": "string",
"example": "EuroPass"
},
"apmScheme": {
"type": "string",
"example": "Alipay"
},
"apmProviderTransactionId": {
"type": "string",
"example": "4324522352"
},
"apmSchemeTransactionId": {
"type": "string",
"example": "3123123434"
},
"apmProviderRefundId": {
"type": "string",
"example": "5455346422322"
}
}
},
"details": {
"type": "object",
"properties": {
"providerMerchantId": {
"type": "string",
"example": "542929008043127"
},
"providerTerminalId": {
"type": "string",
"example": "00630376"
}
}
}
}
},
{
"title": "Klarna (Capture)",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "57bc8107-0482-488d-8c0c-5021042124f2"
},
"state": {
"type": "string",
"example": "Authorised"
},
"providerStateCode": {
"type": "string",
"example": "PendingToBeCaptured"
},
"currencyCode": {
"type": "string",
"example": "GBP"
},
"clientSystemTransactionId": {
"type": "string",
"example": "UniqueTransactionRef01"
},
"apmDetails": {
"type": "object",
"properties": {
"apmProviderName": {
"type": "string",
"example": "Klarna"
},
"apmPaymentMethod": {
"type": "string",
"example": "KlarnaFinancingCapture"
}
}
}
}
},
{
"title": "Klarna (Reversal)",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "57bc8107-0482-488d-8c0c-5021042124f2"
},
"state": {
"type": "string",
"example": "Reversed"
},
"providerStateCode": {
"type": "string",
"example": "Cancelled"
},
"currencyCode": {
"type": "string",
"example": "GBP"
},
"clientSystemTransactionId": {
"type": "string",
"example": "UniqueTransactionRef01"
},
"apmDetails": {
"type": "object",
"properties": {
"apmProviderName": {
"type": "string",
"example": "Klarna"
},
"apmPaymentMethod": {
"type": "string",
"example": "KlarnaCancellation"
}
}
}
}
},
{
"title": "Klarna (Refund)",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "57bc8107-0482-488d-8c0c-5021042124f2"
},
"state": {
"type": "string",
"example": "Authorised"
},
"providerStateCode": {
"type": "string",
"example": "Refunded"
},
"currencyCode": {
"type": "string",
"example": "GBP"
},
"clientSystemTransactionId": {
"type": "string",
"example": "UniqueTransactionRef01"
},
"apmDetails": {
"type": "object",
"properties": {
"apmProviderName": {
"type": "string",
"example": "Klarna"
},
"apmPaymentMethod": {
"type": "string",
"example": "KlarnaRefund"
}
}
}
}
},
{
"title": "Klarna (Extend Authorization Time)",
"type": "object",
"properties": {
"id": {
"type": "string",
"example": "57bc8107-0482-488d-8c0c-5021042124f2"
},
"state": {
"type": "string",
"example": "Authorised"
},
"providerStateCode": {
"type": "string",
"example": "AuthorizationExtended"
},
"currencyCode": {
"type": "string",
"example": "GBP"
},
"clientSystemTransactionId": {
"type": "string",
"example": "UniqueTransactionRef01"
},
"apmDetails": {
"type": "object",
"properties": {
"apmProviderName": {
"type": "string",
"example": "Klarna"
},
"apmPaymentMethod": {
"type": "string",
"example": "KlarnaPayNowDeposit"
}
}
}
}
}
]
}
}
}
},
"412": {
"description": "412",
"content": {
"application/json": {
"examples": {
"Result": {
"value": "{\n \"code\": \"4021840\",\n \"details\": {\n \"message\": \"Error getting customer site for site no 1\"\n }\n}"
}
},
"schema": {
"type": "object",
"properties": {
"code": {
"type": "string",
"example": "4021840"
},
"details": {
"type": "object",
"properties": {
"message": {
"type": "string",
"example": "Error getting customer site for site no 1"
}
}
}
}
}
}
}
}
},
"deprecated": false,
"security": []
}
}
},
"x-readme": {
"headers": [
{
"key": "Authorization",
"value": "Basic QkREVGVzdDpCRERUZXN0"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"explorer-enabled": true,
"proxy-enabled": true
},
"x-readme-fauxas": true
}
```