Skip to main content

Authorizations

X-API-Key
string
header
required

Your Swipelux API key. Obtain this from the Swipelux Dashboard.

Headers

Idempotency-Key
string
required

Required for effectful v3 requests (POST, PATCH, PUT, DELETE). Reuse the same key with the same body to replay the cached response.

Required string length: 1 - 255

Body

application/json
quoteId
string
required
Pattern: ^quo_[a-zA-Z0-9]+$
Example:

"quo_6dV8xN2pQ4rT7mA9sL1kBc"

checkoutMethod
enum<string>

Requested checkout method for a card-capability transfer, pre-selected in the provider-hosted checkout. Availability depends on the customer, device and provider; other available methods remain selectable. Checkout confirms final fees. Omit to retain the existing pre-selection. This is not confirmation of the method actually used. Open enum — values are added over time; clients must tolerate unknown values.

Available options:
card,
apple_pay,
google_pay,
cash_app,
sepa,
blik
redirectUrl
string<uri>

Absolute HTTPS URL, without embedded credentials, opened after a card or Apple Pay checkout that supports return navigation. Navigation to this URL is not confirmation that the transfer completed; use transfer lifecycle reads or webhooks for completion.

Maximum string length: 2048
Pattern: ^[hH][tT][tT][pP][sS]://
Example:

"https://merchant.example/payments/complete"

externalId
string

Merchant-supplied correlation reference echoed on reads and filterable on GET /v3/transfers. Not required to be unique; independent of the quote's externalId.

Required string length: 1 - 255
Example:

"your-transfer-ref-123"

memo
string

Free-text memo stored on the transfer resource.

Required string length: 1 - 140
Example:

"Invoice 118"

supportingDocuments
string[]

Up to 10 document ids previously uploaded for this customer and linked to the transfer.

Maximum array length: 10
Pattern: ^doc_[a-zA-Z0-9]+$
Example:

Response

Transfer created

data
object
required