Skip to main content
API docs by Redocly

Nopan API (v1)

Download OpenAPI specification:Download

Download Nopan Postman collection: Download

Authentication APIs

This section covers the endpoints required for securely obtaining OAuth 2.0 access tokens to interact with the Nopan API. These APIs support machine-to-machine (M2M) authentication using mutual TLS (mTLS) and client credentials. A valid access token is required to authorize all subsequent requests to protected resources.

Get access token

Get an access token via OAuth2

Request Body schema: application/x-www-form-urlencoded
required
grant_type
required
string

OAuth2 grant type. Must be set to client_credentials to indicate machine-to-machine authentication using client credentials.
Example: client_credentials

client_id
required
string

The organization account ID provided at onboarding.
Example: merchant-abc123

scope
string

Optional space-delimited list of scopes the client is requesting access to. Used to limit the access token's permissions. Default is payments:read
Example: payments:read payments:process

Responses

Request samples

Content type
application/x-www-form-urlencoded

Get access token via OAuth2 by submitting form

grant_type=client_credentials&client_id=your-organization-id&scope=payments:process

Response samples

Content type
application/json

Access token itself, how long it is valid for in seconds and other information

{
  • "access_token": "header.payload.signature",
  • "expires_in": 7200,
  • "refresh_expires_in": 0,
  • "token_type": "Bearer",
  • "not-before-policy": 0,
  • "scope": "payments:read"
}

Payment Processing APIs

This section provides a set of operations for initiating and managing payments through the Nopan API. These endpoints enable clients to request payments, handle SCA, and track the status of transactions in real time. Designed for seamless integration, the APIs support secure and compliant payment workflows for a variety of use cases including e-commerce, invoicing, and in-app purchases.

Initiate payment

Starts a new payment flow. The client provides payment details, and the response includes a redirect URL for the payer's SCA.

header Parameters
Idempotency-Key
string

The idempotency key header
Example: ca0a0b86-14e7-4a2b-adf3-74eca443571b

Request Body schema: application/json
required
processingAccountId
required
string non-empty

Unique identifier of the processing account under which the payment is processed.
Example: pa-1234

clientTransactionId
required
string non-empty

The unique client's internal transaction ID
Example: order11234

returnUrl
required
string non-empty

The client's redirect destination after SCA completion
Example: https://api.merchant.com/callback?ref=order1234

transactionType
required
string

Requesting transaction type
• ONE_TIME One-time payment
• RECURRING Recurring payment with an immediate first charge
• TOKENIZED Creates a recurring payment token for a first charge deferred to recurringFirstPaymentAt; auto capture is not allowed

required
object

Monetary details of the transaction

required
object

Payment scheme provider details

required
object

Payer identity information

object

Information about where the transaction was requested

object

Free map of tags set by the client
Example

{
  "key": "value",
  "experiment": "checkout_A",
  "promo_code": "SPRING2025"
}

Responses

Request samples

Content type
application/json
Example

Initiates a Blik payment request

