Create a payment (agent pays on a customer's behalf)

payments.create() -> Payment

POST/v3/payments

Advances the pay flow for a connected customer handle and returns a status describing where it is (needs_connection, awaiting_user_action, ready, …). A payment id appears once a card is minted. Idempotent on the Idempotency-Key header.

ParametersExpand Collapse

amount_cents: int

formatint64

currency: str

handle: str

Customer phone (E.164) or email.

description: Optional[str]

merchant: Optional[Merchant]

name: Optional[str]

url: Optional[str]

metadata: Optional[Dict[str, str]]

ReturnsExpand Collapse

class Payment: …

id: Optional[str]

amount_cents: Optional[int]

formatint64

approval_url: Optional[str]

Present when the customer must approve with a passkey.

attach_url: Optional[str]

Present when the customer must attach a card.

currency: Optional[str]

description: Optional[str]

handle: Optional[str]

status: Optional[Literal["needs_connection", "connecting", "awaiting_user_action", 6 more]]

One of the following:

"needs_connection"

"connecting"

"awaiting_user_action"

"ready"

"authorized"

"succeeded"

"declined"

"canceled"

"expired"

Create a payment (agent pays on a customer's behalf)

import os
from linq import LinqAPIV3

client = LinqAPIV3(
    api_key=os.environ.get("LINQ_API_V3_API_KEY"),  # This is the default and can be omitted
)
payment = client.payments.create(
    amount_cents=2500,
    currency="usd",
    handle="+14155550123",
)
print(payment.id)

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "amount_cents": 2500,
  "approval_url": "approval_url",
  "attach_url": "attach_url",
  "currency": "usd",
  "description": "description",
  "handle": "+14155550123",
  "status": "ready"
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2005/"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2001/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}

Returns Examples

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "amount_cents": 2500,
  "approval_url": "approval_url",
  "attach_url": "attach_url",
  "currency": "usd",
  "description": "description",
  "handle": "+14155550123",
  "status": "ready"
}

{
  "error": {
    "status": 401,
    "code": 2004,
    "message": "Unauthorized - missing or invalid authentication token",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2004/"
  },
  "success": false
}

{
  "error": {
    "status": 403,
    "code": 2005,
    "message": "Access denied - insufficient permissions for this resource",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2005/"
  },
  "success": false
}

{
  "error": {
    "status": 404,
    "code": 2001,
    "message": "Resource not found",
    "doc_url": "https://docs.linqapp.com/error/codes/2xxx/2001/"
  },
  "success": false
}

{
  "error": {
    "status": 500,
    "code": 3006,
    "message": "Internal server error",
    "doc_url": "https://docs.linqapp.com/error/codes/3xxx/3006/"
  },
  "success": false
}