Skip to main content

Create Transaction

POST 
/v1/transactions

Mandatory fields are amount, currency and ip.

Request​

Body

    transaction

    object

    required

    amount stringrequired

    The transaction amount

    currency stringrequired

    The currency code for the transaction

    reference string

    The unique reference for the transaction

    merchant_data string

    Additional merchant data related to the transaction

    recurring_required string

    Specifies if recurring payments are required

    transaction_url

    object

    return_url

    object

    URL and method to return after successful payment

    url string

    The URL to return to

    method string

    The HTTP method (e.g., GET, POST) for the return link

    cancel_url

    object

    URL and method for canceled payment

    url string

    The URL to return to

    method string

    The HTTP method (e.g., GET, POST) for the return link

    notification_url

    object

    URL and method for payment notifications

    url string

    The URL to return to

    method string

    The HTTP method (e.g., GET, POST) for the return link

    customer

    object

    required

    email string

    Customer's email address

    ip stringrequired

    Customer's IP address

    country string

    Customer's country code - Default will be chosen if not provided

    locale string

    Preferred language/locale of the customer - Default will be chosen if not provided

    app_info

    object

    module string

    Name of the module/application used

    module_version string

    Version of the module/application

    platform stringrequired

    Platform name, that the request is sent from. (Up to 64 characters) Required only if app_info is used in the request

    platform_version string

    Version of the platform the module runs on

Responses​

Created

Response Headers

  • Date

    string

  • Content-Type

    string

  • Transfer-Encoding

    string

  • Connection

    string

  • Set-Cookie

    string

  • Access-Control-Allow-Origin

    string

  • Access-Control-Allow-Methods

    string

  • Access-Control-Allow-Headers

    string

  • X-Request-ID

    string

  • Location

    string

Schema

    _links

    object

    Pay

    object

    href string

    self

    object

    href string

    payment_methods

    object

    Possible payment methods for the transaction.
    ** Optional field, displayed only when transaction refunded **

    banklinks

    object[]

    Array of banklink payment methods

  • Array [

    • name string

    The name of the payment method

    url string

    URL related to the payment method

    country string

    Single country associated with the payment method

    countries string[]

    List of countries associated with the payment method - EE, LV, LT or FI

    min_amount double

    The minimum amount value

    max_amount double

    The maximum amount value

    channel string

    Channel information

    display_name string

    Display name for the payment method

    logo_url string

    URL of the payment method's logo

  • ]

    • cards

    object[]

    Array of card payment methods

  • Array [

    • name string

    The name of the payment method

    url string

    URL related to the payment method

    country string

    Single country associated with the payment method

    countries string[]

    List of countries associated with the payment method - EE, LV, LT or FI

    min_amount double

    The minimum amount value

    max_amount double

    The maximum amount value

    channel string

    Channel information

    display_name string

    Display name for the payment method

    logo_url string

    URL of the payment method's logo

  • ]

    • payLater

    object[]

    Array of pay Later methods

  • Array [

    • name string

    The name of the payment method

    url string

    URL related to the payment method

    country string

    Single country associated with the payment method

    countries string[]

    List of countries associated with the payment method - EE, LV, LT or FI

    min_amount double

    The minimum amount value

    max_amount double

    The maximum amount value

    channel string

    Channel information

    display_name string

    Display name for the payment method

    logo_url string

    URL of the payment method's logo

  • ]

    • other

    object[]

    Array of other methods

  • Array [

    • name string

    The name of the payment method

    url string

    URL related to the payment method

    country string

    Single country associated with the payment method

    countries string[]

    List of countries associated with the payment method - EE, LV, LT or FI

    min_amount double

    The minimum amount value

    max_amount double

    The maximum amount value

    channel string

    Channel information

    display_name string

    Display name for the payment method

    logo_url string

    URL of the payment method's logo

  • ]

    • id string

    Unique identifier for the transaction

    object string

    Type of the transaction object

    created_at date-time

    Timestamp when the transaction was created

    completed_at date-time

    Timestamp when the transaction was completed. Optional field, displayed only when transaction is completed

    refunded_at date-time

    Timestamp when the transaction was refunded. Optional field, displayed only when transaction is refunded

    status string

    Current status of the transaction

    reference string

    Merchant's reference number for the transaction

    customer

    object

    The customer information related to this transaction

    id string

    The unique identifier for the customer

    object string

    The type of object (e.g., customer)

    created_at date-time

    The timestamp when the customer was created

    email string

    The email address of the customer

    locale string

    The locale of the customer, representing language and region

    country string

    The country of the customer

    ip string

    The IP address of the customer

    ip_country string

    The country associated with the customer's IP address

    name string

    The name of the customer

    refunded_amount double

    Amount refunded for this transaction. Optional field, displayed only when transaction is refunded

    refunded_original_amount double

    Original amount refunded. Optional field, displayed only when transaction is refunded

    type string

    Type of transaction. Shows payment type - banklink or card

    method string

    Payment method used in the transaction

    channel string

    Payment channel through which the transaction was made

    country string

    Country where the transaction was made

    fees double

    Transaction fees. Optional field, displayed only when transaction is completed

    fees_vat double

    VAT on transaction fees. Optional field, displayed only when transaction is completed

    net_amount double

    Net amount received by the merchant. Optional field, displayed only when transaction is completed

    merchant_data string

    Additional merchant-specific data

    banklink

    object

    Details of banklink payment. Optional field, displayed only when transaction type is banklink

    object string

    The type of object, e.g., 'banklink_payment'.

    created_at date-time

    The date and time when the payment was created, in ISO 8601 format.

    iban string

    The International Bank Account Number associated with the payment.

    description string

    A description of the payment.

    card

    object

    Details of Card payment. Optional field, displayed only when transaction type is card

    card_holder_name string

    Name of the cardholder

    card_number string

    Masked card number used in the payment

    expiry_date string

    Expiry date of the card

    card_type string

    Type of card (e.g., Visa, MasterCard)

    transaction_url

    object

    return_url

    object

    The URL and HTTP method to redirect after a successful operation

    url string

    The URL to return to

    method string

    The HTTP method (e.g., GET, POST) for the return link

    cancel_url

    object

    The URL and HTTP method to redirect when the operation is canceled

    url string

    The URL to return to

    method string

    The HTTP method (e.g., GET, POST) for the return link

    notification_url

    object

    The URL and HTTP method for notifications regarding the operation

    url string

    The URL to return to

    method string

    The HTTP method (e.g., GET, POST) for the return link

    cart_url

    object

    The URL and HTTP method to access the shopping cart

    url string

    The URL to return to

    method string

    The HTTP method (e.g., GET, POST) for the return link

    recurring_required boolean

    Indicates if recurring payments are required

Loading...