Create a payment request

curl --request POST \
  --url https://api.withacclaim.com/v1/payment_requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Premium payment for policy #POL-2025-001",
  "reference": "ORD-2025-001",
  "amount": 125000,
  "currency": "USD",
  "requires_tokenization": false,
  "allows_tokenization": false,
  "payer_id": "pyr_AbC123XyZ",
  "payment_method_id": "pm_AbC123XyZ",
  "idempotency_key": "idem_ord_2025_001",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  }
}
'

import requests

url = "https://api.withacclaim.com/v1/payment_requests"

payload = {
    "description": "Premium payment for policy #POL-2025-001",
    "reference": "ORD-2025-001",
    "amount": 125000,
    "currency": "USD",
    "requires_tokenization": False,
    "allows_tokenization": False,
    "payer_id": "pyr_AbC123XyZ",
    "payment_method_id": "pm_AbC123XyZ",
    "idempotency_key": "idem_ord_2025_001",
    "metadata": {
        "custom_field": "value",
        "source": "api"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'Premium payment for policy #POL-2025-001',
    reference: 'ORD-2025-001',
    amount: 125000,
    currency: 'USD',
    requires_tokenization: false,
    allows_tokenization: false,
    payer_id: 'pyr_AbC123XyZ',
    payment_method_id: 'pm_AbC123XyZ',
    idempotency_key: 'idem_ord_2025_001',
    metadata: {custom_field: 'value', source: 'api'}
  })
};

fetch('https://api.withacclaim.com/v1/payment_requests', 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.withacclaim.com/v1/payment_requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Premium payment for policy #POL-2025-001',
    'reference' => 'ORD-2025-001',
    'amount' => 125000,
    'currency' => 'USD',
    'requires_tokenization' => false,
    'allows_tokenization' => false,
    'payer_id' => 'pyr_AbC123XyZ',
    'payment_method_id' => 'pm_AbC123XyZ',
    'idempotency_key' => 'idem_ord_2025_001',
    'metadata' => [
        'custom_field' => 'value',
        'source' => 'api'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.withacclaim.com/v1/payment_requests"

	payload := strings.NewReader("{\n  \"description\": \"Premium payment for policy #POL-2025-001\",\n  \"reference\": \"ORD-2025-001\",\n  \"amount\": 125000,\n  \"currency\": \"USD\",\n  \"requires_tokenization\": false,\n  \"allows_tokenization\": false,\n  \"payer_id\": \"pyr_AbC123XyZ\",\n  \"payment_method_id\": \"pm_AbC123XyZ\",\n  \"idempotency_key\": \"idem_ord_2025_001\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.withacclaim.com/v1/payment_requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Premium payment for policy #POL-2025-001\",\n  \"reference\": \"ORD-2025-001\",\n  \"amount\": 125000,\n  \"currency\": \"USD\",\n  \"requires_tokenization\": false,\n  \"allows_tokenization\": false,\n  \"payer_id\": \"pyr_AbC123XyZ\",\n  \"payment_method_id\": \"pm_AbC123XyZ\",\n  \"idempotency_key\": \"idem_ord_2025_001\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withacclaim.com/v1/payment_requests")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Premium payment for policy #POL-2025-001\",\n  \"reference\": \"ORD-2025-001\",\n  \"amount\": 125000,\n  \"currency\": \"USD\",\n  \"requires_tokenization\": false,\n  \"allows_tokenization\": false,\n  \"payer_id\": \"pyr_AbC123XyZ\",\n  \"payment_method_id\": \"pm_AbC123XyZ\",\n  \"idempotency_key\": \"idem_ord_2025_001\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}"

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

{
  "id": "prq_AbC123XyZ",
  "status": "RequiresPaymentMethod",
  "amount": 125000,
  "currency": "USD",
  "payer_id": "pyr_AbC123XyZ",
  "description": "Premium payment for policy #POL-2025-001",
  "reference": "ORD-2025-001",
  "idempotency_key": "idem_ord_2025_001",
  "requires_tokenization": false,
  "allows_tokenization": false,
  "payment_method": {},
  "session_identifier": "prq_AbC123XyZ_abc123...",
  "shipping_address": {
    "country": "US",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001"
  },
  "failure_code": "card_declined",
  "failure_message": "Card was declined",
  "expires_at": "2025-12-31T23:59:59Z",
  "completed_at": "2025-10-08T18:25:00Z",
  "ip_address": "192.168.1.1",
  "user_agent": "Mozilla/5.0...",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "created_at": "2025-10-08T18:20:31Z",
  "updated_at": "2025-10-08T18:25:00Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: amount",
    "details": {},
    "request_id": "req_7lYt4o2x"
  }
}

POST

payment_requests

Create a payment request

curl --request POST \
  --url https://api.withacclaim.com/v1/payment_requests \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "description": "Premium payment for policy #POL-2025-001",
  "reference": "ORD-2025-001",
  "amount": 125000,
  "currency": "USD",
  "requires_tokenization": false,
  "allows_tokenization": false,
  "payer_id": "pyr_AbC123XyZ",
  "payment_method_id": "pm_AbC123XyZ",
  "idempotency_key": "idem_ord_2025_001",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  }
}
'

