Skip to main content
PATCH
/
collect
/
payment_request
/
{id}
curl --request PATCH \
  --url https://api.momentco.io/collect/payment_request/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: <idempotency-key>' \
  --data '{
  "external_reference": "V-134",
  "description": "Updated Payment Request"
}'
{
  "id": "pr_6phg74i4jG9wbzZbFDUQB",
  "type": "link",
  "status": "active",
  "amount": 10000,
  "currency": "ZAR",
  "external_reference": "INV-2024-001",
  "description": "Product purchase",
  "expires_at": "2025-06-17T10:30:00Z",
  "link": {
    "checkout_session_id": "chk_G9wbzZbFDUQBFAE",
    "link_url": "https://links.momentpay.io/G9wbzZbFDUQBFAE"
  },
  "metadata": {
    "customer_id": "cust_123456",
    "order_id": "ord_789012"
  },
  "created_at": "2025-06-16T10:30:00Z",
  "updated_at": "2025-06-16T10:30:00Z"
}

Authorizations

​
Authorization
string
header
required

Headers

​
Idempotency-Key
string<uuid>
required
Required string length: 1 - 255

Path Parameters

​
id
string
required
Example:

Body

application/json
​
external_reference
string
Maximum length: 255
Example:
​
description
string
Maximum length: 500
Example:
​
expires_at
string<date-time> | null
Example:
​
metadata
object
Example:

Response

​
id
string
Example:
​
type
enum<string>
default:link
Available options:
link,
push
Example:
​
status
enum<string>
Available options:
active,
paid,
expired,
failed
Example:
​
payment_id
string
Example:
​
amount
integer
Example:
​
currency
string
Example:
​
external_reference
string
Maximum length: 255
Example:
​
expires_at
string<date-time> | null
Example:
​
description
string
Maximum length: 500
Example:
​
link
object
​
push
object
​
metadata
object
Example:
​
created_at
string<date-time>
Example:
​
updated_at
string<date-time>
Example: