Process payment

Use when you need to charge or process a payment (e.g. trigger the payment provider to capture funds). Returns updated payment with status.

POST /payments/{id}/process

Process payment

cURL

curl --request POST \
  --url https://us.api.flexprice.io/v1/payments/{id}/process \
  --header 'x-api-key: <api-key>'

200

{
  "amount": "<string>",
  "attempts": [
    {
      "attempt_number": 123,
      "created_at": "2023-11-07T05:31:56Z",
      "created_by": "<string>",
      "error_message": "<string>",
      "id": "<string>",
      "metadata": {},
      "payment_id": "<string>",
      "tenant_id": "<string>",
      "updated_at": "2023-11-07T05:31:56Z",
      "updated_by": "<string>"
    }
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "created_by": "<string>",
  "currency": "<string>",
  "destination_id": "<string>",
  "error_message": "<string>",
  "failed_at": "2023-11-07T05:31:56Z",
  "gateway_metadata": {},
  "gateway_payment_id": "<string>",
  "gateway_tracking_id": "<string>",
  "id": "<string>",
  "idempotency_key": "<string>",
  "invoice_number": "<string>",
  "metadata": {},
  "payment_gateway": "<string>",
  "payment_method_id": "<string>",
  "payment_url": "<string>",
  "refunded_at": "2023-11-07T05:31:56Z",
  "save_card_and_make_default": true,
  "succeeded_at": "2023-11-07T05:31:56Z",
  "tenant_id": "<string>",
  "track_attempts": true,
  "updated_at": "2023-11-07T05:31:56Z",
  "updated_by": "<string>"
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Path Parameters

id · string · required

Payment ID

Response

200

application/json

Processed payment

amount · string

attempts · object[]

Show child attributes

created_at · string<date-time>

created_by · string

currency · string

destination_id · string

destination_type · enum<string>

Available options: INVOICE

error_message · string

failed_at · string<date-time>

gateway_metadata · object

Show child attributes

gateway_payment_id · string

gateway_tracking_id · string

id · string

idempotency_key · string

invoice_number · string

metadata · object

Show child attributes

payment_gateway · string

payment_method_id · string

payment_method_type · enum<string>

Available options: CARD, ACH, OFFLINE, CREDITS, PAYMENT_LINK

payment_status · enum<string>

Available options: INITIATED, PENDING, PROCESSING, SUCCEEDED, OVERPAID, FAILED, REFUNDED, PARTIALLY_REFUNDED

payment_url · string

refunded_at · string<date-time>

save_card_and_make_default · boolean

succeeded_at · string<date-time>

tenant_id · string

track_attempts · boolean

updated_at · string<date-time>

updated_by · string