import requests

url = "https://api.withacclaim.com/v1/payment_requests"

payload = {
    "description": "Premium payment for policy #POL-2025-001",
    "reference": "ORD-2025-001",
    "amount": 125000,
    "currency": "USD",
    "requires_tokenization": False,
    "allows_tokenization": False,
    "payer_id": "pyr_AbC123XyZ",
    "payment_method_id": "pm_AbC123XyZ",
    "idempotency_key": "idem_ord_2025_001",
    "metadata": {
        "custom_field": "value",
        "source": "api"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    description: 'Premium payment for policy #POL-2025-001',
    reference: 'ORD-2025-001',
    amount: 125000,
    currency: 'USD',
    requires_tokenization: false,
    allows_tokenization: false,
    payer_id: 'pyr_AbC123XyZ',
    payment_method_id: 'pm_AbC123XyZ',
    idempotency_key: 'idem_ord_2025_001',
    metadata: {custom_field: 'value', source: 'api'}
  })
};

fetch('https://api.withacclaim.com/v1/payment_requests', 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.withacclaim.com/v1/payment_requests",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'description' => 'Premium payment for policy #POL-2025-001',
    'reference' => 'ORD-2025-001',
    'amount' => 125000,
    'currency' => 'USD',
    'requires_tokenization' => false,
    'allows_tokenization' => false,
    'payer_id' => 'pyr_AbC123XyZ',
    'payment_method_id' => 'pm_AbC123XyZ',
    'idempotency_key' => 'idem_ord_2025_001',
    'metadata' => [
        'custom_field' => 'value',
        'source' => 'api'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.withacclaim.com/v1/payment_requests"

	payload := strings.NewReader("{\n  \"description\": \"Premium payment for policy #POL-2025-001\",\n  \"reference\": \"ORD-2025-001\",\n  \"amount\": 125000,\n  \"currency\": \"USD\",\n  \"requires_tokenization\": false,\n  \"allows_tokenization\": false,\n  \"payer_id\": \"pyr_AbC123XyZ\",\n  \"payment_method_id\": \"pm_AbC123XyZ\",\n  \"idempotency_key\": \"idem_ord_2025_001\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.withacclaim.com/v1/payment_requests")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"description\": \"Premium payment for policy #POL-2025-001\",\n  \"reference\": \"ORD-2025-001\",\n  \"amount\": 125000,\n  \"currency\": \"USD\",\n  \"requires_tokenization\": false,\n  \"allows_tokenization\": false,\n  \"payer_id\": \"pyr_AbC123XyZ\",\n  \"payment_method_id\": \"pm_AbC123XyZ\",\n  \"idempotency_key\": \"idem_ord_2025_001\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.withacclaim.com/v1/payment_requests")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"description\": \"Premium payment for policy #POL-2025-001\",\n  \"reference\": \"ORD-2025-001\",\n  \"amount\": 125000,\n  \"currency\": \"USD\",\n  \"requires_tokenization\": false,\n  \"allows_tokenization\": false,\n  \"payer_id\": \"pyr_AbC123XyZ\",\n  \"payment_method_id\": \"pm_AbC123XyZ\",\n  \"idempotency_key\": \"idem_ord_2025_001\",\n  \"metadata\": {\n    \"custom_field\": \"value\",\n    \"source\": \"api\"\n  }\n}"

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

{
  "id": "prq_AbC123XyZ",
  "status": "RequiresPaymentMethod",
  "amount": 125000,
  "currency": "USD",
  "payer_id": "pyr_AbC123XyZ",
  "description": "Premium payment for policy #POL-2025-001",
  "reference": "ORD-2025-001",
  "idempotency_key": "idem_ord_2025_001",
  "requires_tokenization": false,
  "allows_tokenization": false,
  "payment_method": {},
  "session_identifier": "prq_AbC123XyZ_abc123...",
  "shipping_address": {
    "country": "US",
    "address1": "123 Main St",
    "address2": "Suite 100",
    "city": "New York",
    "state": "NY",
    "postal_code": "10001"
  },
  "failure_code": "card_declined",
  "failure_message": "Card was declined",
  "expires_at": "2025-12-31T23:59:59Z",
  "completed_at": "2025-10-08T18:25:00Z",
  "ip_address": "192.168.1.1",
  "user_agent": "Mozilla/5.0...",
  "metadata": {
    "custom_field": "value",
    "source": "api"
  },
  "created_at": "2025-10-08T18:20:31Z",
  "updated_at": "2025-10-08T18:25:00Z"
}

{
  "error": {
    "code": "invalid_request",
    "message": "Missing required field: amount",
    "details": {},
    "request_id": "req_7lYt4o2x"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

description

string

required

Description of the payment request

Maximum string length: 255

Example:

"Premium payment for policy #POL-2025-001"

reference

string

required

Client-supplied identifier for reconciliation

Maximum string length: 255

Example:

"ORD-2025-001"

amount

integer

required

Amount in smallest currency unit

Required range: x >= 1

Example:

125000

currency

string

required

ISO 4217 currency code (3 uppercase letters)

Required string length: 3

Pattern: ^[A-Z]{3}$

Example:

"USD"

requires_tokenization

boolean

default:false

Whether this payment request requires tokenization of the payment method

allows_tokenization

boolean

default:false

Whether this payment request allows tokenization of the payment method

payer_id

string | null

ID of the payer to associate with this payment request

Maximum string length: 255

Example:

"pyr_AbC123XyZ"

payment_method_id

string | null

ID of an existing payment method to use (must belong to the payer if payer_id is provided)

Maximum string length: 255

Example:

"pm_AbC123XyZ"

idempotency_key

string | null

Client-supplied idempotency key; reuse is allowed only after the prior request failed or was canceled

Maximum string length: 255

Example:

"idem_ord_2025_001"

metadata

object | null

Optional metadata as key-value pairs

Example:

{ "custom_field": "value", "source": "api" }

Response

Payment request created.

string

Example:

"prq_AbC123XyZ"

status

enum<string>

Current status of the payment request

Available options:

RequiresPaymentMethod,

RequiresAction,

Processing,

Authorized,

Succeeded,

Failed,

Canceled

Example:

"RequiresPaymentMethod"

amount

integer

Amount in smallest currency unit

Example:

125000

currency

string

ISO 4217 currency code

Example:

"USD"

payer_id

string | null

ID of the payer associated with this payment request

Example:

"pyr_AbC123XyZ"

description

string

Example:

"Premium payment for policy #POL-2025-001"

reference

string

Client-supplied identifier

Example:

"ORD-2025-001"

idempotency_key

string | null

Client-supplied idempotency key set at creation

Maximum string length: 255

Example:

"idem_ord_2025_001"

requires_tokenization

boolean

Whether this payment request requires tokenization of the payment method

Example:

false

allows_tokenization

boolean

Whether this payment request allows tokenization of the payment method

Example:

false

payment_method

object | null

Payment method associated with this payment request

session_identifier

string

External session identifier for this payment request

Example:

"prq_AbC123XyZ_abc123..."

shipping_address

object | null

Shipping address for this payment request

Show child attributes

failure_code

string | null

Error code if the payment request failed

Example:

"card_declined"

failure_message

string | null

Human-readable error message if the payment request failed

Example:

"Card was declined"

expires_at

string<date-time> | null

When the payment request expires

Example:

"2025-12-31T23:59:59Z"

completed_at

string<date-time> | null

When the payment request was completed

Example:

"2025-10-08T18:25:00Z"

ip_address

string | null

IP address of the client making the payment

Example:

"192.168.1.1"

user_agent

string | null

User agent string of the client making the payment

Example:

"Mozilla/5.0..."

metadata

object | null

Optional metadata as key-value pairs

Example:

{ "custom_field": "value", "source": "api" }

created_at

string<date-time>

Example:

"2025-10-08T18:20:31Z"

updated_at

string<date-time>

Example:

"2025-10-08T18:25:00Z"

Last modified on June 14, 2026

List payment requests

Retrieve a payment request

⌘I

ACCLAIM API

COLLECT API

DISBURSE API

TREASURY API

Create a payment request

Authorizations

Body

Response