Download OpenAPI specification:Download
Management API provides comprehensive capabilities for managing partner accounts and their associated data. It allows for full control over data objects within an account, enabling the creation, updating, and deletion of resources as needed.
Create a new API-key credential
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Credential created
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "description": "Production API Credentials"
}{- "credential_id": "krn:partner:global:live:credential:api:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "description": "Production API Credentials",
- "type": "API",
- "environment": "LIVE",
- "secret": {
- "secret": "klarna_live_api_a1234567N243N1htM05kRDhaA35DFzUoMz9MbXhwT1gsYWFhNWN331hNzEtODgzZC00NWMzLTlkNDAtMzA3NGI3ODgzYWMwLDEsUldMdWs522d5621tuelJIVXV5S1FTVldRM21rVitEUVNONjBwY3F238def223fs2G"
}, - "status": "ENABLED"
}List all credentials associated with the current account
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Credentials found
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "credentials": [
- {
- "credential_id": "krn:partner:global:test:credential:api:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "status": "ENABLED",
- "description": "Test API Credentials",
- "type": "API",
- "environment": "TEST"
}
]
}Read all details from a Credential
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Credential details
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "credential_id": "krn:partner:global:test:credential:api:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "status": "ENABLED",
- "description": "Test API Credentials",
- "type": "API",
- "environment": "TEST"
}Update details of a Credential.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Credential was updated successfully
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "description": "Test API Credentials"
}{- "credential_id": "krn:partner:global:live:credential:api:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "status": "ENABLED",
- "description": "Test API Credentials",
- "type": "API",
- "environment": "TEST"
}Disable a Credential.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Credential deactivated with success
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "error_id": "5a3f6b9c-9b3b-4b7e-8f9d-9b9a4b9a4b9a",
- "error_type": "INPUT_ERROR",
- "error_code": "INVALID_CONTENT_TYPE",
- "error_message": "The received input is not valid JSON.\nUnterminated string at 19 [character 20 line 1].\n"
}Create a new credential
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Credential created
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "description": "Production Client Identifier"
}{- "credential_id": "krn:partner:global:live:credential:client:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "identity": {
- "client_id": "klarna_live_client_eW91ci1zZWQw4efyD3f5LEs0NDQ0NF8xMjM0NTUsMSxVeHk1M2xlYXh4YmZ3Mm9UcklUdGMxc0sxanI1eABCDElEK2ZoYkRtTHVnPQ"
}, - "status": "ENABLED",
- "description": "Production Client Identifier",
- "type": "CLIENT",
- "environment": "LIVE"
}List all credentials associated with the current account
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Credentials found
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "credentials": [
- {
- "credential_id": "krn:partner:global:test:credential:client:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "identity": {
- "client_id": "klarna_test_client_eW91ci1zZWQw4efyD3f5LEs0NDQ0NF8xMjM0NTUsMSxVeHk1M2xlYXh4YmZ3Mm9UcklUdGMxc0sxanI1eABCDElEK2ZoYkRtTHVnPQ"
}, - "status": "ENABLED",
- "description": "Test Client ID Credentials",
- "type": "CLIENT",
- "environment": "TEST"
}
]
}Read all details from a Credential
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Credential details
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "credential_id": "krn:partner:global:test:credential:client:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "identity": {
- "client_id": "klarna_test_client_eW91ci1zZWQw4efyD3f5LEs0NDQ0NF8xMjM0NTUsMSxVeHk1M2xlYXh4YmZ3Mm9UcklUdGMxc0sxanI1eABCDElEK2ZoYkRtTHVnPQ"
}, - "status": "ENABLED",
- "description": "Test Client ID credential",
- "type": "CLIENT",
- "environment": "TEST"
}Update details of a Credential.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Credential was updated successfully
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "description": "Test API Credentials"
}{- "credential_id": "krn:partner:global:test:credential:client:120e5b7e-dee8-43ca-9858-dca726e639b5",
- "identity": {
- "client_id": "klarna_test_client_eW91ci1zZWQw4efyD3f5LEs0NDQ0NF8xMjM0NTUsMSxVeHk1M2xlYXh4YmZ3Mm9UcklUdGMxc0sxanI1eABCDElEK2ZoYkRtTHVnPQ"
}, - "status": "ENABLED",
- "description": "Test Client ID credential",
- "type": "CLIENT",
- "environment": "TEST"
}Disable a Credential.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Credential deactivated with success
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "error_id": "5a3f6b9c-9b3b-4b7e-8f9d-9b9a4b9a4b9a",
- "error_type": "INPUT_ERROR",
- "error_code": "INVALID_CONTENT_TYPE",
- "error_message": "The received input is not valid JSON.\nUnterminated string at 19 [character 20 line 1].\n"
}Revokes a client certificate
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Client certificate revoked
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "revoked_from": "2021-12-31T23:59:59Z"
}{- "credential_id": "krn:partner:global:live:credential:client_cert:2C8A1053F979D1E8C96A3A9357AE7D1E",
- "description": "Live client certificate",
- "type": "CLIENT_CERT",
- "environment": "LIVE",
- "identity": {
- "serial_number": "2C8A1053F979D1E8C96A3A9357AE7D1E"
}, - "config": {
- "expiration_date": "2019-08-24T14:15:22Z",
- "revoked_from": "2021-12-31T23:59:59Z",
- "usage": "MTLS",
- "certificate_state": "REVOKED"
}, - "status": "DISABLED"
}A Payment Profile represents a combination of a price plan and a payment program. It can be used by Acquiring Partners during onboarding of sub-partners to attach the configuration to the payment product.
Fetches all payments profiles. The payment profiles returned may be used during onboarding to attach configuration to a payment product.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
List of Payment Profiles
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
[- {
- "payment_profile_id": "krn:partner:global:account:distribution-profile:206bbb83-9b6e-46fa-940d-337153c04a58",
- "price_plan_id": "krn:partner:global:payment:price-plan:171080e7-2637-4675-a224-ec032723ebdf"
}
]The onboard API allows the authenticated Account to create a fully functional account with associated business entity, product, stores etc.
Onboard a new merchant. This request creates all necessary entries to have a fully functional account for the merchant.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Merchant account created
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "partner_account_reference": "M123786123412",
- "partner_account_name": "John Doe Stakehouse",
- "partner_account_contact": {
- "given_name": "John",
- "family_name": "Doe",
- "email": "john.doe@example.com",
- "phone": "+18445527621"
}, - "products": [
- {
- "type": "PAYMENT",
- "payment_profile_id": "krn:partner:global:account:payment-profile:206bbb83-9b6e-46fa-940d-337153c04a58",
- "payment_accounts": [
- {
- "payment_account_reference": "REF995847",
- "default_store_group_reference": "ALL_STORES",
- "default_merchant_category_code": "4812",
- "partner_business_entity_reference": "LE_US002"
}
]
}
], - "brands": [
- {
- "display_name": "My Branding DE",
- "brand_reference": "BRAND001"
}
], - "store_groups": [
- {
- "store_group_reference": "ALL_STORES",
- "brand_reference": "BRAND001",
}
], - "partner_business_entities": [
- {
- "partner_business_entity_reference": "LE_US002",
- "legal_registered_entity_name": "Legal Entity LLC",
- "legal_registration_country": "US",
- "enabled_merchant_category_codes": [
- "5411"
]
}
]
}{- "partner_account_id": "krn:partner:global:account:live:LWT2XJSE",
- "partner_account_reference": "M123786123412",
- "partner_account_name": "Merchant ABC US",
- "state": "PARTIALLY_OPERATIONAL",
- "state_reason": "INITIAL_SETUP"
}The webhook is triggered once the distribution partner's account state changes.
{- "metadata": {
- "event_type": "partner.account.state-change.operational",
- "event_id": "d9f9b1a0-5b1a-4b0e-9b0a-9e9b1a0d5b1a",
- "event_version": "v2",
- "occurred_at": "2024-01-01T12:00:00Z",
- "correlation_id": "2d1557e8-17c3-466c-924a-bbc3e91c2a02",
- "recipient_account_id": "krn:partner:account:live:2AIMNWR6IYZVD",
- "subject_account_id": "krn:partner:account:live:2AIMNWR6IYZVD",
- "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918",
- "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5",
- "live": true
}, - "payload": {
- "account_reference": "M123786123412",
- "state": "OPERATIONAL",
- "previous_state": "PARTIALLY_OPERATIONAL"
}
}Onboard an existing merchant to Management API. This request overwrites all existing data with the new data provided.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Merchant account created
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "partner_account_reference": "M123786123412",
- "partner_account_name": "John Doe Stakehouse",
- "partner_account_contact": {
- "given_name": "John",
- "family_name": "Doe",
- "email": "john.doe@example.com",
- "phone": "+18445527621"
}, - "products": [
- {
- "type": "PAYMENT",
- "merchant_id": "K123456",
- "payment_accounts": [
- {
- "payment_account_reference": "REF995847",
- "payment_acquiring_account_id": "krn:partner:global:payment-acquiring-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b",
- "default_store_group_reference": "STORE_NY004",
- "default_merchant_category_code": "4812",
- "partner_business_entity_reference": "LE_US002"
}
]
}
], - "brands": [
- {
- "display_name": "My Branding DE",
- "element": {
}
}
], - "partner_business_entities": [
- {
- "partner_business_entity_reference": "LE_US002",
- "legal_registered_entity_name": "Legal Entity LLC",
- "legal_registration_country": "US",
- "enabled_merchant_category_codes": [
- "5411"
]
}
]
}
{- "partner_account_id": "krn:partner:global:account:live:LWT2XJSE",
- "partner_account_reference": "M123786123412",
- "partner_account_name": "Merchant ABC US",
- "state": "PARTIALLY_OPERATIONAL",
- "state_reason": "INITIAL_SETUP"
}The webhook is triggered once the distribution partner's account state changes.
{- "metadata": {
- "event_type": "partner.account.state-change.operational",
- "event_id": "d9f9b1a0-5b1a-4b0e-9b0a-9e9b1a0d5b1a",
- "event_version": "v2",
- "occurred_at": "2024-01-01T12:00:00Z",
- "correlation_id": "2d1557e8-17c3-466c-924a-bbc3e91c2a02",
- "recipient_account_id": "krn:partner:account:live:2AIMNWR6IYZVD",
- "subject_account_id": "krn:partner:account:live:2AIMNWR6IYZVD",
- "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918",
- "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5",
- "live": true
}, - "payload": {
- "account_reference": "M123786123412",
- "state": "OPERATIONAL",
- "previous_state": "PARTIALLY_OPERATIONAL"
}
}The Accounts API allows the authenticated Partner to create, read, manage the different Accounts it has access to. Partner Accounts represent a specific company that may have access to Klarna's products. It is used to calculate authorization for every operation, and groups all objects created for that company under a single entry-point.
Read all details from a given Partner Account which the acting Account has read access on.
Optionally, include additional sub-resources in the response by using the expand query parameter. The expand parameter accepts a comma-separated list of supported sub-resource names. Each specified sub-resource will be included in the response if available. Maximum of 10 sub-resources can be expanded per request.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Account details
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "partner_account_id": "krn:partner:global:account:live:LWT2XJSE",
- "partner_account_reference": "M123786123412",
- "partner_account_name": "Merchant ABC US",
- "partner_account_contact": {
- "given_name": "John",
- "family_name": "Doe",
- "email": "john.doe@klarna.com",
- "phone": "+18445527621"
}, - "products": [
- {
- "product_id": "krn:partner:global:account:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918",
- "type": "PAYMENT",
- "partner_business_entity_id": "krn:partner:accounts:partner-business-entity:206bbb83-9b6e-46fa-940d-337153c04a58",
- "payment_profile_id": "krn:partner:global:account:payment-profile:206bbb83-9b6e-46fa-940d-337153c04a58",
- "payment_accounts": [
- {
- "payment_account_id": "krn:partner:global:payment-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b",
- "status": "ENABLED",
- "payment_account_reference": "payment_account_ref",
- "default_merchant_category_code": "5411"
}
], - "state": "ENABLED",
- "state_reason": "APPROVED"
}
], - "state": "OPERATIONAL",
- "state_reason": "SETUP_COMPLETE",
- "partner_business_entities": [
- {
- "partner_business_entity_id": "krn:partner:accounts:partner-business-entity:206bbb83-9b6e-46fa-940d-337153c04a58",
- "partner_business_entity_reference": "business_entity_1",
- "legal_registered_entity_name": "Legal Entity LLC",
- "legal_registration_country": "US",
- "enabled_merchant_category_codes": [
- "5411"
], - "supplementary_business_data": {
- "legal_registration": {
- "legal_registration_number": "HRA 123456",
- "legal_registration_authority": "Aachen",
- "legal_registration_entity_type": "SOLE_TRADER",
- "tax_registration_number": "123-456-789",
- "financial_conduct_authority_number": "987-654-321",
- "legal_registration_address": {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}
}, - "operating_addresses": [
- {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}
], - "stakeholders": [
- {
- "given_name": "John",
- "family_name": "Doe",
- "address": {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}, - "date_of_birth": "1970-01-01",
- "national_identification": {
- "number": "123-456-7890",
- "country": "US"
}, - "roles": [
- "OWNER"
]
}
], - "partner_payouts_state": {
- "payouts_status": "ENABLED",
- "payouts_enabled_at": "2024-01-01T12:00:00Z",
- "payouts_delay_days": 0,
- "bank_accounts": [
- {
- "bank_account_type": "IBAN",
- "account_holder": "John Doe Stakehouse",
- "bic": "NDEASEGGXXX",
- "iban": "SE4550000000058398257466"
}
]
}
}
}
], - "brands": [
- {
- "brand_id": "krn:partner:global:account:brand:88c175c8-b578-4392-8e61-015c1b5df613",
- "display_name": "My Branding DE",
- "brand_reference": "My_Branding_Ref_DE",
- "element": {
- "logo_url": "string",
- "icon_url": "string",
- "feature_image_url": "string"
}
}
], - "store_groups": [
- {
- "store_group_id": "krn:partner:global:account:store-groups:88c175c8-b578-4392-8e61-015c1b5df613",
- "store_group_reference": "store_group_1",
- "support_contact": {
- "email": "john.doe@example.com",
- "phone": "+18445527621",
}, - "social_media_links": [
],
}
]
}Update details from an Partner Account which the acting Account has write access on.
May receive nested objects as part of this request, which will result in an asyncronous operation, moving the status of the account to PARTIALLY_OPERATIONAL until all updates are completed.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Account details
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "partner_account_reference": "M123786123412",
- "partner_account_name": "Merchant ABC US",
- "partner_account_contact": {
- "given_name": "John",
- "family_name": "Doe",
- "email": "john.doe@klarna.com",
- "phone": "+18445527621"
}
}{- "partner_account_id": "krn:partner:global:account:live:LWT2XJSE",
- "partner_account_reference": "M123786123412",
- "partner_account_name": "John Doe Stakehouse",
- "partner_account_contact": {
- "given_name": "John",
- "family_name": "Doe",
- "email": "john.doe@example.com",
- "phone": "+18445527621"
}, - "state": "PARTIALLY_OPERATIONAL",
- "state_reason": "ACCOUNT_UPDATE"
}The Partner Business Entities API allows the authenticated Partner to read the Partner Business Entities connected to a Partner Account. A Partner Business Entity represent an specific business that is utilizing Klarna's Products, and it's associated with an specific registered legal entity.
Lists all partner business entities available under an account
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
A paginated collection of partner business entities
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "partner_business_entities": [
- {
- "partner_business_entity_id": "krn:partner:accounts:partner-business-entity:206bbb83-9b6e-46fa-940d-337153c04a58",
- "partner_business_entity_reference": "business_entity_1",
- "legal_registered_entity_name": "Legal Entity LLC",
- "legal_registration_country": "US",
- "enabled_merchant_category_codes": [
- "5411"
], - "supplementary_business_data": {
- "legal_registration": {
- "legal_registration_number": "HRA 123456",
- "legal_registration_authority": "Aachen",
- "legal_registration_entity_type": "SOLE_TRADER",
- "tax_registration_number": "123-456-789",
- "financial_conduct_authority_number": "987-654-321",
- "legal_registration_address": {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}
}, - "operating_addresses": [
- {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}
], - "stakeholders": [
- {
- "given_name": "John",
- "family_name": "Doe",
- "address": {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}, - "date_of_birth": "1970-01-01",
- "national_identification": {
- "number": "123-456-7890",
- "country": "US"
}, - "roles": [
- "OWNER"
]
}
], - "partner_payouts_state": {
- "payouts_status": "ENABLED",
- "payouts_enabled_at": "2024-01-01T12:00:00Z",
- "payouts_delay_days": 0,
- "bank_accounts": [
- {
- "bank_account_type": "IBAN",
- "account_holder": "John Doe Stakehouse",
- "bic": "NDEASEGGXXX",
- "iban": "SE4550000000058398257466"
}
]
}
}
}
], - "pagination": {
- "last_item": "Fvt0G2tMGTuGx",
- "first_item": "Bxp4Z3sWFXmKq",
- "count": 20,
- "total": 1025,
- "_links": {
- "next": {
- "method": "GET",
- "rel": "Get the next page of results"
}, - "prev": {
- "method": "GET",
- "rel": "Get the next page of results"
}
}
}
}Obtain information about a specific Partner Business Entity
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
The partner business entity with the given ID was found and retrieved
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "partner_business_entity_id": "krn:partner:accounts:partner-business-entity:206bbb83-9b6e-46fa-940d-337153c04a58",
- "partner_business_entity_reference": "business_entity_1",
- "legal_registered_entity_name": "Legal Entity LLC",
- "legal_registration_country": "US",
- "enabled_merchant_category_codes": [
- "5411"
], - "supplementary_business_data": {
- "legal_registration": {
- "legal_registration_number": "HRA 123456",
- "legal_registration_authority": "Aachen",
- "legal_registration_entity_type": "SOLE_TRADER",
- "tax_registration_number": "123-456-789",
- "financial_conduct_authority_number": "987-654-321",
- "legal_registration_address": {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}
}, - "operating_addresses": [
- {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}
], - "stakeholders": [
- {
- "given_name": "John",
- "family_name": "Doe",
- "address": {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}, - "date_of_birth": "1970-01-01",
- "national_identification": {
- "number": "123-456-7890",
- "country": "US"
}, - "roles": [
- "OWNER"
]
}
], - "partner_payouts_state": {
- "payouts_status": "ENABLED",
- "payouts_enabled_at": "2024-01-01T12:00:00Z",
- "payouts_delay_days": 0,
- "bank_accounts": [
- {
- "bank_account_type": "IBAN",
- "account_holder": "John Doe Stakehouse",
- "bic": "NDEASEGGXXX",
- "iban": "SE4550000000058398257466"
}
]
}
}
}Update a specific Partner Business Entity
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
object (SupplementaryBusinessData) Supplementary business information that might be relevant for fraud detection purposes validation-info: tbd |
The partner business entity was updated
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "supplementary_business_data": {
- "legal_registration": {
- "legal_registration_number": "HRA 123456",
- "legal_registration_authority": "Aachen",
- "legal_registration_entity_type": "SOLE_TRADER",
- "tax_registration_number": "123-456-789",
- "financial_conduct_authority_number": "987-654-321",
- "legal_registration_address": {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}
}, - "operating_addresses": [
- {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}
], - "stakeholders": [
- {
- "given_name": "John",
- "family_name": "Doe",
- "address": {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}, - "date_of_birth": "1970-01-01",
- "national_identification": {
- "number": "123-456-7890",
- "country": "US"
}, - "roles": [
- "OWNER"
]
}
], - "partner_payouts_state": {
- "payouts_status": "ENABLED",
- "payouts_enabled_at": "2024-01-01T12:00:00Z",
- "payouts_delay_days": 0,
- "bank_accounts": [
- {
- "bank_account_type": "IBAN",
- "account_holder": "John Doe Stakehouse",
- "bic": "NDEASEGGXXX",
- "iban": "SE4550000000058398257466"
}
]
}
}
}{- "partner_business_entity_id": "krn:partner:accounts:partner-business-entity:206bbb83-9b6e-46fa-940d-337153c04a58",
- "partner_business_entity_reference": "business_entity_1",
- "legal_registered_entity_name": "Legal Entity LLC",
- "legal_registration_country": "US",
- "enabled_merchant_category_codes": [
- "5411"
], - "supplementary_business_data": {
- "legal_registration": {
- "legal_registration_number": "HRA 123456",
- "legal_registration_authority": "Aachen",
- "legal_registration_entity_type": "SOLE_TRADER",
- "tax_registration_number": "123-456-789",
- "financial_conduct_authority_number": "987-654-321",
- "legal_registration_address": {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}
}, - "operating_addresses": [
- {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}
], - "stakeholders": [
- {
- "given_name": "John",
- "family_name": "Doe",
- "address": {
- "street_address": "800 N. High St",
- "street_address2": "Ste. 400",
- "postal_code": "43215",
- "city": "Columbus",
- "region": "US-OH",
- "country": "US"
}, - "date_of_birth": "1970-01-01",
- "national_identification": {
- "number": "123-456-7890",
- "country": "US"
}, - "roles": [
- "OWNER"
]
}
], - "partner_payouts_state": {
- "payouts_status": "ENABLED",
- "payouts_enabled_at": "2024-01-01T12:00:00Z",
- "payouts_delay_days": 0,
- "bank_accounts": [
- {
- "bank_account_type": "IBAN",
- "account_holder": "John Doe Stakehouse",
- "bic": "NDEASEGGXXX",
- "iban": "SE4550000000058398257466"
}
]
}
}
}A Brand is is the set of names, logos and colors that facilitate communication and marketing towards consumers for a given company or merchant.
Lists all brands available under an account
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
A paginated collection of brands
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "brands": [
- {
- "brand_id": "krn:partner:global:account:brand:88c175c8-b578-4392-8e61-015c1b5df613",
- "display_name": "My Branding DE",
- "brand_reference": "My_Branding_Ref_DE",
- "element": {
- "logo_url": "string",
- "icon_url": "string",
- "feature_image_url": "string"
}
}
], - "pagination": {
- "last_item": "Fvt0G2tMGTuGx",
- "first_item": "Bxp4Z3sWFXmKq",
- "count": 20,
- "total": 1025,
- "_links": {
- "next": {
- "method": "GET",
- "rel": "Get the next page of results"
}, - "prev": {
- "method": "GET",
- "rel": "Get the next page of results"
}
}
}
}Obtain information about a specific Brand
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
The brand with the given ID was found and returned
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "brand_id": "krn:partner:global:account:brand:88c175c8-b578-4392-8e61-015c1b5df613",
- "display_name": "My Branding DE",
- "brand_reference": "My_Branding_Ref_DE",
- "element": {
- "logo_url": "string",
- "icon_url": "string",
- "feature_image_url": "string"
}
}Update a specific Brand
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
The brand was updated
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "display_name": "My Branding DE",
- "brand_reference": "My_Branding_Ref_DE",
- "element": {
- "logo_url": "string",
- "icon_url": "string",
- "feature_image_url": "string"
}
}{- "brand_id": "krn:partner:global:account:brand:88c175c8-b578-4392-8e61-015c1b5df613",
- "display_name": "My Branding DE",
- "brand_reference": "My_Branding_Ref_DE",
- "element": {
- "logo_url": "string",
- "icon_url": "string",
- "feature_image_url": "string"
}
}A Store represents where, physically or digital, a Klarna product is used. Although right now only websites are supported, in the future physical addresses and mobile apps may be used.
Lists all stores available under an account
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
A paginated collection of stores
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "stores": [
- {
- "store_group_id": "krn:partner:global:account:stores:88c175c8-b578-4392-8e61-015c1b5df613",
- "type": "WEBSITE",
- "store_reference": "999888777",
}
], - "pagination": {
- "last_item": "Fvt0G2tMGTuGx",
- "first_item": "Bxp4Z3sWFXmKq",
- "count": 20,
- "total": 1025,
- "_links": {
- "next": {
- "method": "GET",
- "rel": "Get the next page of results"
}, - "prev": {
- "method": "GET",
- "rel": "Get the next page of results"
}
}
}
}Obtain information about a specific Store
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
The store with the given ID was found and returned
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
Update a specific Store
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
The store was updated
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
A Store Group allows multiple stores to share configuration information such as support contacts, social media links and brands.
Lists all store groups available under an account
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
A paginated collection of store groups
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "store_groups": [
- {
- "store_group_id": "krn:partner:global:account:store-groups:88c175c8-b578-4392-8e61-015c1b5df613",
- "store_group_reference": "store_group_1",
- "support_contact": {
- "email": "john.doe@example.com",
- "phone": "+18445527621",
}, - "social_media_links": [
],
}
], - "pagination": {
- "last_item": "Fvt0G2tMGTuGx",
- "first_item": "Bxp4Z3sWFXmKq",
- "count": 20,
- "total": 1025,
- "_links": {
- "next": {
- "method": "GET",
- "rel": "Get the next page of results"
}, - "prev": {
- "method": "GET",
- "rel": "Get the next page of results"
}
}
}
}Obtain information about a specific Store Group
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
The store group of the given ID was found and retrieved
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "store_group_id": "krn:partner:global:account:store-groups:88c175c8-b578-4392-8e61-015c1b5df613",
- "store_group_reference": "store_group_1",
- "support_contact": {
- "email": "john.doe@example.com",
- "phone": "+18445527621",
}, - "social_media_links": [
],
}Update a specific Store Group
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
The store group was updated
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "store_group_reference": "store_group_1",
- "support_contact": {
- "email": "john.doe@example.com",
- "phone": "+18445527621",
}, - "social_media_links": [
],
}{- "store_group_id": "krn:partner:global:account:store-groups:88c175c8-b578-4392-8e61-015c1b5df613",
- "store_group_reference": "store_group_1",
- "support_contact": {
- "email": "john.doe@example.com",
- "phone": "+18445527621",
}, - "social_media_links": [
],
}The Accounts API allows the authenticated Partner to create, read, manage the Payment Products on an Account. Payment Products represent the ability of a Klarna account to utilize Klarna's payment offering, and essentially sell goods to consumers.
Obtains a list of all payment products associated with the account
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
List of payment products
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
[- {
- "product_id": "krn:partner:global:account:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918",
- "type": "PAYMENT",
- "partner_business_entity_id": "krn:partner:accounts:partner-business-entity:206bbb83-9b6e-46fa-940d-337153c04a58",
- "payment_profile_id": "krn:partner:global:account:payment-profile:206bbb83-9b6e-46fa-940d-337153c04a58",
- "payment_accounts": [
- {
- "payment_account_id": "krn:partner:global:payment-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b",
- "status": "ENABLED",
- "payment_account_reference": "payment_account_ref",
- "default_merchant_category_code": "5411"
}
], - "state": "ENABLED",
- "state_reason": "APPROVED"
}
]Disables the Payment Product on an account for the given reason.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Payment product disabled
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "reason": "FRAUD",
- "reason_details": "Fraudulent activity detected"
}{- "product_id": "krn:partner:global:account:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918",
- "type": "PAYMENT",
- "payment_profile_id": "krn:partner:global:account:payment-profile:206bbb83-9b6e-46fa-940d-337153c04a58",
- "payment_accounts": [
- {
- "payment_account_reference": "payment_account_ref",
- "default_merchant_category_code": "5411"
}
], - "state": "DISABLED",
- "state_reason": "FRAUD_BY_PARTNER",
- "state_context": {
- "reason_details": "string"
}
}The webhook is triggered once the distribution partner's account payment product is disabled.
{- "metadata": {
- "event_type": "partner.account.change.created",
- "event_id": "19ffd78b-935c-455b-aa0d-aa907641f1a3",
- "event_version": "v1",
- "occurred_at": "2024-02-01T12:00:00Z",
- "correlation_id": "6f28d289-31dc-40de-b222-bd037ccc439c",
- "subject_account_id": "krn:partner:account:live:2AIMNWR6IYZVD",
- "recipient_account_id": "krn:partner:account:live:2AIMNWR6IYZVD",
- "product_instance_id": "krn:partner:product:payment:0842e683-97d5-462d-99a9-c8e450deb98f",
- "webhook_id": "krn:partner:global:notification:webhook:66afe5c0-3660-45a4-9ef8-08e84f0d0aa2",
- "live": true
}, - "payload": {
- "account_reference": "M123786123412",
- "change_id": "krn:partner:global:account:change:206bbb83-9b6e-46fa-940d-337153c04a58",
- "changes": [
- {
- "field": "state",
- "previous_value": "ENABLED",
- "new_value": "DISABLED"
}
], - "created_at": "2024-01-01T12:00:00Z",
- "created_by_account_id": "krn:partner:account:live:2AIMNWR6IYZVD"
}
}Enable a Payment Product on an account.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Payment product enabled
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "product_id": "krn:partner:global:account:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918",
- "type": "PAYMENT",
- "payment_profile_id": "krn:partner:global:account:payment-profile:206bbb83-9b6e-46fa-940d-337153c04a58",
- "payment_accounts": [
- {
- "payment_account_reference": "payment_account_ref",
- "default_merchant_category_code": "5411"
}
], - "state": "ENABLED",
- "state_reason": "APPROVED"
}The webhook is triggered once the distribution partner's account payment product is enabled.
{- "metadata": {
- "event_type": "partner.account.change.created",
- "event_id": "baddd96c-c753-4864-a164-e3f9698fe703",
- "event_version": "v1",
- "occurred_at": "2024-02-01T12:00:00Z",
- "correlation_id": "d625539d-808b-4dc7-bbc7-f9df28248b63",
- "subject_account_id": "krn:partner:account:live:2AIMNWR6IYZVD",
- "recipient_account_id": "krn:partner:account:live:2AIMNWR6IYZVD",
- "product_instance_id": "krn:partner:product:payment:0842e683-97d5-462d-99a9-c8e450deb98f",
- "webhook_id": "krn:partner:global:notification:webhook:e708ffdf-3ae3-4e39-831b-c7affd12f897",
- "live": true
}, - "payload": {
- "account_reference": "M123786123412",
- "change_id": "krn:partner:global:account:change:206bbb83-9b6e-46fa-940d-337153c04a58",
- "changes": [
- {
- "field": "state",
- "previous_value": "DISABLED",
- "new_value": "ENABLED"
}
], - "created_at": "2024-01-01T12:00:00Z",
- "created_by_account_id": "krn:partner:account:live:2AIMNWR6IYZVD"
}
}The Payment Accounts API allows the authenticated Partner to create, read, manage the Payment Account on a Payment Product. Payment Accounts allows for a client defined identifier to be attached to a combination of payment configuration, partner legal entity, MCC and store, in order to facilitate payment integration later.
Obtain information about a specific Payment Account
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
The payment account was found
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "payment_account_id": "krn:partner:global:payment-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b",
- "status": "ENABLED",
- "payment_account_reference": "payment_account_ref",
- "default_merchant_category_code": "5411"
}Update an specific Payment Account
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
| payment_account_reference | string (PaymentAccountReference) Unique reference the partner uses to identify the payment account validation-info: Validates that the resource exists. |
| default_merchant_category_code | string (MerchantCategoryCode) The Merchant Category Code (MCC) is a four-digit number that is used to classify the type of goods or services
offered by a business.
[ validation-info: Validation that the value is 4 digit numeric "\\d{4}"' |
The payment account was updated
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "payment_account_reference": "payment_account_ref",
- "default_merchant_category_code": "5411"
}{- "payment_account_id": "krn:partner:global:payment-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b"
}A Payment Profile represents a combination of a price plan and a payment program. It can be used by Acquiring Partners during onboarding of sub-partners to attach the configuration to the payment product.
Fetches all payments profiles. The payment profiles returned may be used during onboarding to attach configuration to a payment product.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
List of Payment Profiles
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
[- {
- "payment_profile_id": "krn:partner:global:account:distribution-profile:206bbb83-9b6e-46fa-940d-337153c04a58",
- "price_plan_id": "krn:partner:global:payment:price-plan:171080e7-2637-4675-a224-ec032723ebdf"
}
]The Partner Management API allows the Partners to retrieve the Price Plans configured for their account. Price Plans defines how a payment transaction is priced towards the Partner.
Fetch all Price Plans available for the partner.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Price Plan list
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "price_plan_id": "krn:partner:global:pricing:payment:price-plan:ad71bc48-8a07-4919-a2c1",
- "name": "price plan",
- "description": "Default Price Plan",
- "versions": [
- {
- "version": 1,
- "effective_from": "2023-05-01T00:00:00Z",
- "effective_to": "2024-12-31T12:00:00Z",
- "comment": "Currently Active"
}, - {
- "version": 2,
- "effective_from": "2025-01-01T12:00:00Z",
- "comment": "Effective post 1 Jan 2025"
}
]
}A Price Plan is the definition of how a Payment transaction is priced towards the Partner. merchant_category_code parameter is required.
| merchant_category_code required | string (MerchantCategoryCode) The Merchant Category Code (MCC) is a four-digit number that is used to classify the type of goods or services
offered by a business.
[ Example: merchant_category_code=5411 validation-info: Validation that the value is 4 digit numeric "\\d{4}"' |
| date_time | string <date-time> (Timestamp) ^[0-9][0-9][0-9][0-9]-[0-1][0-9]-[0-3][0-9]T[... Retrieves price plan data for specified date time in UTC. If not provided, the current date will be used. Example: date_time=2024-01-01T12:00:00Z validation-info: Validates that the timestamp is ISO 8601 - UTC time |
| version | number (PricePlanVersionNumber) Version number of Price Plan |
| currency | string (Currency) ^[A-Za-z]{3}$ Currency in ISO 4217 format. Example: currency=USD validation-info: There is validation that the provided value is a valid currency. There is no validation that the we have pricing for the given currency. |
| partner_country | string (Country) ^[A-Za-z]{2}$ The country where the partner is registered in ISO 3166-1 alpha-2 format. Example: partner_country=US |
| customer_country | string (Country) ^[A-Za-z]{2}$ The country where the customer is registered in ISO 3166-1 alpha-2 format. Example: customer_country=US |
| pricing_payment_category | string (PricingPaymentCategory) A categorization of the payment transaction used to calculate the final pricing of that transaction. |
| payment_program_id | string (PaymentProgramId) Applied payment program id Example: payment_program_id=krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291 |
| size | integer <int32> Limits the number of items to be returned. If omitted, the default page size will be used. Example: size=20 |
| starting_after | string A cursor used in pagination, referring to a specific item. The Example: starting_after=Zpq6F3mDYtwK8 |
| ending_before | string A cursor used in pagination, referring to a specific item. The Example: ending_before=Zpq6F3mDYtwK8 |
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Price Plan was successfully found by provided price plan id, mcc and date
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "price_plan_id": "krn:partner:global:pricing:payments:price-plan:ad71bc48-8a07-4919-a2c1",
- "name": "price plan",
- "description": "Default Price Plan",
- "rates": [
- {
- "type": "TRANSACTION_FEE",
- "payment_program_id": "krn:partner:global:pricing:payment:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291",
- "partner_country": "US",
- "merchant_category_code": "5111",
- "pricing_payment_category": "DIGITAL",
- "unit": "CAPTURE",
- "rate": {
- "fixed_fee": {
- "amount": 30,
- "currency": "USD"
}, - "variable_fee": {
- "percentage": 120
}
}, - "price_cap": {
- "name": "micro-transaction-cap",
- "percentage": 400
}
}, - {
- "type": "TRANSACTION_FEE",
- "payment_program_id": "krn:partner:global:pricing:payment:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343292",
- "partner_country": "US",
- "merchant_category_code": "5131",
- "pricing_payment_category": "DIGITAL",
- "unit": "CAPTURE",
- "rate": {
- "fixed_fee": {
- "amount": 30,
- "currency": "USD"
}, - "variable_fee": {
- "percentage": 120
}
}, - "price_cap": {
- "name": "micro-transaction-cap",
- "percentage": 400
}
}, - {
- "type": "CROSS_BORDER_FEE",
- "customer_country": "FR",
- "partner_country": "US",
- "unit": "CAPTURE",
- "rate": {
- "fixed_fee": {
- "amount": 0,
- "currency": "USD"
}, - "variable_fee": {
- "percentage": 120
}
}
}
], - "version": 1,
- "effective_from": "2024-01-01T12:00:00Z",
- "comment": "Active, effective post Jan 1 2024",
- "pagination": {
- "last_item": "40",
- "first_item": "20",
- "count": 20,
- "_links": {
- "next": {
- "href": "/api/items?starting_after=20&size=20",
- "method": "GET"
}, - "prev": {
- "href": "/api/items?starting_after=0&size=20",
- "method": "GET"
}
}
}
}The Payment Programs API allows the Partners to list their payment programs and enable an optional payment program.
Get details about a specific settlement.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Ok
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
Service Temporarily Unavailable, the system is temporarily unavailable to process the request.
{- "settlement_id": "krn:partner:eu1:settlement:live:113574395",
- "payment_acquiring_account_id": "krn:partner:global:payment-acquiring-account:live:3440b9b7-7ca2-44a3-8f62-776caacdaa0b",
- "payment_acquiring_account_reference": "M123786123412",
- "created_at": "2024-10-13T00:00:00Z",
- "period_from": "2024-10-05T00:00:00Z",
- "period_to": "2024-10-12T00:00:00Z",
- "settlement_amount": 200,
- "currency": "USD",
- "totals": {
- "capture_amount": 200,
- "refund_amount": 200,
- "capture_fixed_fee_amount": 200,
- "capture_variable_fee_amount": 200,
- "dispute_fee_amount": 200,
- "fee_correction_amount": 200,
- "chargeback_amount": 200,
- "correction_chargeback_amount": 200,
- "tax_amount": 200,
- "holdback_amount": 200,
- "release_amount": 200,
- "opening_debt_balance": 200,
- "deposit_amount": 200,
- "repay_amount": 200,
- "closing_debt_balance": 200
}
}{- "metadata": {
- "event_id": "28ac927f-5ba7-4589-8bf7-1c8ada082343",
- "event_type": "payment.transaction.state-change.expired",
- "event_version": "v2",
- "occurred_at": "2024-01-01T12:00:00Z",
- "subject_account_id": "krn:partner:global:account:live:LWT2XJSE",
- "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE",
- "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918",
- "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5",
- "live": true
}, - "payload": {
- "settlement_id": "krn:partner:eu1:settlement:live:113574395",
- "settlement_amount": 2000,
- "currency": "USD",
- "payment_acquiring_account_id": "krn:partner:global:payment-acquiring-account:live:3440b9b7-7ca2-44a3-8f62-776caacdaa0b",
- "payment_acquiring_account_reference": "M123786123412",
- "_links": {
- "csv_report": {
- "type": "text/csv"
}, - "json_report": {
- "type": "application/json"
}, - "payout_status": {
- "type": "application/json"
}
}
}
}Get the details of specific settlement in CSV format, also known as the Settlement Report.
The report consist of two sections: The summary section of two lines (heading + one data row) then the transactions section (heading + n lines) starting on the third line.
Formatting details:
,".100 unless stated otherwise.required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Ok
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
Service Temporarily Unavailable, the system is temporarily unavailable to process the request.
settlement_id,payment_acquiring_account_id,payment_acquiring_account_reference,created_at,period_from,period_to,settlement_amount,currency,capture_amount,refund_amount,capture_fixed_fee_amount,capture_variable_fee_amount,dispute_fee_amount,fee_correction_amount,chargeback_amount,correction_chargeback_amount,tax_amount,holdback_amount,release_amount,opening_debt_balance,deposit_amount,repay_amount,closing_debt_balance,paid_out_at,payout_bank_account_reference,payment_reference,,, krn:partner:eu1:settlement:live:15328742,krn:partner:global:account:live:LWT2XJSE,M123786123412,2024-10-13T22:00:00Z,2024-10-05T22:00:00Z,2024-10-12T22:00:00Z,78743,EUR,174500,-17000,-900,-1224,-200,40,-76050,0,-423,0,0,0,0,0,0,2024-10-13T22:00:00Z,PSP US Bank Account,15328742,,, type,detailed_type,created_at,transaction_amount,transaction_currency,,,,payment_account_id,payment_account_reference,product_id,payment_transaction_id,payment_transaction_created_at,payment_transaction_reference,payment_capture_id,payment_capture_reference,payment_refund_id,payment_refund_reference,payment_dispute_id,payment_chargeback_id,tax_amount,tax_rate,applied_transaction_fee,applied_cross_border_fee,applied_buy_rate_incentives,applied_sell_rate_incentives,price_plan_id,payment_program_id,merchant_category_code SALE,CAPTURE,2024-09-10T09:53:25.000Z,15300,EUR,,,,krn:partner:global:account:live:c0342d28-62b7-4d13-a685-840298a90d73,payment_account_ref,krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918,krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0,2024-09-07T15:25:04.000Z,partner-transaction-reference-4567,krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:capture:1,partner-capture-ref-456,,,,,,,,,,,krn:partner:global:pricing:payments:price-plan:ad71bc48-8a07-4919-a2c1,krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291,5912 FEE,CAPTURE_FIXED_FEE,2024-09-10T09:53:26.250Z,-100,EUR,,,,krn:partner:global:account:live:c0342d28-62b7-4d13-a685-840298a90d73,payment_account_ref,krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918,krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0,2024-09-07T15:25:04.000Z,partner-transaction-reference-4567,krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:capture:1,partner-capture-ref-456,,,,,-19,1900,-100,,0,0,krn:partner:global:pricing:payments:price-plan:ad71bc48-8a07-4919-a2c1,krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291,5912 FEE,PAYMENT_VARIABLE_FEE,2024-09-10T09:53:26.250Z,-184,EUR,,,,krn:partner:global:account:live:c0342d28-62b7-4d13-a685-840298a90d73,payment_account_ref,krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918,krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0,2024-09-07T15:25:04.000Z,partner-transaction-reference-4567,krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:capture:1,partner-capture-ref-456,,,,,-35,1900,-184,,0,0,krn:partner:global:pricing:payments:price-plan:ad71bc48-8a07-4919-a2c1,krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291,5912 REFUND,REFUND,2024-09-10T22:23:11.000Z,-800,EUR,,,,krn:partner:global:account:live:c0342d28-62b7-4d13-a685-840298a90d73,payment_account_ref,krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918,krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0,2024-09-07T15:25:04.000Z,partner-transaction-reference-4567,krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:capture:1,partner-capture-ref-456,krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:refund:1,partner-refund-reference-123,,,,,,,,,krn:partner:global:pricing:payments:price-plan:ad71bc48-8a07-4919-a2c1,krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291,5912 SALE,CAPTURE,2024-09-09T09:22:25.000Z,17650,EUR,,,,krn:partner:global:account:live:99d56935-fe56-4c5f-b64e-72e6ef61baec,payment_account_ref 2,krn:partner:product:payment:c1b766ea-2007-4052-9571-8f8ae0012e14,krn:payment:eu1:transaction:72223a37-7875-490f-ab43-78434214e9fb,2024-09-08T09:53:25.000Z,partner-transaction-reference-1111,krn:payment:eu1:transaction:72223a37-7875-490f-ab43-78434214e9fb:capture:1,partner-capture-ref-888,,,,,,,,,,,krn:partner:global:pricing:payments:price-plan:ad71bc48-8a07-4919-a2c1,krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291,7011 FEE,CAPTURE_FIXED_FEE,2024-09-09T09:22:25.000Z,-100,EUR,,,,krn:partner:global:account:live:99d56935-fe56-4c5f-b64e-72e6ef61baec,payment_account_ref 2,krn:partner:product:payment:c1b766ea-2007-4052-9571-8f8ae0012e14,krn:payment:eu1:transaction:72223a37-7875-490f-ab43-78434214e9fb,2024-09-08T09:53:25.000Z,partner-transaction-reference-1111,krn:payment:eu1:transaction:72223a37-7875-490f-ab43-78434214e9fb:capture:1,partner-capture-ref-888,,,,,-20,2000,-100,0,,,krn:partner:global:pricing:payments:price-plan:ad71bc48-8a07-4919-a2c1,krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291,7011 FEE,DISPUTE_FEE,2024-09-10T18:21:25.000Z,-200,EUR,,,,krn:partner:global:account:live:99d56935-fe56-4c5f-b64e-72e6ef61baec,payment_account_ref 2,krn:partner:product:payment:c1b766ea-2007-4052-9571-8f8ae0012e14,krn:payment:eu1:transaction:72223a37-7875-490f-ab43-78434214e9fb,2024-09-08T09:53:25.000Z,partner-transaction-reference-1111,krn:payment:eu1:transaction:72223a37-7875-490f-ab43-78434214e9fb:capture:1,partner-capture-ref-888,,,krn:payment:eu1:dispute:faulty-goods:256947,,,,,,,,,,7011 SALE,CAPTURE,2024-09-09T14:21:05.000Z,17650,EUR,,,,krn:partner:global:account:live:99d56935-fe56-4c5f-b64e-72e6ef61baec,payment_account_ref 2,krn:partner:product:payment:c1b766ea-2007-4052-9571-8f8ae0012e14,krn:payment:eu1:transaction:4a2aa077-4629-4efe-a75d-4e12a80ac55a,2024-09-04T07:03:25.000Z,partner-transaction-reference-4545,krn:payment:eu1:transaction:4a2aa077-4629-4efe-a75d-4e12a80ac55a:capture:1,partner-capture-ref-578,,,,,,,,,,,krn:partner:global:pricing:payments:price-plan:ad71bc48-8a07-4919-a2c1,krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291,7011 FEE,CAPTURE_FIXED_FEE,2024-09-09T14:21:05.000Z,-100,EUR,,,,krn:partner:global:account:live:99d56935-fe56-4c5f-b64e-72e6ef61baec,payment_account_ref 2,krn:partner:product:payment:c1b766ea-2007-4052-9571-8f8ae0012e14,krn:payment:eu1:transaction:4a2aa077-4629-4efe-a75d-4e12a80ac55a,2024-09-04T07:03:25.000Z,partner-transaction-reference-4545,krn:payment:eu1:transaction:4a2aa077-4629-4efe-a75d-4e12a80ac55a:capture:1,partner-capture-ref-578,,,,,-24,2400,-157,0,57,0,krn:partner:global:pricing:payments:price-plan:ad71bc48-8a07-4919-a2c1,krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291,7011 FEE,PAYMENT_VARIABLE_FEE,2024-09-09T14:21:05.000Z,-200,EUR,,,,krn:partner:global:account:live:99d56935-fe56-4c5f-b64e-72e6ef61baec,payment_account_ref 2,krn:partner:product:payment:c1b766ea-2007-4052-9571-8f8ae0012e14,krn:payment:eu1:transaction:4a2aa077-4629-4efe-a75d-4e12a80ac55a,2024-09-04T07:03:25.000Z,partner-transaction-reference-4545,krn:payment:eu1:transaction:4a2aa077-4629-4efe-a75d-4e12a80ac55a:capture:1,partner-capture-ref-578,,,,,-48,2400,-269,0,69,0,,,7011 CHARGEBACK,CHARGEBACK,2024-09-10T22:15:25.000Z,-17650,EUR,,,,krn:partner:global:account:live:99d56935-fe56-4c5f-b64e-72e6ef61baec,payment_account_ref 2,krn:partner:product:payment:c1b766ea-2007-4052-9571-8f8ae0012e14,krn:payment:eu1:transaction:4a2aa077-4629-4efe-a75d-4e12a80ac55a,2024-09-04T07:03:25.000Z,partner-transaction-reference-4545,,,,,krn:payment:eu1:dispute:faulty-goods:53633,krn:payment:eu1:transaction:4a2aa077-4629-4efe-a75d-4e12a80ac55a:chargeback:1,,,,,,,,,7011 FEE_CORRECTION,CORRECTION_PAYMENT_VARIABLE_FEE,2024-09-10T09:53:26.250Z,40,EUR,,,,krn:partner:global:account:live:55002546-6bc5-472f-b401-36c271f54464,payment_account_ref 3,krn:partner:product:payment:559f156b-9939-4710-9a4b-2b25896650e3,krn:payment:eu1:transaction:8bdaf94d-91bf-446e-aac1-82e55fed731e,2024-09-10T09:53:25.000Z,partner-transaction-reference-33232,krn:payment:eu1:transaction:8bdaf94d-91bf-446e-aac1-82e55fed731e:capture:1,,,,,,9,2300,,,,,krn:partner:global:pricing:payments:price-plan:ad71bc48-8a07-4919-a2c1,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5412 SALE,CAPTURE,2024-09-09T12:55:25.000Z,8000,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:18af645c-9945-4a7f-a595-85a71d7c7664,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0,2024-09-01T05:27:57.512Z,partner-transaction-reference-874,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0:capture:1,partner-capture-ref-100,,,,,,,,,,,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5331 FEE,CAPTURE_FIXED_FEE,2024-09-09T12:55:25.000Z,-100,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:18af645c-9945-4a7f-a595-85a71d7c7664,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0,2024-09-01T05:27:57.512Z,partner-transaction-reference-874,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0:capture:1,partner-capture-ref-100,,,,,-19,1900,-170,0,0,70,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5331 FEE,PAYMENT_VARIABLE_FEE,2024-09-09T12:55:25.000Z,-96,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:18af645c-9945-4a7f-a595-85a71d7c7664,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0,2024-09-01T05:27:57.512Z,partner-transaction-reference-874,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0:capture:1,partner-capture-ref-100,,,,,-18,1900,-155,0,0,59,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5331 SALE,CAPTURE,2024-09-09T22:47:36.000Z,4500,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:18af645c-9945-4a7f-a595-85a71d7c7664,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0,2024-09-01T05:27:57.512Z,partner-transaction-reference-874,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0:capture:2,partner-capture-ref-200,,,,,,,,,,,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5331 FEE,CAPTURE_FIXED_FEE,2024-09-09T22:47:36.000Z,-100,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:18af645c-9945-4a7f-a595-85a71d7c7664,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0,2024-09-01T05:27:57.512Z,partner-transaction-reference-874,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0:capture:2,partner-capture-ref-200,,,,,-19,1900,-100,0,0,0,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5331 FEE,PAYMENT_VARIABLE_FEE,2024-09-09T22:47:36.000Z,-54,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:18af645c-9945-4a7f-a595-85a71d7c7664,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0,2024-09-01T05:27:57.512Z,partner-transaction-reference-874,krn:payment:eu1:transaction:16a484d1-859b-489f-8969-d92dccc7a3a0:capture:2,partner-capture-ref-200,,,,,-10,1900,-54,0,0,0,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5331 SALE,CAPTURE,2024-09-09T13:51:20.000Z,8000,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:2719962e-10ff-443a-a43b-1c6d0e07fbd9,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4,2024-09-05T10:23:23.512Z,partner-transaction-reference-541,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4:capture:1,partner-capture-ref-999,,,,,,,,,,,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5412 FEE,CAPTURE_FIXED_FEE,2024-09-09T13:51:20.000Z,-100,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:2719962e-10ff-443a-a43b-1c6d0e07fbd9,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4,2024-09-05T10:23:23.512Z,partner-transaction-reference-541,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4:capture:1,partner-capture-ref-999,,,,,-23,2300,-170,0,0,70,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5412 FEE,PAYMENT_VARIABLE_FEE,2024-09-09T13:51:20.000Z,-96,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:2719962e-10ff-443a-a43b-1c6d0e07fbd9,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4,2024-09-05T10:23:23.512Z,partner-transaction-reference-541,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4:capture:1,partner-capture-ref-999,,,,,-22,2300,-155,0,0,59,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5412 SALE,CAPTURE,2024-09-09T17:11:32.000Z,4500,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:2719962e-10ff-443a-a43b-1c6d0e07fbd9,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4,2024-09-05T10:23:23.512Z,partner-transaction-reference-541,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4:capture:2,partner-capture-ref-888,,,,,,,,,,,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5412 FEE,CAPTURE_FIXED_FEE,2024-09-09T17:11:32.000Z,-100,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:2719962e-10ff-443a-a43b-1c6d0e07fbd9,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4,2024-09-05T10:23:23.512Z,partner-transaction-reference-541,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4:capture:2,partner-capture-ref-888,,,,,-23,2300,-100,0,0,0,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5412 FEE,PAYMENT_VARIABLE_FEE,2024-09-09T17:11:32.000Z,-54,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:2719962e-10ff-443a-a43b-1c6d0e07fbd9,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4,2024-09-05T10:23:23.512Z,partner-transaction-reference-541,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4:capture:2,partner-capture-ref-888,,,,,-12,2300,-54,0,0,0,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5412 REFUND,REFUND,2024-09-10T21:20:21.000Z,-8000,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:2719962e-10ff-443a-a43b-1c6d0e07fbd9,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4,2024-09-05T10:23:23.512Z,partner-transaction-reference-541,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4:capture:1,partner-capture-ref-999,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4:refund:1,partner-refund-reference-999,,,,,,,,,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5412 REFUND,REFUND,2024-09-10T21:20:21.000Z,-4500,EUR,,,,krn:partner:global:account:live:7d7713fc-43a2-40bd-baef-de444d85ac44,payment_account_ref 4,krn:partner:product:payment:2719962e-10ff-443a-a43b-1c6d0e07fbd9,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4,2024-09-05T10:23:23.512Z,partner-transaction-reference-541,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4:capture:2,partner-capture-ref-888,krn:payment:eu1:transaction:1d85ff74-39a9-453e-9b6f-9a7808fa28c4:refund:2,partner-refund-reference-888,,,,,,,,,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,5412 SALE,CAPTURE,2024-09-09T14:51:20.000Z,45000,EUR,,,,krn:partner:global:account:live:c0342d28-62b7-4d13-a685-840298a90d73,payment_account_ref,krn:partner:product:payment:bde34d74-20fa-4171-a1e9-11d2e398734d,krn:payment:eu1:transaction:4be3768f-e4a3-470d-98e1-645749f72779,2024-09-05T10:24:23.512Z,partner-transaction-reference-pow,krn:payment:eu1:transaction:4be3768f-e4a3-470d-98e1-645749f72779:capture:1,partner-capture-ref-pow,,,,,,,,,,,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,7011 FEE,CAPTURE_FIXED_FEE,2024-09-09T14:51:20.000Z,-100,EUR,,,,krn:partner:global:account:live:c0342d28-62b7-4d13-a685-840298a90d73,payment_account_ref,krn:partner:product:payment:bde34d74-20fa-4171-a1e9-11d2e398734d,krn:payment:eu1:transaction:4be3768f-e4a3-470d-98e1-645749f72779,2024-09-05T10:24:23.512Z,partner-transaction-reference-pow,krn:payment:eu1:transaction:4be3768f-e4a3-470d-98e1-645749f72779:capture:1,partner-capture-ref-pow,,,,,-19,1900,-100,0,0,70,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,7011 FEE,PAYMENT_VARIABLE_FEE,2024-09-09T14:51:20.000Z,-540,EUR,,,,krn:partner:global:account:live:c0342d28-62b7-4d13-a685-840298a90d73,payment_account_ref,krn:partner:product:payment:bde34d74-20fa-4171-a1e9-11d2e398734d,krn:payment:eu1:transaction:4be3768f-e4a3-470d-98e1-645749f72779,2024-09-05T10:24:23.512Z,partner-transaction-reference-pow,krn:payment:eu1:transaction:4be3768f-e4a3-470d-98e1-645749f72779:capture:1,partner-capture-ref-pow,,,,,-103,1900,-599,0,0,59,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,7011 REFUND,REFUND,2024-09-10T22:20:21.000Z,-3700,EUR,,,,krn:partner:global:account:live:c0342d28-62b7-4d13-a685-840298a90d73,payment_account_ref,krn:partner:product:payment:bde34d74-20fa-4171-a1e9-11d2e398734d,krn:payment:eu1:transaction:4be3768f-e4a3-470d-98e1-645749f72779,2024-09-05T10:24:23.512Z,partner-transaction-reference-1478,,,krn:payment:eu1:transaction:4be3768f-e4a3-470d-98e1-645749f72779:refund:1,partner-refund-reference-pow,,,,,,,,,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,7011 SALE,CAPTURE,2024-09-09T13:51:20.000Z,58400,EUR,,,,krn:partner:global:account:live:ba251a3c-314d-4551-a282-c4e1e5d94353,payment_account_ref 5,krn:partner:product:payment:c0981a4c-fadc-4718-96db-f639f9a18cac,krn:payment:eu1:transaction:169dafea-394e-48be-8418-363fcb2f06b6,2024-09-01T08:03:25.000Z,partner-transaction-reference-4545,krn:payment:eu1:transaction:169dafea-394e-48be-8418-363fcb2f06b6:capture:1,partner-capture-ref-555,,,,,,,,,,,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,7011 FEE,CAPTURE_FIXED_FEE,2024-09-09T13:51:20.000Z,-100,EUR,,,,krn:partner:global:account:live:ba251a3c-314d-4551-a282-c4e1e5d94353,payment_account_ref 5,krn:partner:product:payment:c0981a4c-fadc-4718-96db-f639f9a18cac,krn:payment:eu1:transaction:169dafea-394e-48be-8418-363fcb2f06b6,2024-09-01T08:03:25.000Z,partner-transaction-reference-4545,krn:payment:eu1:transaction:169dafea-394e-48be-8418-363fcb2f06b6:capture:1,partner-capture-ref-555,,,,,-23,2300,-170,0,0,70,krn:partner:global:pricing:payments:price-plan:baff081e-c246-4ba1-ad94-e4f913a77a34,krn:partner:global:pricing:payments:program:6bda01c4-ee39-4aec-a160-f2a7fa3ce90d,7011 CHARGEBACK,CUSTOMER_PAYMENT_DEFAULT,2024-09-09T05:51:21.000Z,-58400,EUR,,,,krn:partner:global:account:live:ba251a3c-314d-4551-a282-c4e1e5d94353,payment_account_ref 5,krn:partner:product:payment:c0981a4c-fadc-4718-96db-f639f9a18cac,krn:payment:eu1:transaction:169dafea-394e-48be-8418-363fcb2f06b6,2024-09-01T08:03:25.000Z,partner-transaction-reference-4545,,,,,,krn:payment:eu1:transaction:169dafea-394e-48be-8418-363fcb2f06b6::chargeback:1,,,,,,,,,7011
Lists all transactions for a specific settlement.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Ok
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
Service Temporarily Unavailable, the system is temporarily unavailable to process the request.
{- "transactions": [
- {
- "type": "SALE",
- "detailed_type": "CAPTURE",
- "created_at": "2024-01-01T12:00:00Z",
- "transaction_amount": 15000,
- "transaction_currency": "USD",
- "payment_account_id": "krn:partner:global:payment-account:test:3440b9b7-7ca2-44a3-8f62-776caacdaa0b",
- "payment_account_reference": "payment_account_ref",
- "product_id": "krn:partner:global:account:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918",
- "payment_transaction_id": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0",
- "payment_transaction_created_at": "2024-01-01T12:00:00Z",
- "payment_transaction_reference": "partner-transaction-reference-4567",
- "payment_capture_id": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:capture:1",
- "payment_capture_reference": "partner-capture-reference-1234",
- "payment_refund_id": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:refund:1",
- "payment_refund_reference": "partner-refund-reference-1234",
- "payment_dispute_id": "krn:payment:eu1:dispute:faulty-products:256947",
- "payment_chargeback_id": "krn:payment:eu1:transaction:6debe89e-98c0-486e-b7a5-08a4f6df94b0:chargeback:1",
- "tax_amount": 200,
- "tax_rate": 1500,
- "applied_transaction_fee": 200,
- "applied_cross_border_fee": 200,
- "applied_buy_rate_incentives": 200,
- "applied_sell_rate_incentives": 200,
- "price_plan_id": "krn:partner:global:payment:price-plan:a5cd46f7e-573d-4b02-bab8-1f1c0e343291",
- "payment_program_id": "krn:partner:global:pricing:payments:program:a5cd46f7e-573d-4b02-bab8-1f1c0e343291",
- "merchant_category_code": "5411"
}
], - "pagination": {
- "last_item": "Fvt0G2tMGTuGx",
- "first_item": "Bxp4Z3sWFXmKq",
- "count": 20,
- "total": 1025,
- "_links": {
- "next": {
- "method": "GET",
- "rel": "Get the next page of results"
}, - "prev": {
- "method": "GET",
- "rel": "Get the next page of results"
}
}
}
}Gets the status of the settlement payout. If more than one payout attempts have been made, the latest status will be returned.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
The payout status for the latest payout attempt.
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
Service Temporarily Unavailable, the system is temporarily unavailable to process the request.
{- "payout_id": "krn:partner:eu1:settlement:live:123456789:payouts:1",
- "paid_out_at": "2024-01-01T12:00:00Z",
- "payout_amount": 200,
- "currency": "USD",
- "status": "PROCESSED",
- "payout_bank_account_reference": "string",
- "payment_reference": "113574395"
}The Deep-Links API allows the authenticated Account to create a deep-link for logging in to the Merchant Portal. This allows users to access the Merchant Portal temporarily, without the need for creating a new account.
Creates a deep-link to access the Merchant Portal. The link will be valid for 60 seconds and can only be used once. The user will have the access specified by the role parameter to the given Partner Account.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Deep-link successfully created.
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "subject": "john.doe@example.com",
- "roles": [
- "merchant:admin"
]
}{- "deep_link_id": "krn:partner:global:portal:deep-link:0e716c0d-529c-4b9c-a413-badf5cc97294",
}The deep-link will become invalid and cannot be used anymore.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Deep-link successfully deleted.
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "error_id": "5a3f6b9c-9b3b-4b7e-8f9d-9b9a4b9a4b9a",
- "error_type": "INPUT_ERROR",
- "error_code": "INVALID_CONTENT_TYPE",
- "error_message": "The received input is not valid JSON.\nUnterminated string at 19 [character 20 line 1].\n"
}The User Access API allows the authenticated Account to create, update or delete user access to the Merchant Portal.
Create or update access to the Portal for a user.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Access successfully created.
Access successfully updated.
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
}{- "error_id": "5a3f6b9c-9b3b-4b7e-8f9d-9b9a4b9a4b9a",
- "error_type": "INPUT_ERROR",
- "error_code": "INVALID_CONTENT_TYPE",
- "error_message": "The received input is not valid JSON.\nUnterminated string at 19 [character 20 line 1].\n"
}Deletes all user access, scoped by account and/or principal.
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
Access successfully deleted
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "error_id": "5a3f6b9c-9b3b-4b7e-8f9d-9b9a4b9a4b9a",
- "error_type": "INPUT_ERROR",
- "error_code": "INVALID_CONTENT_TYPE",
- "error_message": "The received input is not valid JSON.\nUnterminated string at 19 [character 20 line 1].\n"
}The Compliance API allows to get information regarding compliance decisions taken on accounts.
Get all decisions for an account
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
The decisions are found
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "pagination": {
- "last_item": "string",
- "count": 0
}, - "decisions": [
- {
- "decision_id": "string",
- "decision_type": "NON_COMPLIANT",
- "partner_account_id": "string",
- "product_instance_id": "string",
- "created_at": "2019-08-24T14:15:22Z"
}
]
}{- "metadata": {
- "event_id": "28ac927f-5ba7-4589-8bf7-1c8ada082343",
- "event_type": "payment.transaction.state-change.expired",
- "event_version": "v2",
- "occurred_at": "2024-01-01T12:00:00Z",
- "subject_account_id": "krn:partner:global:account:live:LWT2XJSE",
- "recipient_account_id": "krn:partner:global:account:live:LWT2XJSE",
- "product_instance_id": "krn:partner:product:payment:ad71bc48-8a07-4919-a2c1-103dba3fc918",
- "webhook_id": "krn:partner:global:notification:webhook:120e5b7e-abcd-4def-8a90-dca726e639b5",
- "live": true
}, - "payload": {
- "decision_id": "string",
- "decision_type": "NON_COMPLIANT",
- "created_at": "2019-08-24T14:15:22Z"
}
}Get a decision
required | object Metadata about the integrator and originators of the request in n object, serialized as a valid JSON Example: object=[object Object] |
The decision is found
Bad Request, there was an error in the input of the request. The request can not be retried without modifications.
Unauthorized, the request was not authorized.
Not Found, the requested resource was not found.
Too Many Requests, the request was rate limited.
Internal Server Error, there was an unexpected error in the API.
{- "decision_id": "string",
- "decision_type": "NON_COMPLIANT",
- "partner_account_id": "string",
- "product_instance_id": "string",
- "created_at": "2019-08-24T14:15:22Z"
}