Confirm a payment request

curl --request POST \ --url https://api.withacclaim.com/v1/payment_requests/{payment_request_id}/confirm \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data ' { "description": "Updated premium payment for policy #POL-2025-001", "reference": "ORD-2025-002", "amount": 20000, "currency": "USD", "requires_tokenization": true, "allows_tokenization": true, "expires_at": "2025-12-31T23:59:59Z", "payer_id": "pyr_AbC123XyZ", "payment_method_id": "pm_AbC123XyZ", "payment_method": {}, "ip_address": "192.168.1.1", "user_agent": "Mozilla/5.0...", "metadata": { "custom_field": "value", "source": "api" } } '

{ "id": "pay_AbC123XyZ", "payment_request_id": "prq_Def456UvW", "payer_id": "pyr_GhI789JkL", "status": "Succeeded", "amount": 125000, "currency": "USD", "reference": "ORD-2025-001", "description": "Premium payment for policy #POL-2025-001", "external_id": "txn_processor_123", "failure_code": "card_declined", "failure_message": "Card was declined", "created_at": "2025-10-08T18:20:31Z", "updated_at": "2025-10-08T18:25:00Z" }

Authorizations

Authorization

string

header

required

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

Path Parameters

payment_request_id

string

required

ID of the payment request.

Body

application/json

description

string | null

Description of the payment request

Maximum string length: 255

Example:

"Updated premium payment for policy #POL-2025-001"

reference

string | null

Client-supplied identifier for reconciliation

Maximum string length: 255

Example:

"ORD-2025-002"

amount

integer | null

Amount in smallest currency unit (must provide both amount and currency)

Required range: x >= 1

Example:

20000

currency

string | null

ISO 4217 currency code (3 uppercase letters, must provide both amount and currency)

Required string length: 3

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

Example:

"USD"

requires_tokenization

boolean

Whether this payment request requires tokenization of the payment method

allows_tokenization

boolean

Whether this payment request allows tokenization of the payment method

expires_at

string<date-time> | null

When the payment request expires (ISO 8601 date-time string)

Example:

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

payer_id

string | null

ID of the payer to associate with this payment request

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"

payment_method

object

Payment method data (e.g., payment_token, payment_method type)

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

Optional metadata as key-value pairs

Example:

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

Response

Payment processed successfully.

string

Example:

"pay_AbC123XyZ"

payment_request_id

string | null

ID of the payment request this payment belongs to

Example:

"prq_Def456UvW"

payer_id

string | null

ID of the payer making the payment

Example:

"pyr_GhI789JkL"

status

enum<string>

Current status of the payment

Available options:

Pending,

Processing,

Succeeded,

Failed

Example:

"Succeeded"

amount

integer

Amount in smallest currency unit

Example:

125000

currency

string

ISO 4217 currency code

Example:

"USD"

reference

string

Client-supplied identifier

Example:

"ORD-2025-001"

description

string | null

Description of the payment

Example:

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

external_id

string | null

External transaction ID from the payment processor

Example:

"txn_processor_123"

failure_code

string | null

Error code if the payment failed

Example:

"card_declined"

failure_message

string | null

Human-readable error message if the payment failed

Example:

"Card was declined"

created_at

string<date-time>

Example:

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

updated_at

string<date-time>

Example:

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

Documentation Index

Authorizations

Path Parameters

Body

Response