Skip to main content
PUT
/
payments
/
{id}
Update a payment
curl --request PUT \
  --url https://api.cloud.flexprice.io/v1/payments/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "error_message": "<string>",
  "failed_at": "<string>",
  "gateway_payment_id": "<string>",
  "metadata": {},
  "payment_gateway": "<string>",
  "payment_method_id": "<string>",
  "payment_status": "<string>",
  "succeeded_at": "<string>"
}'
{
  "amount": 123,
  "attempts": [
    {
      "attempt_number": 123,
      "created_at": "<string>",
      "created_by": "<string>",
      "error_message": "<string>",
      "id": "<string>",
      "metadata": {},
      "payment_id": "<string>",
      "tenant_id": "<string>",
      "updated_at": "<string>",
      "updated_by": "<string>"
    }
  ],
  "created_at": "<string>",
  "created_by": "<string>",
  "currency": "<string>",
  "destination_id": "<string>",
  "destination_type": "INVOICE",
  "error_message": "<string>",
  "failed_at": "<string>",
  "gateway_metadata": {},
  "gateway_payment_id": "<string>",
  "gateway_tracking_id": "<string>",
  "id": "<string>",
  "idempotency_key": "<string>",
  "invoice_number": "<string>",
  "metadata": {},
  "payment_gateway": "<string>",
  "payment_method_id": "<string>",
  "payment_method_type": "CARD",
  "payment_status": "INITIATED",
  "payment_url": "<string>",
  "refunded_at": "<string>",
  "save_card_and_make_default": true,
  "succeeded_at": "<string>",
  "tenant_id": "<string>",
  "track_attempts": true,
  "updated_at": "<string>",
  "updated_by": "<string>"
}

Authorizations

​
x-api-key
string
header
required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

​
id
string
required

Payment ID

Body

application/json

Payment configuration

​
error_message
string
​
failed_at
string
​
gateway_payment_id
string
​
metadata
object
​
payment_gateway
string
​
payment_method_id
string
​
payment_status
string
​
succeeded_at
string

Response

OK

​
amount
number
​
attempts
object[]
​
created_at
string
​
created_by
string
​
currency
string
​
destination_id
string
​
destination_type
enum<string>
Available options:
INVOICE
​
error_message
string
​
failed_at
string
​
gateway_metadata
object
​
gateway_payment_id
string
​
gateway_tracking_id
string
​
id
string
​
idempotency_key
string
​
invoice_number
string
​
metadata
object
​
payment_gateway
string
​
payment_method_id
string
​
payment_method_type
enum<string>
Available options:
CARD,
ACH,
OFFLINE,
CREDITS,
PAYMENT_LINK
​
payment_status
enum<string>
Available options:
INITIATED,
PENDING,
PROCESSING,
SUCCEEDED,
OVERPAID,
FAILED,
REFUNDED,
PARTIALLY_REFUNDED
​
payment_url
string
​
refunded_at
string
​
save_card_and_make_default
boolean
​
succeeded_at
string
​
tenant_id
string
​
track_attempts
boolean
​
updated_at
string
​
updated_by
string