{
  • "processingAccountId": "merchant-1234",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "returnUrl": "https://api.merchant.callback?ref=order-1234",
  • "transactionType": "ONE_TIME",
  • "paymentDetails": {
    },
  • "providerDetails": {
    },
  • "payerDetails": {
    },
  • "requestContext": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
Example

The request has been accepted and awaits for SCA

{
  • "transactionId": "p9vhkuj92yav",
  • "processingAccountId": "merchant-1234",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "providerDetails": {
    },
  • "metadata": {
    },
  • "status": "PENDING",
  • "statusInfo": {
    }
}

Finalize payment

Finalizes a two-step payment, optionally capturing funds if configured. For one-step payments, it serves as the merchant's acknowledgement.

header Parameters
Idempotency-Key
string

The idempotency key header
Example: ca0a0b86-14e7-4a2b-adf3-74eca443571b

Request Body schema: application/json
required
processingAccountId
required
string non-empty

Unique identifier of the processing account under which the payment is processed.
Example: pa-1234

transactionId
required
string non-empty

Nopan's transaction ID
Example: ee2anef9bt

object

Payer identity information

Responses

Request samples

Content type
application/json

Finalizes a payment

{
  • "processingAccountId": "merchant-1234",
  • "transactionId": "p9vhkuj92yav"
}

Response samples

Content type
application/json
Example

The payment has been approved and ready for capture

{
  • "transactionId": "p9vhkuj92yav",
  • "processingAccountId": "merchant-1234",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "providerDetails": {
    },
  • "payerDetails": {
    },
  • "paymentDetails": {
    },
  • "metadata": {
    },
  • "status": "APPROVED",
  • "statusInfo": {
    }
}

Charge payment

Triggers a recurring or token-based payment without user interaction in one step.

header Parameters
Idempotency-Key
string

The idempotency key header
Example: ca0a0b86-14e7-4a2b-adf3-74eca443571b

Request Body schema: application/json
required
processingAccountId
required
string non-empty

Unique identifier of the processing account under which the payment is processed.
Example: pa-1234

clientTransactionId
required
string non-empty

The unique client's internal transaction ID
Example: order11234

required
object

Monetary details of the transaction

required
object

Payment scheme provider details

required
object

Payer identity information

object

Information about where the transaction was requested

object

Free map of tags set by the client
Example

{
  "key": "value",
  "experiment": "checkout_A",
  "promo_code": "SPRING2025"
}

Responses

Request samples

Content type
application/json

Charges a recurring Satispay payment using a stored payment token

{
  • "processingAccountId": "merchant-1234",
  • "clientTransactionId": "recurring-txn-abc123",
  • "payerDetails": {
    },
  • "paymentDetails": {
    },
  • "providerDetails": {
    },
  • "requestContext": {
    },
  • "metadata": {
    }
}

Response samples

Content type
application/json
{
  • "transactionId": "string",
  • "processingAccountId": "string",
  • "clientTransactionId": "string",
  • "providerDetails": {
    },
  • "metadata": {
    },
  • "status": "string",
  • "statusInfo": {
    }
}

Capture payment

Captures funds from a previously finalized payment without auto capture. Enables delayed capture scenarios for clients who prefer control over timing

header Parameters
Idempotency-Key
string

The idempotency key header
Example: ca0a0b86-14e7-4a2b-adf3-74eca443571b

Request Body schema: application/json
required
processingAccountId
required
string non-empty

Unique identifier of the processing account under which the payment is processed.
Example: pa-1234

clientTransactionId
required
string non-empty

The unique client's internal transaction ID
Example: order11234

transactionId
required
string non-empty

Nopan's transaction ID
Example: ee2anef9bt

required
object

Monetary details of the transaction

Responses

Request samples

Content type
application/json

Captures partial or full amount

{
  • "processingAccountId": "merchant-1234",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "transactionId": "p9vhkuj92yav",
  • "paymentDetails": {
    }
}

Response samples

Content type
application/json

The amount has been captured

{
  • "transactionId": "p9vhkuj92yav",
  • "originalTransactionId": "ab1cdef2gh",
  • "processingAccountId": "merchant-1234",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "providerDetails": {
    },
  • "paymentDetails": {
    },
  • "status": "APPROVED",
  • "statusInfo": {
    }
}

Cancel payment

Cancels an initiated but not yet captured payment. Prevents future fund movements.

header Parameters
Idempotency-Key
string

The idempotency key header
Example: ca0a0b86-14e7-4a2b-adf3-74eca443571b

Request Body schema: application/json
required
processingAccountId
required
string non-empty

Unique identifier of the processing account under which the payment is processed.
Example: pa-1234

clientTransactionId
required
string non-empty

The unique client's internal transaction ID
Example: order11234

transactionId
required
string non-empty

Nopan's transaction ID
Example: ee2anef9bt

Responses

Request samples

Content type
application/json

Cancels a payment

{
  • "processingAccountId": "merchant-1234",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "transactionId": "p9vhkuj92yav"
}

Response samples

Content type
application/json
Example

Payment initiated and canceled

{
  • "transactionId": "p9vhkuj92yav",
  • "processingAccountId": "merchant-1234",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "providerDetails": {},
  • "payerDetails": {
    },
  • "paymentDetails": {
    },
  • "metadata": {
    },
  • "status": "CANCELED",
  • "statusInfo": {
    }
}

Refund payment

Refunds a previously captured payment, either fully or partially. Used to reverse a transaction after funds have already been settled.

header Parameters
Idempotency-Key
string

The idempotency key header
Example: ca0a0b86-14e7-4a2b-adf3-74eca443571b

Request Body schema: application/json
required
processingAccountId
required
string non-empty

Unique identifier of the processing account under which the payment is processed.
Example: pa-1234

clientTransactionId
required
string non-empty

The unique client's internal transaction ID
Example: order11234

transactionId
required
string non-empty

Nopan's transaction ID
Example: ee2anef9bt

required
object

Monetary details of the transaction

Responses

Request samples

Content type
application/json

Refunds a payment

{
  • "processingAccountId": "merchant-1234",
  • "transactionId": "p9vhkuj92yav",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "paymentDetails": {
    }
}

Response samples

Content type
application/json

The payment has been refunded

{
  • "transactionId": "r8kp2mq45zbt",
  • "originalTransactionId": "p9vhkuj92yav",
  • "processingAccountId": "merchant-1234",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "providerDetails": {
    },
  • "paymentDetails": {
    },
  • "status": "APPROVED",
  • "statusInfo": {
    }
}

Payment status

Returns the current status of a payment

path Parameters
transactionId
required
string

Nopan's transaction ID
Example: ee2anef9bt

Responses

Response samples

Content type
application/json

Status of a payment

{
  • "transactionId": "p9vhkuj92yav",
  • "clientTransactionId": "merchant-12345678",
  • "processingAccountId": "merchant-1234",
  • "metadata": {
    },
  • "status": "APPROVED",
  • "statusInfo": {
    }
}

Payment events

Returns a full timeline of state transitions and system events for a given payment

path Parameters
transactionId
required
string

Nopan's transaction ID
Example: ee2anef9bt

Responses

Response samples

Content type
application/json

Events of a payment

{
  • "transactionId": "p9vhkuj92yav",
  • "clientTransactionId": "merchant-12345678",
  • "processingAccountId": "merchant-1234",
  • "providerDetails": {},
  • "payerDetails": {
    },
  • "paymentDetails": {
    },
  • "metadata": {
    },
  • "status": "APPROVED",
  • "statusInfo": {
    }
}

Token Processing APIs

This section provides a set of operations for managing recurring tokens through the Nopan API.

Revoke recurring token

Revokes an approved recurring token. Prevents future charges.

header Parameters
Idempotency-Key
string

The idempotency key header
Example: ca0a0b86-14e7-4a2b-adf3-74eca443571b

Request Body schema: application/json
required
processingAccountId
required
string non-empty

Unique identifier of the processing account under which the payment is processed.
Example: pa-1234

tokenId
required
string non-empty

Nopan's recurring token ID
Example: p9vhkuj92yav

Responses

Request samples

Content type
application/json

Revokes a recurring token

{
  • "processingAccountId": "pa-1234",
  • "tokenId": "p9vhkuj92yav"
}

Response samples

Content type
application/json

Recurring token revoked

{
  • "tokenId": "p9vhkuj92yav",
  • "status": "REVOKED",
  • "statusInfo": {
    }
}

Testing APIs

The Nopan API includes a sandbox environment and test endpoints to help developers safely simulate, mock and validate payment flows without processing real transactions. These testing APIs mirror the behavior of the live endpoints, allowing you to initiate payments, trigger SCA flows, and verify callbacks using predefined test data. This environment is ideal for integration testing, QA workflows, and development staging before going live.

Mock payment flow

Mocks a payment flow. Mock will match requests using processingAccountId and key.

Request Body schema: application/json
required
processingAccountId
required
string non-empty

Unique identifier of the processing account under which the payment is processed.
Example: pa-1234

required
object

Information about the key type and value to be mocked

type
required
string

The mock type
• MOCK Use Mock engine
• PASSTHROUGH Use real payment scheme provider

scenario
required
string

The scenario for the transaction. Will override necessary values for each provider to give the configured outcome
• OK A green flow for one time payments with or without manual captures. Includes CIT recurring payment
• PROVIDER_TIMEOUT Payment initiation will fail at reaching the provider
• INSUFFICIENT_FUNDS The payment will fail after authorization
• OPERATION_NOT_SUPPORTED_BY_BANK The payment will fail on initiation. Consumer should try a different bank or method of payment
• CHARGE A green flow for a MIT payment charge
• CHARGE_TOKEN_EXPIRED The MIT payment charge will fail due to a token expired
• CAPTURE A green flow for another payment capture if the provider allows
• REFUND A green flow for a refund
• DECLINED_CAPTURE The following capture will fail
• DECLINED_REFUND The following refund will fail

object

Optional overrides for the simulated provider response

Responses

Request samples

Content type
application/json
Example

Create a mock for all the steps in MOCK mode.

{
  • "processingAccountId": "merchant-1234",
  • "key": {
    },
  • "type": "MOCK",
  • "scenario": "OK",
  • "data": {
    }
}

Response samples

Content type
application/json
Example

The JSON is not properly formatted

{
  • "status": "DECLINED",
  • "statusInfo": {
    },
  • "callId": "a3c8cdef0a134df4-2e31b1"
}

Webhooks

API of the webhooks notifications Nopan will send if configured in the portal.

Payment initiate notification

Notifies you about updates on initiate. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

transactionId
string

Nopan's transaction ID
Example: ee2anef9bt

clientTransactionId
string

The unique client's internal transaction ID
Example: order11234

status
string

The response status

object

The information about the status of the request

notificationType
string

The type of event that triggered this notification
Example: PAYMENT_INITIATE

Responses

Request samples

Content type
application/json

Initiate information including status, etc

{
  • "notificationId": "fc5adbcd-5f08-4d09-9307-08d950809f0d",
  • "transactionId": "p9vhkuj92yav",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "status": "PENDING",
  • "statusInfo": {
    },
  • "notificationType": "PAYMENT_INITIATE"
}

Payment finalize notification

Notifies you about updates on finalize. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

transactionId
string

Nopan's transaction ID
Example: ee2anef9bt

clientTransactionId
string

The unique client's internal transaction ID
Example: order11234

object

Payer identity information

status
string

The response status

object

The information about the status of the request

notificationType
string

The type of event that triggered this notification
Example: PAYMENT_FINALIZE

Responses

Request samples

Content type
application/json

Finalize information including status, etc.

{
  • "notificationId": "fc5adbcd-5f08-4d09-9307-08d950809f0d",
  • "transactionId": "p9vhkuj92yav",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "status": "APPROVED",
  • "statusInfo": {
    },
  • "notificationType": "PAYMENT_FINALIZE"
}

Payment capture notification

Notifies you about updates on capture. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

transactionId
string

Nopan's transaction ID
Example: ee2anef9bt

clientTransactionId
string

The unique client's internal transaction ID
Example: order11234

amount
integer <int64>

Total payment amount in minor units
Example: 200

capturedAmount
integer <int64>

Total captured amount in minor units so far
Example: 200

status
string

The response status

object

The information about the status of the request

notificationType
string

The type of event that triggered this notification
Example: PAYMENT_CAPTURE

Responses

Request samples

Content type
application/json

Capture information including amount, status, etc.

{
  • "notificationId": "fc5adbcd-5f08-4d09-9307-08d950809f0d",
  • "transactionId": "p9vhkuj92yav",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "amount": 1000,
  • "capturedAmount": 1000,
  • "status": "APPROVED",
  • "statusInfo": {
    },
  • "notificationType": "PAYMENT_CAPTURE"
}

Payment cancel notification

Notifies you about updates on cancel. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

transactionId
string

Nopan's transaction ID
Example: ee2anef9bt

clientTransactionId
string

The unique client's internal transaction ID
Example: order11234

status
string

The response status

object

The information about the status of the request

notificationType
string

The type of event that triggered this notification
Example: PAYMENT_CANCEL

Responses

Request samples

Content type
application/json

Cancel information including status, etc.

{
  • "notificationId": "fc5adbcd-5f08-4d09-9307-08d950809f0d",
  • "transactionId": "p9vhkuj92yav",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "status": "CANCELED",
  • "statusInfo": {
    },
  • "notificationType": "PAYMENT_CANCEL"
}

Payment charge notification

Notifies you about updates on charge. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

transactionId
string

Nopan's transaction ID
Example: ee2anef9bt

clientTransactionId
string

The unique client's internal transaction ID
Example: order11234

status
string

The response status

object

The information about the status of the request

notificationType
string

The type of event that triggered this notification
Example: PAYMENT_CHARGE

Responses

Request samples

Content type
application/json

Charge information including status, etc.

{
  • "notificationId": "fc5adbcd-5f08-4d09-9307-08d950809f0d",
  • "transactionId": "p9vhkuj92yav",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "status": "APPROVED",
  • "statusInfo": {
    },
  • "notificationType": "PAYMENT_CHARGE"
}

Payment refund notification

Notifies you about updates on refund. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

transactionId
string

Nopan's transaction ID
Example: ee2anef9bt

clientTransactionId
string

The unique client's internal transaction ID
Example: order11234

amount
integer <int64>

Total payment amount in minor units
Example: 200

refundedAmount
integer <int64>

Total refunded amount in minor units so far
Example: 100

status
string

The response status

object

The information about the status of the request

notificationType
string

The type of event that triggered this notification
Example: PAYMENT_REFUND

Responses

Request samples

Content type
application/json

Refund information including amount, status, etc.

{
  • "notificationId": "fc5adbcd-5f08-4d09-9307-08d950809f0d",
  • "transactionId": "p9vhkuj92yav",
  • "clientTransactionId": "client-txn-54c8c9bc",
  • "amount": 1000,
  • "refundedAmount": 1000,
  • "status": "APPROVED",
  • "statusInfo": {
    },
  • "notificationType": "PAYMENT_REFUND"
}

Pre-dispute initiated notification

Notifies you when a new pre-dispute case is opened. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

object

The pre-dispute case this notification refers to, as of its current status

object

Additional details about the pre-dispute case

notificationType
string

The type of event that triggered this notification
Example: PRE_DISPUTE_INITIATED

Responses

Request samples

Content type
application/json

Pre-dispute information including the processing account and transaction it refers to.

{
  • "notificationId": "56562de8-9b89-4628-b2fe-cd1b2cc1e95b",
  • "preDispute": {
    },
  • "data": {
    },
  • "notificationType": "PRE_DISPUTE_INITIATED"
}

Pre-dispute updated notification

Notifies you about updates on an existing pre-dispute case, such as new messages or chargeback requests. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

object

The pre-dispute case this notification refers to, as of its current status

updateType
string

The type of update applied to the pre-dispute case
• CHARGEBACK_REQUESTED The consumer requested a chargeback
• NEW_MESSAGE A new message was added to the case

object

Additional details about the pre-dispute update. The structure depends on the value of updateType

notificationType
string

The type of event that triggered this notification
Example: PRE_DISPUTE_UPDATED

Responses

Request samples

Content type
application/json
Example

A new message was added to the case.

{
  • "notificationId": "56562de8-9b89-4628-b2fe-cd1b2cc1e95b",
  • "preDispute": {
    },
  • "updateType": "NEW_MESSAGE",
  • "data": {
    },
  • "notificationType": "PRE_DISPUTE_UPDATED"
}

Pre-dispute closed notification

Notifies you when a pre-dispute case is closed. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

object

The pre-dispute case this notification refers to, as of its current status

reason
string

The reason why the pre-dispute case was closed
• CHARGEBACK_REQUEST_ACCEPTED The consumer PSP accepted the chargeback request, closing the pre-dispute case and escalating it to a chargeback
• CHARGEBACK_REQUEST_DECLINED The consumer PSP declined the chargeback request, closing the pre-dispute case
• CLOSED The consumer closed the pre-dispute case
• REFUNDED The consumer was refunded, closing the case

object

Additional details about the pre-dispute closure. The structure depends on the value of reason

notificationType
string

The type of event that triggered this notification
Example: PRE_DISPUTE_CLOSED

Responses

Request samples

Content type
application/json
Example

The payer was refunded, closing the case.

{
  • "notificationId": "56562de8-9b89-4628-b2fe-cd1b2cc1e95b",
  • "preDispute": {
    },
  • "reason": "REFUNDED",
  • "data": {
    },
  • "notificationType": "PRE_DISPUTE_CLOSED"
}

Chargeback initiated notification

Notifies you when a new chargeback case is opened. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

object

The chargeback case this notification refers to, as of its current status

object

Additional details about the chargeback case

notificationType
string

The type of event that triggered this notification
Example: CHARGEBACK_INITIATED

Responses

Request samples

Content type
application/json

Chargeback information including the processing account and transaction it refers to.

{
  • "notificationId": "56562de8-9b89-4628-b2fe-cd1b2cc1e95b",
  • "chargeback": {
    },
  • "data": {
    },
  • "notificationType": "CHARGEBACK_INITIATED"
}

Chargeback updated notification

Notifies you about updates on an existing chargeback case, such as representment or arbitration steps. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

object

The chargeback case this notification refers to, as of its current status

updateType
string

The type of update applied to the chargeback case
• ARBITRATION_INITIATED The consumer PSP initiated arbitration
• NEW_MESSAGE A new message was added to the case
• PRE_ARBITRATION_DECLINED The acceptor PSP declined the pre-arbitration request
• PRE_ARBITRATION_INITIATED The consumer PSP declined the representment evidence and escalated the case to pre-arbitration
• REPRESENTED The acceptor PSP submitted representment evidence to contest the chargeback

object

Additional details about the chargeback update. The structure depends on the value of updateType

notificationType
string

The type of event that triggered this notification
Example: CHARGEBACK_UPDATED

Responses

Request samples

Content type
application/json
Example

A new message was added to the case.

{
  • "notificationId": "56562de8-9b89-4628-b2fe-cd1b2cc1e95b",
  • "chargeback": {
    },
  • "updateType": "NEW_MESSAGE",
  • "data": {
    },
  • "notificationType": "CHARGEBACK_UPDATED"
}

Chargeback closed notification

Notifies you when a chargeback case is closed. The exact path of the request is configured through our portal.

Request Body schema: application/json
required
notificationId
string <uuid>

Unique id of the notification
Example: 56562de8-9b89-4628-b2fe-cd1b2cc1e95b

object

The chargeback case this notification refers to, as of its current status

reason
string

The reason why the chargeback case was closed
• ARBITRATION_ACCEPTED The acceptor PSP accepted the arbitration
• ARBITRATION_IN_FAVOR_OF_ACCEPTOR_PSP Arbitration was resolved in favor of the acceptor PSP
• ARBITRATION_IN_FAVOR_OF_CONSUMER_PSP Arbitration was resolved in favor of the consumer PSP
• ARBITRATION_WITHDRAWN The consumer PSP withdrew the arbitration
• CHARGEBACK_ACCEPTED The acceptor PSP accepted the chargeback without submitting representment
• PRE_ARBITRATION_ACCEPTED The acceptor PSP accepted the pre-arbitration request
• PRE_ARBITRATION_DECLINE_ACCEPTED The decline of the pre-arbitration request was accepted
• PRE_ARBITRATION_WITHDRAWN The consumer PSP withdrew the pre-arbitration request
• REPRESENTMENT_ACCEPTED The consumer PSP accepted the representment

object

Additional details about the chargeback closure. The structure depends on the value of reason

notificationType
string

The type of event that triggered this notification
Example: CHARGEBACK_CLOSED

Responses

Request samples

Content type
application/json
Example

The chargeback was accepted without representment.

{
  • "notificationId": "56562de8-9b89-4628-b2fe-cd1b2cc1e95b",
  • "chargeback": {
    },
  • "reason": "CHARGEBACK_ACCEPTED",
  • "data": {
    },
  • "notificationType": "CHARGEBACK_CLOSED"
}

Reporting APIs

This section provides endpoints for accessing and downloading financial reports generated by the Nopan platform. Reports are available for a range of types including transaction details, fee breakdowns, bank addendum data, and settlement summaries. Reports can be searched by date range, organization, or processing account, and downloaded by ID.

Search reports

Search for financial reports by date range, organization, or processing account.

query Parameters
from
required
string <date-time>

Start of the date range filter
Example: 2025-01-01T00:00:00Z

to
required
string <date-time>

End of the date range filter
Example: 2025-01-31T23:59:59Z

organizationId
string
Deprecated

Deprecated and ignored: the organization comes from your credentials. A different value is rejected with 403.

contractualEntityId
string

The contractual entity ID associated with the organization
Example: entity-5678

processingAccountId
string

Unique identifier of the processing account under which the payment is processed.
Example: pa-1234

name
string

The report file name
Example: TRANSACTION_DETAILS_merchant-123_550e8400-e29b-41d4-a716-446655440000_20260101

type
string

Filter results by report type

Responses

Response samples

Content type
application/json
{
  • "files": [
    ],
  • "totalCount": 0
}

Download report

Download a report file by its ID.

query Parameters
reportId
required
string non-empty

Unique identifier of the report. Must be a valid UUID.
Example: 550e8400-e29b-41d4-a716-446655440000

organizationId
string
Deprecated

Deprecated and ignored: the organization comes from your credentials. A different value is rejected with 403.

Responses

Response samples

Content type
application/json
{
  • "statusInfo": {
    },
  • "callId": "string",
  • "status": "string",
  • "fields": {
    }
}

Organization APIs

This section provides endpoints to create and search the processing accounts of your organization.

Create processing accounts

Creates one or more processing accounts. See How to create a processing account to understand the fields to be submitted. Requires the accounts:write scope.

Request Body schema: application/json
required
Array
processingAccountId
string [ 6 .. 15 ] characters

Your own identifier for the account, between 6 and 15 characters. When omitted, Nopan generates one and returns it in the response. When given, it must be unique.
Example: pa-1234

contractualEntityId
required
string non-empty

The contractual entity the account is created under.
Example: abc123

name
required
string [ 0 .. 100 ] characters

A name for the account, up to 100 characters. For a PAYFAC organization, it is the name of the merchant (DBA, Doing Business As) the account is for.
Example: BLIK account

settlementCurrency
required
string = 3 characters

The currency the account is paid out in, as an ISO 4217 code. An account has a single settlement currency.
Example: EUR

providerId
required
string

The payment method of the account. An account has one payment method. A payment method that is not available yet is rejected.
Example: BLIK

required
object

The payout destination of the account. Only one bank account can be submitted per processing account.

object

The business the account is for. Which fields are required depends on your organization type and the payment method: a PAYFAC account always submits the legal entity name, address, city, country and MCC, and a Wero account also submits the disputes contact (name and email). A MERCHANT account submits nothing otherwise.

Responses

Request samples

Content type
application/json
Example

A merchant organization creates an account for BLIK, which needs no merchant details

[
  • {
    }
]

Response samples

Content type
application/json

The accounts are created and are being set up

[
  • {
    }
]

Search processing accounts

Returns the processing accounts of your organization, optionally filtered by contractual entity, processing account, payment method or status. Requires the accounts:read scope.

query Parameters
contractualEntityId
string
Example: contractualEntityId=entity-1234

The contractual entity ID associated with the organization
Example: entity-5678

processingAccountId
string
Example: processingAccountId=pa-9012

Unique identifier of the processing account under which the payment is processed.
Example: pa-1234

providerId
string
Example: providerId=BLIK

Filter by payment provider. A provider that is not supported yet is rejected.

status
string

The response status
• PROVISIONING PROVISIONING
• CREATED CREATED
• LOCKED LOCKED
• OPENED OPENED
• DISABLED DISABLED
• CLOSED CLOSED

pageNumber
integer <int32> >= 0
Default: 0
Example: pageNumber=0

Page to return, starting at 0.

pageSize
integer <int32> [ 1 .. 100 ]
Default: 50
Example: pageSize=50

Accounts per page, from 1 to 100.

Responses

Response samples

Content type
application/json

A page with a merchant account and a payment facilitator account

{
  • "processingAccounts": [
    ],
  • "totalCount": 2,
  • "pageNumber": 0,
  • "pageSize": 50,
  • "totalPages": 1
}