Payments

Method	Endpoint	Description
POST	`/orders/{orderId}/payments`	Capture payment for an order

Parameters

Path

orderId string

requiredpath

Request Body

requiredapplication/json

amount object required

amount object

currency string

amount integer

Amount in minor units

method any required

capture boolean

Default: True

201 Payment captured

Content-Type: application/json

amount object required

amount object

currency string

amount integer

Amount in minor units

method any required

capture boolean

Default: True

402 Payment required

Content-Type: application/json

amount object required

amount object

currency string

amount integer

Amount in minor units

method any required

capture boolean

Default: True

BASH

curl -X POST "https://api.example.com/orders/id_123/payments" \
  -H "Authorization: Bearer $API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "amount": {
    "currency": "USD",
    "amount": 1
  },
  "method": {
    "type": "card",
    "brand": "string",
    "last4": "string",
    "exp_month": 1,
    "exp_year": 1
  },
  "capture": true
}'

python

PYTHON

import requests

url = "https://api.example.com/orders/id_123/payments"
headers = {
    "Authorization": "Bearer " + API_KEY,
    "Content-Type": "application/json",
}

payload = {
    "amount": {
        "currency": "USD",
        "amount": 1
    },
    "method": {
        "type": "card",
        "brand": "string",
        "last4": "string",
        "exp_month": 1,
        "exp_year": 1
    },
    "capture": true
}

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

print(response.json())

javascript

JAVASCRIPT

const url = "https://api.example.com/orders/id_123/payments";

const options = {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "amount": {
        "currency": "USD",
        "amount": 1
    },
    "method": {
        "type": "card",
        "brand": "string",
        "last4": "string",
        "exp_month": 1,
        "exp_year": 1
    },
    "capture": true
}),
};

const response = await fetch(url, options);
const data = await response.json();
console.log(data);

package main

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

func main() {
	url := "https://api.example.com/orders/id_123/payments"

	body := []byte(`{"amount": {"currency": "USD", "amount": 1}, "method": {"type": "card", "brand": "string", "last4": "string", "exp_month": 1, "exp_year": 1}, "capture": true}`)
	req, err := http.NewRequest("POST", url, bytes.NewBuffer(body))
	if err != nil {
		panic(err)
	}

	req.Header.Set("Authorization", "Bearer " + os.Getenv("API_KEY"))
	req.Header.Set("Content-Type", "application/json")

	client := &http.Client{}
	resp, err := client.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()

	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

ruby

RUBY

require 'net/http'
require 'json'
require 'uri'

uri = URI("https://api.example.com/orders/id_123/payments")

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

request = Net::HTTP::Post.new(uri)
request["Authorization"] = "Bearer #{ENV['API_KEY']}"
request["Content-Type"] = "application/json"

request.body = '{\n  "amount": {\n    "currency": "USD",\n    "amount": 1\n  },\n  "method": {\n    "type": "card",\n    "brand": "string",\n    "last4": "string",\n    "exp_month": 1,\n    "exp_year": 1\n  },\n  "capture": true\n}'

response = http.request(request)
puts JSON.parse(response.body)

php

PHP

<?php
require 'vendor/autoload.php';

use GuzzleHttp\Client;

$client = new Client();

$url = "https://api.example.com/orders/id_123/payments";

$options = [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('API_KEY'),
        'Content-Type' => 'application/json',
    ],
    'json' => ['amount' => ['currency' => 'USD', 'amount' => 1], 'method' => ['type' => 'card', 'brand' => 'string', 'last4' => 'string', 'exp_month' => 1, 'exp_year' => 1], 'capture' => true],
];

$response = $client->request('POST', $url, $options);

echo $response->getBody();

Endpoints

Capture payment for an order

Parameters

Path

Request Body

Responses

Endpoints

Parameters

Link Path

Path