Skip to main content
PUT
/
payments
/
{id}
Update payment
curl --request PUT \
  --url https://us.api.flexprice.io/v1/payments/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "error_message": "<string>",
  "failed_at": "2023-11-07T05:31:56Z",
  "gateway_payment_id": "<string>",
  "metadata": {},
  "payment_gateway": "<string>",
  "payment_method_id": "<string>",
  "payment_status": "<string>",
  "refunded_at": "2023-11-07T05:31:56Z",
  "succeeded_at": "2023-11-07T05:31:56Z",
  "voided_at": "2023-11-07T05:31:56Z"
}
'
import requests

url = "https://us.api.flexprice.io/v1/payments/{id}"

payload = {
    "error_message": "<string>",
    "failed_at": "2023-11-07T05:31:56Z",
    "gateway_payment_id": "<string>",
    "metadata": {},
    "payment_gateway": "<string>",
    "payment_method_id": "<string>",
    "payment_status": "<string>",
    "refunded_at": "2023-11-07T05:31:56Z",
    "succeeded_at": "2023-11-07T05:31:56Z",
    "voided_at": "2023-11-07T05:31:56Z"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    error_message: '<string>',
    failed_at: '2023-11-07T05:31:56Z',
    gateway_payment_id: '<string>',
    metadata: {},
    payment_gateway: '<string>',
    payment_method_id: '<string>',
    payment_status: '<string>',
    refunded_at: '2023-11-07T05:31:56Z',
    succeeded_at: '2023-11-07T05:31:56Z',
    voided_at: '2023-11-07T05:31:56Z'
  })
};

fetch('https://us.api.flexprice.io/v1/payments/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://us.api.flexprice.io/v1/payments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'error_message' => '<string>',
    'failed_at' => '2023-11-07T05:31:56Z',
    'gateway_payment_id' => '<string>',
    'metadata' => [
        
    ],
    'payment_gateway' => '<string>',
    'payment_method_id' => '<string>',
    'payment_status' => '<string>',
    'refunded_at' => '2023-11-07T05:31:56Z',
    'succeeded_at' => '2023-11-07T05:31:56Z',
    'voided_at' => '2023-11-07T05:31:56Z'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://us.api.flexprice.io/v1/payments/{id}"

	payload := strings.NewReader("{\n  \"error_message\": \"<string>\",\n  \"failed_at\": \"2023-11-07T05:31:56Z\",\n  \"gateway_payment_id\": \"<string>\",\n  \"metadata\": {},\n  \"payment_gateway\": \"<string>\",\n  \"payment_method_id\": \"<string>\",\n  \"payment_status\": \"<string>\",\n  \"refunded_at\": \"2023-11-07T05:31:56Z\",\n  \"succeeded_at\": \"2023-11-07T05:31:56Z\",\n  \"voided_at\": \"2023-11-07T05:31:56Z\"\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://us.api.flexprice.io/v1/payments/{id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"error_message\": \"<string>\",\n  \"failed_at\": \"2023-11-07T05:31:56Z\",\n  \"gateway_payment_id\": \"<string>\",\n  \"metadata\": {},\n  \"payment_gateway\": \"<string>\",\n  \"payment_method_id\": \"<string>\",\n  \"payment_status\": \"<string>\",\n  \"refunded_at\": \"2023-11-07T05:31:56Z\",\n  \"succeeded_at\": \"2023-11-07T05:31:56Z\",\n  \"voided_at\": \"2023-11-07T05:31:56Z\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://us.api.flexprice.io/v1/payments/{id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"error_message\": \"<string>\",\n  \"failed_at\": \"2023-11-07T05:31:56Z\",\n  \"gateway_payment_id\": \"<string>\",\n  \"metadata\": {},\n  \"payment_gateway\": \"<string>\",\n  \"payment_method_id\": \"<string>\",\n  \"payment_status\": \"<string>\",\n  \"refunded_at\": \"2023-11-07T05:31:56Z\",\n  \"succeeded_at\": \"2023-11-07T05:31:56Z\",\n  \"voided_at\": \"2023-11-07T05:31:56Z\"\n}"

response = http.request(request)
puts response.read_body
{
  "amount": "<string>",
  "attempts": [
    {
      "attempt_number": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "error_message": "<string>",
      "id": "<string>",
      "metadata": {},
      "payment_id": "<string>",
      "tenant_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "currency": "<string>",
  "destination_id": "<string>",
  "error_message": "<string>",
  "failed_at": "2023-11-07T05:31:56Z",
  "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_url": "<string>",
  "refunded_at": "2023-11-07T05:31:56Z",
  "save_card_and_make_default": true,
  "succeeded_at": "2023-11-07T05:31:56Z",
  "tenant_id": "<string>",
  "track_attempts": true,
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>",
  "voided_at": "2023-11-07T05:31:56Z"
}
{
  "http_status_code": 123,
  "message": "<string>"
}
{
  "http_status_code": 123,
  "message": "<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<date-time>
gateway_payment_id
string
metadata
object
payment_gateway
string
payment_method_id
string
payment_status
string
refunded_at
string<date-time>
succeeded_at
string<date-time>
voided_at
string<date-time>

Response

Updated payment

amount
string
attempts
object[]
created_at
string<date-time>
created_by
string
currency
string
destination_id
string
destination_type
enum<string>
Available options:
INVOICE,
CUSTOMER
error_message
string
failed_at
string<date-time>
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,
VOIDED
payment_url
string
refunded_at
string<date-time>
save_card_and_make_default
boolean
succeeded_at
string<date-time>
tenant_id
string
track_attempts
boolean
updated_at
string<date-time>
updated_by
string
voided_at
string<date-time>