Get Payment

GET

payments

{id}

Python

from ourpay.v2026_10 import OurPay

ourpay = OurPay("ourpay_oat_xxx")

response = ourpay.payments.get(
    '00000000-0000-4000-8000-000000000000',
)
print(response)

import { createOurPay } from "@ourpay-dev/sdk/2026-10";

const ourpay = createOurPay({
  accessToken: "ourpay_oat_xxx",
});

const response = await ourpay.payments.get(
  "00000000-0000-4000-8000-000000000000",
);
console.log(response);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ourpay.dev/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://api.ourpay.dev/v1/payments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.ourpay.dev/v1/payments/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ourpay.dev/v1/payments/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "processor": "stripe",
  "status": "succeeded",
  "amount": 1000,
  "currency": "usd",
  "method": "card",
  "trigger": "subscription_cycle",
  "decline_reason": "insufficient_funds",
  "decline_message": "Your card has insufficient funds.",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "checkout_id": "e4b478fa-cd25-4253-9f1f-8a41e6370ede",
  "order_id": "e4b478fa-cd25-4253-9f1f-8a41e6370ede",
  "method_metadata": {
    "brand": "visa",
    "last4": "4242"
  },
  "processor_metadata": {}
}

{
  "error": "ResourceNotFound",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

Authorization

string

header

required

You can generate a Personal Access Token from your settings.

Path Parameters

string<uuid4>

required

The payment ID.

Response

Successful Response

CardPayment
KrCardPayment
PayPalPayment
GenericPayment

Schema of a payment with a card payment method.

created_at

string<date-time>

required

Creation timestamp of the object.

modified_at

string<date-time> | null

required

Last modification timestamp of the object.

string<uuid4>

required

The ID of the object.

processor

enum<string>

required

The payment processor.

Available options:

stripe,

paypal,

manual

Example:

"stripe"

status

enum<string>

required

The payment status.

Available options:

pending,

succeeded,

failed

Example:

"succeeded"

amount

integer

required

The payment amount in cents.

Example:

1000

currency

string

required

The payment currency

Example:

"usd"

method

string

required

The payment method used.

Allowed value: "card"

Example:

"card"

trigger

enum<string> | null

required

What initiated this payment attempt, e.g. initial purchase, subscription renewal, or an automated dunning retry.

Available options:

purchase,

subscription_cycle,

retry_dunning,

retry_customer,

retry_payment_method_update,

retry_admin

Example:

"subscription_cycle"

decline_reason

string | null

required

Error code, if the payment was declined.

Example:

"insufficient_funds"

decline_message

string | null

required

Human-readable error message, if the payment was declined.

Example:

"Your card has insufficient funds."

organization_id

string<uuid4>

required

The ID of the organization that owns the payment.

Example:

"1dbfc517-0bbf-4301-9ba8-555ca42b9737"

checkout_id

string<uuid4> | null

required

The ID of the checkout session associated with this payment.

Example:

"e4b478fa-cd25-4253-9f1f-8a41e6370ede"

order_id

string<uuid4> | null

required

The ID of the order associated with this payment.

Example:

"e4b478fa-cd25-4253-9f1f-8a41e6370ede"

method_metadata

CardPaymentMetadata · object

required

Additional metadata for the card payment method.

Show child attributes

processor_metadata

Processor Metadata · object

Additional metadata from the payment processor for internal use.

Python

from ourpay.v2026_10 import OurPay

ourpay = OurPay("ourpay_oat_xxx")

response = ourpay.payments.get(
    '00000000-0000-4000-8000-000000000000',
)
print(response)

import { createOurPay } from "@ourpay-dev/sdk/2026-10";

const ourpay = createOurPay({
  accessToken: "ourpay_oat_xxx",
});

const response = await ourpay.payments.get(
  "00000000-0000-4000-8000-000000000000",
);
console.log(response);

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.ourpay.dev/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://api.ourpay.dev/v1/payments/{id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.ourpay.dev/v1/payments/{id}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ourpay.dev/v1/payments/{id}")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "created_at": "2023-11-07T05:31:56Z",
  "modified_at": "2023-11-07T05:31:56Z",
  "id": "<string>",
  "processor": "stripe",
  "status": "succeeded",
  "amount": 1000,
  "currency": "usd",
  "method": "card",
  "trigger": "subscription_cycle",
  "decline_reason": "insufficient_funds",
  "decline_message": "Your card has insufficient funds.",
  "organization_id": "1dbfc517-0bbf-4301-9ba8-555ca42b9737",
  "checkout_id": "e4b478fa-cd25-4253-9f1f-8a41e6370ede",
  "order_id": "e4b478fa-cd25-4253-9f1f-8a41e6370ede",
  "method_metadata": {
    "brand": "visa",
    "last4": "4242"
  },
  "processor_metadata": {}
}

{
  "error": "ResourceNotFound",
  "detail": "<string>"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

General

Endpoints

Authorizations

Path Parameters

Response