Skip to main content
Cancel transfer

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

Path Parameters

transferId
string
required

Response

Invalid request.

type
string<uri>
required

Documentation URL for this stable problem code.

title
string
required

Short human-readable problem title.

status
integer
required

HTTP status code.

Required range: 400 <= x <= 599
code
string
required

Stable snake_case error code.

detail
string
required

Actionable problem detail for legitimate callers.

correlationId
string
required

Request correlation id. Mirrors X-Request-Id.

transferId
string

Existing transfer that consumed the quote. Present on quote_already_executed.

retryable
boolean

Whether retrying the same request may succeed.

errors
object[]

Field-level validation errors.

statusReason
object

Structured reason for a state conflict when the failed operation depends on the resource's current status.

reviewAnswer
string | null

Verification review answer when supplied by the verifier.

capabilities
string[]

Capability ids that satisfy the failed operation.

Minimum array length: 1
blockingResources
object[]

Customer resources that must be resolved before the requested operation can proceed, sorted by type and id.

Minimum array length: 1