Create a one-time payment

POST

payments

curl --request POST \
  --url https://api-sandbox.paygood.co/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "<string>",
  "customerId": "<string>",
  "merchantId": "<string>",
  "paymentInstrumentId": "<string>",
  "captureMethod": "automatic",
  "priceId": "<string>",
  "amount": 4503599627370495,
  "currency": "<string>",
  "description": "<string>",
  "metadata": {}
}
'

import requests

url = "https://api-sandbox.paygood.co/payments"

payload = {
    "idempotencyKey": "<string>",
    "customerId": "<string>",
    "merchantId": "<string>",
    "paymentInstrumentId": "<string>",
    "captureMethod": "automatic",
    "priceId": "<string>",
    "amount": 4503599627370495,
    "currency": "<string>",
    "description": "<string>",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: '<string>',
    customerId: '<string>',
    merchantId: '<string>',
    paymentInstrumentId: '<string>',
    captureMethod: 'automatic',
    priceId: '<string>',
    amount: 4503599627370495,
    currency: '<string>',
    description: '<string>',
    metadata: {}
  })
};

fetch('https://api-sandbox.paygood.co/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-sandbox.paygood.co/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([
    'idempotencyKey' => '<string>',
    'customerId' => '<string>',
    'merchantId' => '<string>',
    'paymentInstrumentId' => '<string>',
    'captureMethod' => 'automatic',
    'priceId' => '<string>',
    'amount' => 4503599627370495,
    'currency' => '<string>',
    'description' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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-sandbox.paygood.co/payments"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"merchantId\": \"<string>\",\n  \"paymentInstrumentId\": \"<string>\",\n  \"captureMethod\": \"automatic\",\n  \"priceId\": \"<string>\",\n  \"amount\": 4503599627370495,\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"metadata\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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-sandbox.paygood.co/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"merchantId\": \"<string>\",\n  \"paymentInstrumentId\": \"<string>\",\n  \"captureMethod\": \"automatic\",\n  \"priceId\": \"<string>\",\n  \"amount\": 4503599627370495,\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.paygood.co/payments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"merchantId\": \"<string>\",\n  \"paymentInstrumentId\": \"<string>\",\n  \"captureMethod\": \"automatic\",\n  \"priceId\": \"<string>\",\n  \"amount\": 4503599627370495,\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "paymentId": "<string>",
  "idempotencyKey": "<string>",
  "customerId": "<string>",
  "merchantId": "<string>",
  "paymentInstrumentId": "<string>",
  "priceId": "<string>",
  "amount": 0,
  "currency": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "metadata": {},
  "authorizedAt": "2023-11-07T05:31:56Z",
  "capturedAt": "2023-11-07T05:31:56Z",
  "voidedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization

string

header

required

Merchant API key bearer token. Legacy wire prefixes api_key_ and api_ are also accepted.

Body

application/json

Payment creation payload.

idempotencyKey

string

required

Minimum string length: 1

customerId

string

required

merchantId

string

required

paymentInstrumentId

string

required

captureMethod

enum<string>

default:automatic

Available options:

automatic,

manual

priceId

string

amount

integer

Required range: 0 < x <= 9007199254740991

currency

string

Supported currency code (USD, CAD)

Required string length: 3

description

string

Required string length: 1 - 1000

metadata

object

Show child attributes

Response

paymentId

string

required

idempotencyKey

string

required

Minimum string length: 1

customerId

string

required

merchantId

string

required

paymentInstrumentId

string

required

priceId

string

required

captureMethod

enum<string>

required

Available options:

automatic,

manual

amount

integer

required

Required range: -9007199254740991 <= x <= 9007199254740991

currency

string

required

Supported currency code (USD, CAD)

Required string length: 3

status

enum<string>

required

Available options:

pending,

authorized,

captured,

completed,

voided,

refunded,

declined

createdAt

string<date-time>

required

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

description

string

Required string length: 1 - 1000

metadata

object

Show child attributes

authorizedAt

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

capturedAt

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

voidedAt

string<date-time>

Pattern:

^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$

Create a one-time payment

curl --request POST \
  --url https://api-sandbox.paygood.co/payments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "idempotencyKey": "<string>",
  "customerId": "<string>",
  "merchantId": "<string>",
  "paymentInstrumentId": "<string>",
  "captureMethod": "automatic",
  "priceId": "<string>",
  "amount": 4503599627370495,
  "currency": "<string>",
  "description": "<string>",
  "metadata": {}
}
'

import requests

url = "https://api-sandbox.paygood.co/payments"

payload = {
    "idempotencyKey": "<string>",
    "customerId": "<string>",
    "merchantId": "<string>",
    "paymentInstrumentId": "<string>",
    "captureMethod": "automatic",
    "priceId": "<string>",
    "amount": 4503599627370495,
    "currency": "<string>",
    "description": "<string>",
    "metadata": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    idempotencyKey: '<string>',
    customerId: '<string>',
    merchantId: '<string>',
    paymentInstrumentId: '<string>',
    captureMethod: 'automatic',
    priceId: '<string>',
    amount: 4503599627370495,
    currency: '<string>',
    description: '<string>',
    metadata: {}
  })
};

fetch('https://api-sandbox.paygood.co/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-sandbox.paygood.co/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([
    'idempotencyKey' => '<string>',
    'customerId' => '<string>',
    'merchantId' => '<string>',
    'paymentInstrumentId' => '<string>',
    'captureMethod' => 'automatic',
    'priceId' => '<string>',
    'amount' => 4503599627370495,
    'currency' => '<string>',
    'description' => '<string>',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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-sandbox.paygood.co/payments"

	payload := strings.NewReader("{\n  \"idempotencyKey\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"merchantId\": \"<string>\",\n  \"paymentInstrumentId\": \"<string>\",\n  \"captureMethod\": \"automatic\",\n  \"priceId\": \"<string>\",\n  \"amount\": 4503599627370495,\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"metadata\": {}\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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-sandbox.paygood.co/payments")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"idempotencyKey\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"merchantId\": \"<string>\",\n  \"paymentInstrumentId\": \"<string>\",\n  \"captureMethod\": \"automatic\",\n  \"priceId\": \"<string>\",\n  \"amount\": 4503599627370495,\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api-sandbox.paygood.co/payments")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"idempotencyKey\": \"<string>\",\n  \"customerId\": \"<string>\",\n  \"merchantId\": \"<string>\",\n  \"paymentInstrumentId\": \"<string>\",\n  \"captureMethod\": \"automatic\",\n  \"priceId\": \"<string>\",\n  \"amount\": 4503599627370495,\n  \"currency\": \"<string>\",\n  \"description\": \"<string>\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "paymentId": "<string>",
  "idempotencyKey": "<string>",
  "customerId": "<string>",
  "merchantId": "<string>",
  "paymentInstrumentId": "<string>",
  "priceId": "<string>",
  "amount": 0,
  "currency": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "metadata": {},
  "authorizedAt": "2023-11-07T05:31:56Z",
  "capturedAt": "2023-11-07T05:31:56Z",
  "voidedAt": "2023-11-07T05:31:56Z"
}