curl --request POST \
--url https://api.piriod.com/payments/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-simple-workspace: <x-simple-workspace>' \
--data '
{
"amount": 123,
"currency": "<string>",
"date": "2023-12-25",
"description": "<string>",
"invoice": "<string>",
"subscription": "<string>",
"customer": "<string>",
"payment_date": "2023-11-07T05:31:56Z",
"source": 123,
"sources": [
123
],
"status": "requires_payment_method",
"return_url": "<string>",
"enable_checkout": true,
"metadata": {}
}
'import requests
url = "https://api.piriod.com/payments/"
payload = {
"amount": 123,
"currency": "<string>",
"date": "2023-12-25",
"description": "<string>",
"invoice": "<string>",
"subscription": "<string>",
"customer": "<string>",
"payment_date": "2023-11-07T05:31:56Z",
"source": 123,
"sources": [123],
"status": "requires_payment_method",
"return_url": "<string>",
"enable_checkout": True,
"metadata": {}
}
headers = {
"x-simple-workspace": "<x-simple-workspace>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-simple-workspace': '<x-simple-workspace>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 123,
currency: '<string>',
date: '2023-12-25',
description: '<string>',
invoice: '<string>',
subscription: '<string>',
customer: '<string>',
payment_date: '2023-11-07T05:31:56Z',
source: 123,
sources: [123],
status: 'requires_payment_method',
return_url: '<string>',
enable_checkout: true,
metadata: {}
})
};
fetch('https://api.piriod.com/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://api.piriod.com/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' => 123,
'currency' => '<string>',
'date' => '2023-12-25',
'description' => '<string>',
'invoice' => '<string>',
'subscription' => '<string>',
'customer' => '<string>',
'payment_date' => '2023-11-07T05:31:56Z',
'source' => 123,
'sources' => [
123
],
'status' => 'requires_payment_method',
'return_url' => '<string>',
'enable_checkout' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-simple-workspace: <x-simple-workspace>"
],
]);
$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://api.piriod.com/payments/"
payload := strings.NewReader("{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"invoice\": \"<string>\",\n \"subscription\": \"<string>\",\n \"customer\": \"<string>\",\n \"payment_date\": \"2023-11-07T05:31:56Z\",\n \"source\": 123,\n \"sources\": [\n 123\n ],\n \"status\": \"requires_payment_method\",\n \"return_url\": \"<string>\",\n \"enable_checkout\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-simple-workspace", "<x-simple-workspace>")
req.Header.Add("Authorization", "<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://api.piriod.com/payments/")
.header("x-simple-workspace", "<x-simple-workspace>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"invoice\": \"<string>\",\n \"subscription\": \"<string>\",\n \"customer\": \"<string>\",\n \"payment_date\": \"2023-11-07T05:31:56Z\",\n \"source\": 123,\n \"sources\": [\n 123\n ],\n \"status\": \"requires_payment_method\",\n \"return_url\": \"<string>\",\n \"enable_checkout\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.piriod.com/payments/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"invoice\": \"<string>\",\n \"subscription\": \"<string>\",\n \"customer\": \"<string>\",\n \"payment_date\": \"2023-11-07T05:31:56Z\",\n \"source\": 123,\n \"sources\": [\n 123\n ],\n \"status\": \"requires_payment_method\",\n \"return_url\": \"<string>\",\n \"enable_checkout\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"amount": 123,
"currency": "<string>",
"date": "2023-12-25",
"description": "<string>",
"id": 123,
"invoice": "<string>",
"subscription": "<string>",
"customer": "<string>",
"balance": 123,
"payment_date": "2023-11-07T05:31:56Z",
"source": 123,
"sources": [
123
],
"status": "requires_payment_method",
"failed_reason": "<string>",
"return_url": "<string>",
"enable_checkout": true,
"metadata": {},
"test_mode": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}{
"name": [
"This field is required."
],
"non_field_errors": [
"x-simple-workspace header is required."
]
}Create payment
curl --request POST \
--url https://api.piriod.com/payments/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-simple-workspace: <x-simple-workspace>' \
--data '
{
"amount": 123,
"currency": "<string>",
"date": "2023-12-25",
"description": "<string>",
"invoice": "<string>",
"subscription": "<string>",
"customer": "<string>",
"payment_date": "2023-11-07T05:31:56Z",
"source": 123,
"sources": [
123
],
"status": "requires_payment_method",
"return_url": "<string>",
"enable_checkout": true,
"metadata": {}
}
'import requests
url = "https://api.piriod.com/payments/"
payload = {
"amount": 123,
"currency": "<string>",
"date": "2023-12-25",
"description": "<string>",
"invoice": "<string>",
"subscription": "<string>",
"customer": "<string>",
"payment_date": "2023-11-07T05:31:56Z",
"source": 123,
"sources": [123],
"status": "requires_payment_method",
"return_url": "<string>",
"enable_checkout": True,
"metadata": {}
}
headers = {
"x-simple-workspace": "<x-simple-workspace>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-simple-workspace': '<x-simple-workspace>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
amount: 123,
currency: '<string>',
date: '2023-12-25',
description: '<string>',
invoice: '<string>',
subscription: '<string>',
customer: '<string>',
payment_date: '2023-11-07T05:31:56Z',
source: 123,
sources: [123],
status: 'requires_payment_method',
return_url: '<string>',
enable_checkout: true,
metadata: {}
})
};
fetch('https://api.piriod.com/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://api.piriod.com/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' => 123,
'currency' => '<string>',
'date' => '2023-12-25',
'description' => '<string>',
'invoice' => '<string>',
'subscription' => '<string>',
'customer' => '<string>',
'payment_date' => '2023-11-07T05:31:56Z',
'source' => 123,
'sources' => [
123
],
'status' => 'requires_payment_method',
'return_url' => '<string>',
'enable_checkout' => true,
'metadata' => [
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-simple-workspace: <x-simple-workspace>"
],
]);
$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://api.piriod.com/payments/"
payload := strings.NewReader("{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"invoice\": \"<string>\",\n \"subscription\": \"<string>\",\n \"customer\": \"<string>\",\n \"payment_date\": \"2023-11-07T05:31:56Z\",\n \"source\": 123,\n \"sources\": [\n 123\n ],\n \"status\": \"requires_payment_method\",\n \"return_url\": \"<string>\",\n \"enable_checkout\": true,\n \"metadata\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-simple-workspace", "<x-simple-workspace>")
req.Header.Add("Authorization", "<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://api.piriod.com/payments/")
.header("x-simple-workspace", "<x-simple-workspace>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"invoice\": \"<string>\",\n \"subscription\": \"<string>\",\n \"customer\": \"<string>\",\n \"payment_date\": \"2023-11-07T05:31:56Z\",\n \"source\": 123,\n \"sources\": [\n 123\n ],\n \"status\": \"requires_payment_method\",\n \"return_url\": \"<string>\",\n \"enable_checkout\": true,\n \"metadata\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.piriod.com/payments/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"amount\": 123,\n \"currency\": \"<string>\",\n \"date\": \"2023-12-25\",\n \"description\": \"<string>\",\n \"invoice\": \"<string>\",\n \"subscription\": \"<string>\",\n \"customer\": \"<string>\",\n \"payment_date\": \"2023-11-07T05:31:56Z\",\n \"source\": 123,\n \"sources\": [\n 123\n ],\n \"status\": \"requires_payment_method\",\n \"return_url\": \"<string>\",\n \"enable_checkout\": true,\n \"metadata\": {}\n}"
response = http.request(request)
puts response.read_body{
"amount": 123,
"currency": "<string>",
"date": "2023-12-25",
"description": "<string>",
"id": 123,
"invoice": "<string>",
"subscription": "<string>",
"customer": "<string>",
"balance": 123,
"payment_date": "2023-11-07T05:31:56Z",
"source": 123,
"sources": [
123
],
"status": "requires_payment_method",
"failed_reason": "<string>",
"return_url": "<string>",
"enable_checkout": true,
"metadata": {},
"test_mode": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}{
"name": [
"This field is required."
],
"non_field_errors": [
"x-simple-workspace header is required."
]
}Authorizations
Use header Authorization: Token <api_token>.
API tokens are obtained from the Piriod dashboard.
Headers
Workspace (account) identifier. Required for every request.
Whether to operate against test-mode data. Defaults to false.
Body
ISO currency code.
256Invoice ID this payment applies to.
Subscription ID when generated by a subscription cycle.
Effective date the payment was completed.
Primary source ID. (Legacy single source link.)
All source IDs linked to this payment (multi-source support).
cancelled, failed, incomplete, processing, requires_payment_method, succeeded URL the payer is sent back to after a redirect-flow checkout.
Whether the publishable checkout /pay/ is reachable for this payment.
Response
Payment created.
ISO currency code.
256Invoice ID this payment applies to.
Subscription ID when generated by a subscription cycle.
Remaining balance to charge against this payment.
Effective date the payment was completed.
Primary source ID. (Legacy single source link.)
All source IDs linked to this payment (multi-source support).
cancelled, failed, incomplete, processing, requires_payment_method, succeeded Reason code when status=failed.
URL the payer is sent back to after a redirect-flow checkout.
Whether the publishable checkout /pay/ is reachable for this payment.
