List a brokerage firm's payment methods with their documents
curl --request GET \
--url https://api.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents \
--header 'Authorization: Bearer <token>' \
--header 'tenant: <tenant>'import requests
url = "https://api.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents"
headers = {
"tenant": "<tenant>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {tenant: '<tenant>', Authorization: 'Bearer <token>'}};
fetch('https://api.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents', 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.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents",
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>",
"tenant: <tenant>"
],
]);
$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.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("tenant", "<tenant>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents")
.header("tenant", "<tenant>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["tenant"] = '<tenant>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"type": "<string>",
"id": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isPreferred": true,
"deletedAt": "2023-11-07T05:31:56Z",
"mandateDocumentId": "<string>",
"last4": "<string>",
"expirationMonth": 123,
"expirationYear": 123,
"billingDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"city": "<string>",
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"postalCode": "<string>",
"state": "<string>"
}
},
"documents": [
{
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"path": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"signedUrl": "<string>"
}
]
}
],
"pageInfo": {
"first": true,
"last": true
},
"totalCount": 123,
"currentPage": 123,
"totalPages": 123
}payments
List a brokerage firm's payment methods with their documents
Same payment methods as GET /brokerage-firms/{brokerageFirmId}/payment-methods, each with the documents attached to it.
GET
/
brokerage-firms
/
{brokerageFirmId}
/
payment-methods
/
with-documents
List a brokerage firm's payment methods with their documents
curl --request GET \
--url https://api.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents \
--header 'Authorization: Bearer <token>' \
--header 'tenant: <tenant>'import requests
url = "https://api.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents"
headers = {
"tenant": "<tenant>",
"Authorization": "Bearer <token>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {tenant: '<tenant>', Authorization: 'Bearer <token>'}};
fetch('https://api.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents', 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.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents",
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>",
"tenant: <tenant>"
],
]);
$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.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("tenant", "<tenant>")
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents")
.header("tenant", "<tenant>")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.korint.io/brokerage-firms/{brokerageFirmId}/payment-methods/with-documents")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["tenant"] = '<tenant>'
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"data": [
{
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"type": "<string>",
"id": "<string>",
"status": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"isPreferred": true,
"deletedAt": "2023-11-07T05:31:56Z",
"mandateDocumentId": "<string>",
"last4": "<string>",
"expirationMonth": 123,
"expirationYear": 123,
"billingDetails": {
"name": "<string>",
"email": "<string>",
"phone": "<string>",
"address": {
"city": "<string>",
"country": "<string>",
"line1": "<string>",
"line2": "<string>",
"postalCode": "<string>",
"state": "<string>"
}
},
"documents": [
{
"metadata": [
{
"key": "<string>",
"value": "<string>"
}
],
"id": "<string>",
"name": "<string>",
"path": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"signedUrl": "<string>"
}
]
}
],
"pageInfo": {
"first": true,
"last": true
},
"totalCount": 123,
"currentPage": 123,
"totalPages": 123
}Authorizations
oauth2bearerAuth
Machine-to-machine clients use the OAuth 2.0 client credentials grant. Each tenant has its own authorization server: in the token URL below, replace tenant with your tenant identifier.
Headers
Your tenant identifier. Requests without it are rejected.
Path Parameters
Pattern:
^brokerage_firm(_test)?_[346789ABCDEFGHJKLMNPQRTUVWXYabcdefghijkmnpqrtwxyz]{21}$Query Parameters
Optional: the whenAt datetime
Optional: the simulatedAt datetime
Response
200 - application/json
Was this page helpful?
⌘I

