Verify a checkout payment

POST

/checkout/verify-payment

curl --request POST \
  --url https://apisandbox.puurk.com/checkout/verify-payment \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "payment_intent_id": "example", "payment_id": "example", "oid": "example", "client_id": "example", "contract_id": "example", "offer_id": "example" }'

• Sandbox
• Production

Verifies a confirmed PaymentIntent and records the Payment. Idempotent: a retry returns the existing record.

Authorizations

• service_token

Request Body^required

Payment to verify and record

Media typeapplication/json

object

payment_intent_id

required

PaymentIntent that was confirmed

string

payment_id

required

Payment ID returned by /checkout/prepare

string

oid

required

Organization ID the payment belongs to

string

client_id

Lead/client ID to record on the payment

string

contract_id

Contract ID to record on the payment

string

offer_id

Offer ID to record on the payment

string

Example^generated

{
  "payment_intent_id": "example",
  "payment_id": "example",
  "oid": "example",
  "client_id": "example",
  "contract_id": "example",
  "offer_id": "example"
}

Responses

200

Successful operation

Media typeapplication/json

object

payment_id

Puurk payment ID

string

status

Payment status

string

payment_method_id

Stripe PaymentMethod ID used, for associating the saved card with future scheduled charges

string

nullable

Example^generated

{
  "payment_id": "example",
  "status": "example",
  "payment_method_id": "example"
}

400

Invalid parameter

401

Unauthorized

403

PaymentIntent or payment record belongs to another organization

404

PaymentIntent not found

422

Payment not confirmed