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

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.

Body ParametersJSONExpand Collapse

amount_cents: number

formatint64

currency: string

handle: string

Customer phone (E.164) or email.

description: optional string

merchant: optional object { name, url }

name: optional string

url: optional string

metadata: optional map[string]

ReturnsExpand Collapse

Payment object { id, amount_cents, approval_url, 5 more }

id: optional string

amount_cents: optional number

formatint64

approval_url: optional string

Present when the customer must approve with a passkey.

attach_url: optional string

Present when the customer must attach a card.

currency: optional string

description: optional string

handle: optional string

status: optional "needs_connection" or "connecting" or "awaiting_user_action" or 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)

curl https://api.linqapp.com/api/partner/v3/payments \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $LINQ_API_V3_API_KEY" \
    -d '{
          "amount_cents": 2500,
          "currency": "usd",
          "handle": "+14155550123",
          "description": "Burger order"
        }'

{
  "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
}