cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/orders/ORD-0001/payment_methods/acme-cash-01" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.orders.get_order_payment_method("ORD-0001", "acme-cash-01")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.orders.getOrderPaymentMethod('ORD-0001', 'acme-cash-01');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->orders->getOrderPaymentMethod('ORD-0001', 'acme-cash-01');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.orders.orders_dto.OrdersDto.OrderPaymentMethod;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<OrderPaymentMethod> response = client.orders().getOrderPaymentMethod("ORD-0001", "acme-cash-01");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Orders.GetOrderPaymentMethodAsync("ORD-0001", "acme-cash-01");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.orders.getOrderPaymentMethod(
'ORD-0001',
'acme-cash-01',
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Orders().GetOrderPaymentMethod(context.Background(), "ORD-0001", "acme-cash-01", nil, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"order": {
"payment_method": {
"created_by": "<string>",
"created_on": "<string>",
"default": true,
"id": "<string>",
"last_updated_by": "<string>",
"last_updated_on": "<string>",
"last_used_at": "<unknown>",
"object": "<string>",
"payment_count": 123,
"processor": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"processor_type": "<string>",
"reference": "<string>",
"restricted_to_orders": true,
"specified_order_ids": "<string>",
"status": "<string>",
"version": 123
}
}
}Orders
Retrieve an order's payment method
Returns one payment method set aside for an order, under order.payment_method.
GET
/
orders
/
{order_id}
/
payment_methods
/
{payment_method_ref}
cURL
curl -X GET "$EXSITED_BASE_URL/api/v4/orders/ORD-0001/payment_methods/acme-cash-01" \
-H "Authorization: Bearer $ACCESS_TOKEN"from exsited import build_client
client = build_client()
response = client.orders.get_order_payment_method("ORD-0001", "acme-cash-01")
print(response.data)
import {buildClient} from 'exsited';
const client = await buildClient();
const response = await client.orders.getOrderPaymentMethod('ORD-0001', 'acme-cash-01');
console.log(response.data);
use Exsited\Client\ClientRegistry;
$client = ClientRegistry::buildClient();
$response = $client->orders->getOrderPaymentMethod('ORD-0001', 'acme-cash-01');
print_r($response->data);
import com.exsited.client.ApiResponse;
import com.exsited.client.ClientRegistry;
import com.exsited.client.ExsitedClient;
import com.exsited.resources.orders.orders_dto.OrdersDto.OrderPaymentMethod;
ExsitedClient client = ClientRegistry.buildClient();
ApiResponse<OrderPaymentMethod> response = client.orders().getOrderPaymentMethod("ORD-0001", "acme-cash-01");
System.out.println(response.getMap());
using Exsited.Client;
await using var client = ExsitedClient.BuildClient();
var response = await client.Orders.GetOrderPaymentMethodAsync("ORD-0001", "acme-cash-01");
Console.WriteLine(response.Json);
import 'package:exsited/exsited.dart';
final client = buildClient();
final response = await client.orders.getOrderPaymentMethod(
'ORD-0001',
'acme-cash-01',
);
print(response.map);
import (
"context"
"fmt"
"log"
exsited "github.com/exsited/exsited-sdk-go/v4"
)
client, err := exsited.BuildClient(nil)
if err != nil {
log.Fatal(err)
}
defer client.Close()
response, err := client.Orders().GetOrderPaymentMethod(context.Background(), "ORD-0001", "acme-cash-01", nil, nil)
if err != nil {
log.Fatal(err)
}
fmt.Println(response.Map)
{
"order": {
"payment_method": {
"created_by": "<string>",
"created_on": "<string>",
"default": true,
"id": "<string>",
"last_updated_by": "<string>",
"last_updated_on": "<string>",
"last_used_at": "<unknown>",
"object": "<string>",
"payment_count": 123,
"processor": {
"object": "<string>",
"id": "<string>",
"name": "<string>",
"href": "<string>"
},
"processor_type": "<string>",
"reference": "<string>",
"restricted_to_orders": true,
"specified_order_ids": "<string>",
"status": "<string>",
"version": 123
}
}
}Pass the order’s
id and the payment method’s reference, not its id.
The SDK samples get their client from credentials your app registers once when it starts, as shown in Authentication. To try the call here, click Try it, set
host to your Exsited API host name and paste an access token from Get an access token.Authorizations
An access token from POST /api/v4/oauth2/token. The SDKs get and renew it for you.
Path Parameters
The order's id, as GET /orders lists it.
The payment method's reference.
Response
200 - application/json
The payment method, under order.payment_method.
Show child attributes
Show child attributes