Payments API V3

Create and manage payment transactions

Create a payment

post

Creates a new payment transaction. Amounts should be provided in cents (e.g., 2999 for $29.99).

Authorizations

bearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header as a Bearer token. Example: Authorization: Bearer sk_test_1a2b3c4d5e6f

Body

application/json

amountintegerRequired

Payment amount in cents

Example: 2999

currencystring · enumRequired

Three-letter ISO currency code

Example: usdPossible values:

customer_idstringOptional

ID of an existing customer

Example: cus_1a2b3c4d5e6f

descriptionstringOptional

Description of the payment

Example: Monthly subscription

Responses

200

Payment created successfully

application/json

idstringOptional

Unique identifier for the payment

Example: pay_1a2b3c4d5e6f

amountintegerOptional

Payment amount in cents

Example: 2999

currencystringOptional

Three-letter ISO currency code

Example: usd

statusstring · enumOptional

Current status of the payment

Example: succeededPossible values:

customer_idstring · nullableOptional

ID of the customer associated with this payment

Example: cus_1a2b3c4d5e6f

descriptionstring · nullableOptional

Description of the payment

Example: Monthly subscription

created_atstring · date-timeOptional

Timestamp when the payment was created

Example: 2024-03-15T10:30:00Z

400

Invalid request parameters

application/json

401

Authentication failed

application/json

500

Internal server error

application/json

post

/payments

HTTPcURLJavaScriptPython

POST /v1/payments HTTP/1.1
Host: api.evolvepayments.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 245

{
  "amount": 2999,
  "currency": "usd",
  "customer_id": "cus_1a2b3c4d5e6f",
  "description": "Monthly subscription",
  "card": {
    "number": "4242424242424242",
    "exp_month": 12,
    "exp_year": 2025,
    "cvc": "123"
  },
  "metadata": {
    "order_id": "ord_12345",
    "customer_name": "John Doe"
  }
}

{
  "id": "pay_1a2b3c4d5e6f",
  "amount": 2999,
  "currency": "usd",
  "status": "succeeded",
  "customer_id": "cus_1a2b3c4d5e6f",
  "description": "Monthly subscription",
  "created_at": "2024-03-15T10:30:00Z",
  "metadata": {
    "order_id": "ord_12345",
    "customer_name": "John Doe"
  }
}

Retrieve a payment

get

Retrieves the details of a previously created payment.

Authorizations

bearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header as a Bearer token. Example: Authorization: Bearer sk_test_1a2b3c4d5e6f

Path parameters

idstringRequired

The payment ID

Example: pay_1a2b3c4d5e6f

Responses

200

Payment retrieved successfully

application/json

idstringOptional

Unique identifier for the payment

Example: pay_1a2b3c4d5e6f

amountintegerOptional

Payment amount in cents

Example: 2999

currencystringOptional

Three-letter ISO currency code

Example: usd

statusstring · enumOptional

Current status of the payment

Example: succeededPossible values:

customer_idstring · nullableOptional

ID of the customer associated with this payment

Example: cus_1a2b3c4d5e6f

descriptionstring · nullableOptional

Description of the payment

Example: Monthly subscription

created_atstring · date-timeOptional

Timestamp when the payment was created

Example: 2024-03-15T10:30:00Z

401

Authentication failed

application/json

404

Payment not found

application/json

500

Internal server error

application/json

get

/payments/{id}

cURLPythonNode.jsRuby

curl https://api.evolvepayments.com/v1/payments/pay_1a2b3c4d5e6f \
  -H "Authorization: Bearer sk_test_1a2b3c4d5e6f"

{
  "id": "pay_1a2b3c4d5e6f",
  "amount": 2999,
  "currency": "usd",
  "status": "succeeded",
  "customer_id": "cus_1a2b3c4d5e6f",
  "description": "Monthly subscription",
  "created_at": "2024-03-15T10:30:00Z",
  "metadata": {
    "order_id": "ord_12345",
    "customer_name": "John Doe"
  }
}

Experimental

Refund a payment

post

Refunds a previously successful payment. You can refund the full amount or a partial amount.

Authorizations

bearerAuth

AuthorizationstringRequired

API key authentication. Include your API key in the Authorization header as a Bearer token. Example: Authorization: Bearer sk_test_1a2b3c4d5e6f

Path parameters

idstringRequired

The payment ID to refund

Example: pay_1a2b3c4d5e6f

Body

application/json

amountintegerOptional

Amount to refund in cents. If not provided, the full amount will be refunded.

Example: 1500

reasonstringOptional

Reason for the refund

Example: Customer requested refund

Responses

200

Payment refunded successfully

application/json

idstringOptional

Unique identifier for the payment

Example: pay_1a2b3c4d5e6f

amountintegerOptional

Payment amount in cents

Example: 2999

currencystringOptional

Three-letter ISO currency code

Example: usd

statusstring · enumOptional

Current status of the payment

Example: succeededPossible values:

customer_idstring · nullableOptional

ID of the customer associated with this payment

Example: cus_1a2b3c4d5e6f

descriptionstring · nullableOptional

Description of the payment

Example: Monthly subscription

created_atstring · date-timeOptional

Timestamp when the payment was created

Example: 2024-03-15T10:30:00Z

400

Invalid refund request

application/json

401

Authentication failed

application/json

404

Payment not found

application/json

500

Internal server error

application/json

post

/payments/{id}/refund

HTTPcURLJavaScriptPython

POST /v1/payments/{id}/refund HTTP/1.1
Host: api.evolvepayments.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "amount": 1500,
  "reason": "Customer requested refund"
}

{
  "id": "pay_1a2b3c4d5e6f",
  "amount": 2999,
  "currency": "usd",
  "status": "succeeded",
  "customer_id": "cus_1a2b3c4d5e6f",
  "description": "Monthly subscription",
  "created_at": "2024-03-15T10:30:00Z",
  "metadata": {
    "order_id": "ord_12345",
    "customer_name": "John Doe"
  }
}