List Payment Requests

GET

payments

curl --request GET \
  --url https://api.example.com/payments \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.example.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.example.com/payments",
  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.example.com/payments"

	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.example.com/payments")

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

{
  "items": [
    {
      "id": "<string>",
      "session_id": "<string>",
      "status": "<string>",
      "mode": "<string>",
      "amount": "<string>",
      "currency": "<string>",
      "merchant_name": "<string>",
      "merchant_url": "<string>",
      "user_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "vault_id": "<string>",
      "approval_url": "<string>",
      "connection_url": "<string>",
      "connection_phrase": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "error_code": "<string>",
      "next_action": {
        "type": "ssn_verification",
        "resolution": "auto_resume",
        "action_url": "<string>",
        "expires_at": "2023-11-07T05:31:56Z"
      },
      "purchase_status": "unverified"
    }
  ],
  "page": 123,
  "page_size": 123,
  "has_next": true,
  "has_previous": true
}

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

Authorizations

Authorization

string

header

required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

x-notte-request-origin

string | null

x-notte-sdk-version

string | null

Query Parameters

page

integer

default:1

Page number

Required range: x >= 1

page_size

integer

default:20

Number of items per page

Required range: 1 <= x <= 100

session_id

string | null

Only payments of this session

status

enum<string> | null

Only payments in this state

Available options:

awaiting_connection,

creating,

awaiting_approval,

requires_action,

approved,

provisioning,

ready,

declined,

expired,

failed,

closed

mode

enum<string> | null

Only test or live payments

Available options:

test,

live

user_id

string<uuid> | null

Only payments this user requested. Members see only their own payments.

Response

Successful Response

items

PaymentListItem · object[]

required

Show child attributes

page

integer

required

page_size

integer

required

has_next

boolean

required

has_previous

boolean

required

read-only

⌘I

List Payment Requests

curl --request GET \
  --url https://api.example.com/payments \
  --header 'Authorization: Bearer <token>'

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

fetch('https://api.example.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.example.com/payments",
  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.example.com/payments"

	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.example.com/payments")

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

{
  "items": [
    {
      "id": "<string>",
      "session_id": "<string>",
      "status": "<string>",
      "mode": "<string>",
      "amount": "<string>",
      "currency": "<string>",
      "merchant_name": "<string>",
      "merchant_url": "<string>",
      "user_id": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "vault_id": "<string>",
      "approval_url": "<string>",
      "connection_url": "<string>",
      "connection_phrase": "<string>",
      "expires_at": "2023-11-07T05:31:56Z",
      "error_code": "<string>",
      "next_action": {
        "type": "ssn_verification",
        "resolution": "auto_resume",
        "action_url": "<string>",
        "expires_at": "2023-11-07T05:31:56Z"
      },
      "purchase_status": "unverified"
    }
  ],
  "page": 123,
  "page_size": 123,
  "has_next": true,
  "has_previous": true
}

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

Getting Started

APIs

Python SDK

Node SDK

List Payment Requests

Authorizations

Headers

Query Parameters

Response