Create Payment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

Define where the payment is created from

Allowed:
boolean
Defaults to false

The value that indicates if the payment should create a token with the given data. You should also define the "transactionMode" to "initialUnescheduled" or "initialRecurring". Tokenization is only available for cards and mbway at the moment.

string
enum

"transactionMode" is used for tokenization and tokenized payments. The value "initialUnescheduled" tokenizes details for future one-time, unscheduled payments. The value "initialRecurring' tokenizes details for the first in a series of scheduled payments. The value "cardHolderInitiatedUnescheduled" is for subsequent unscheduled payment initiated by the cardholder. The value "merchantInitiatedUnescheduled" is for unscheduled payment initiated by the merchant. The value "merchantInitiatedRecurring" is for subsequent scheduled payment initiated by the merchant.

Allowed:
string

This field represents the checkout fingerPrint. This field is required for tokenization.

string
required
deprecated

Please use the 'isoAmount' field. This is essential due to our multi-currency support.

int64

Total amount for this transaction in ISO format, with the following pattern "2500"

string

The Bank Swift Code

string

The card brand

card
object
string

The value sent to the shopper by email and sms if the payment flow with token requires a confirmation code

string
required

Valid ISO-4217 alpha code e.g EUR

string

Expiration datetime for MBWay and Multibanco References payments e.g. '2025-12-30T15:59:59+00:00' (ISO 8601 format)

boolean
Defaults to false

The value that indicates if the payment is a pre-authorization or not

string
required

Yours unique reference for this transaction

string

Url where the shopper will be redirected after the payment is done

string

Shopper's first name

string

Shopper's ip address

string

Shopper's last name

string

In the POS payment flow, it is necessary to identify which terminal initiated the payment. When this parameter is filled, the POS receives a notification to continue the transaction remotely, this feature is called Remote transaction.

string

This field contains the unique identifier that represents the token to be used in the payment.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json