Create payment
curl --request POST \
--url https://us.api.flexprice.io/v1/payments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": "<string>",
"currency": "<string>",
"destination_id": "<string>",
"cancel_url": "<string>",
"idempotency_key": "<string>",
"metadata": {},
"payment_method_id": "<string>",
"process_payment": true,
"save_card_and_make_default": false,
"success_url": "<string>"
}
'import requests
url = "https://us.api.flexprice.io/v1/payments"
payload = {
"amount": "<string>",
"currency": "<string>",
"destination_id": "<string>",
"cancel_url": "<string>",
"idempotency_key": "<string>",
"metadata": {},
"payment_method_id": "<string>",
"process_payment": True,
"save_card_and_make_default": False,
"success_url": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '<string>',
currency: '<string>',
destination_id: '<string>',
cancel_url: '<string>',
idempotency_key: '<string>',
metadata: {},
payment_method_id: '<string>',
process_payment: true,
save_card_and_make_default: false,
success_url: '<string>'
})
};
fetch('https://us.api.flexprice.io/v1/payments', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => '<string>',
'currency' => '<string>',
'destination_id' => '<string>',
'cancel_url' => '<string>',
'idempotency_key' => '<string>',
'metadata' => [
],
'payment_method_id' => '<string>',
'process_payment' => true,
'save_card_and_make_default' => false,
'success_url' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"destination_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_method_id\": \"<string>\",\n \"process_payment\": true,\n \"save_card_and_make_default\": false,\n \"success_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://us.api.flexprice.io/v1/payments")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"destination_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_method_id\": \"<string>\",\n \"process_payment\": true,\n \"save_card_and_make_default\": false,\n \"success_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"destination_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_method_id\": \"<string>\",\n \"process_payment\": true,\n \"save_card_and_make_default\": false,\n \"success_url\": \"<string>\"\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>"
}Payments
Create payment
Use when recording a payment against an invoice (e.g. after receiving funds via a gateway or manual entry).
POST
/
payments
Create payment
curl --request POST \
--url https://us.api.flexprice.io/v1/payments \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"amount": "<string>",
"currency": "<string>",
"destination_id": "<string>",
"cancel_url": "<string>",
"idempotency_key": "<string>",
"metadata": {},
"payment_method_id": "<string>",
"process_payment": true,
"save_card_and_make_default": false,
"success_url": "<string>"
}
'import requests
url = "https://us.api.flexprice.io/v1/payments"
payload = {
"amount": "<string>",
"currency": "<string>",
"destination_id": "<string>",
"cancel_url": "<string>",
"idempotency_key": "<string>",
"metadata": {},
"payment_method_id": "<string>",
"process_payment": True,
"save_card_and_make_default": False,
"success_url": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
amount: '<string>',
currency: '<string>',
destination_id: '<string>',
cancel_url: '<string>',
idempotency_key: '<string>',
metadata: {},
payment_method_id: '<string>',
process_payment: true,
save_card_and_make_default: false,
success_url: '<string>'
})
};
fetch('https://us.api.flexprice.io/v1/payments', 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",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'amount' => '<string>',
'currency' => '<string>',
'destination_id' => '<string>',
'cancel_url' => '<string>',
'idempotency_key' => '<string>',
'metadata' => [
],
'payment_method_id' => '<string>',
'process_payment' => true,
'save_card_and_make_default' => false,
'success_url' => '<string>'
]),
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"
payload := strings.NewReader("{\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"destination_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_method_id\": \"<string>\",\n \"process_payment\": true,\n \"save_card_and_make_default\": false,\n \"success_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", 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.post("https://us.api.flexprice.io/v1/payments")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"destination_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_method_id\": \"<string>\",\n \"process_payment\": true,\n \"save_card_and_make_default\": false,\n \"success_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://us.api.flexprice.io/v1/payments")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": \"<string>\",\n \"currency\": \"<string>\",\n \"destination_id\": \"<string>\",\n \"cancel_url\": \"<string>\",\n \"idempotency_key\": \"<string>\",\n \"metadata\": {},\n \"payment_method_id\": \"<string>\",\n \"process_payment\": true,\n \"save_card_and_make_default\": false,\n \"success_url\": \"<string>\"\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
Enter your API key in the format x-api-key <api-key>*
Body
application/json
Payment configuration
Available options:
INVOICE, CUSTOMER Available options:
CARD, ACH, OFFLINE, CREDITS, PAYMENT_LINK, UPI Show child attributes
Show child attributes
Available options:
stripe, razorpay, nomod, moyasar, paddle, whop Response
Created payment
Show child attributes
Show child attributes
Available options:
INVOICE, CUSTOMER Show child attributes
Show child attributes
Show child attributes
Show child attributes
Available options:
CARD, ACH, OFFLINE, CREDITS, PAYMENT_LINK, UPI Available options:
INITIATED, PENDING, PROCESSING, SUCCEEDED, OVERPAID, FAILED, REFUNDED, PARTIALLY_REFUNDED, VOIDED ⌘I

