Create a one-time Invoice payment intent

post

https://api.wingspan.app/v3/payments/invoice-payment-intents

Selects one request-scoped rail and returns its short-lived capture action. Saved payment-method identifiers and raw financial credentials are never accepted.

Returns 409 InvalidStateTransition with detailCode payments.PaymentMethodNotAllowed when the Invoice does not accept the requested rail — a conflict no re-read can clear, so retry with the other rail rather than a fresh ETag. Reusing an Idempotency-Key with a different body returns 409 IdempotencyKeyConflict with detailCode payments.IdempotencyKeyConflict. An upstream response that cannot be projected onto this contract returns 503 ServiceUnavailable with detailCode payments.UpstreamContractViolation.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

paymentMethodType

string

enum

required

The kind of resource backing a payment method. A payment method is a concept, not a single resource: several resource types can serve as one. Extensible over time.

Allowed:

metadata

object

Free-form key-value pairs. Max 50 keys; key length at most 40 characters; value length at most 500 characters. Where a list endpoint declares metadata filtering, it uses the QueryQL namespace via filter[metadata.{key}][eq]=value or filter[metadata.{key}][in][]=value. Endpoints that do not declare the dynamic Metadata filter do not support Metadata filtering.

Headers

Idempotency-Key

string

required

length between 1 and 255

^[\x21-\x7e]{1,255}$

REQUIRED idempotency token for money-moving requests (e.g. transfers). The token is used by the API so a retry after a 5xx/timeout replays the original result instead of moving funds twice. Reuse the same key to retry safely; use a NEW key to issue a genuinely new transfer. Use 1-255 printable ASCII characters.

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

Bearer

OpaqueInvoicePaymentCapability

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201Intent created with a method-specific capture action.

401Unauthenticated

404Resource not found

409Conflict

422Validation error

429Quota exhausted for the target Account or its Organization (code: RateLimitExceeded). Retry-After carries the back-off in seconds; the response extensions identify the exhausted quota bucket.

503A downstream dependency is temporarily unavailable; retryable. Body carries code: ServiceUnavailable and may include extensions.retryAfter.