---
updatedAt: 2025-08-27T16:21:46.000Z
agentTools:
  projectIndex: https://documentation.paysimple.com/llms.txt
---

# New Payment

Collect a payment for the specified `AccountId`.

The system determines the type of payment (ACH or credit card) based on the account type of the `AccountId` provided.

## Receipt Options

Receipt options allow setting payment receipt email settings. By default, no messages will be sent.

```json
...
"SuccessReceiptOptions": {
	"SendToCustomer": true,
  "SendToOtherAddresses": [ "joe@paysimple.com","bob@paysimple.com"]
}
...
```

**`SuccessReceiptOptions`**\
`SendToCustomer`  boolean.\
If `true`, send receipt to email of Customer when payment request succeeds.

`SendToOtherAddresses`\
Array of email addresses to send receipt to when payment request succeeds.

```json
...
"FailureReceiptOptions": {
	"SendToCustomer": true,
  "SendToOtherAddresses": [ "joe@paysimple.com","bob@paysimple.com"]
}
```

**`FailureReceiptOptions`**\
`SendToCustomer`  boolean.\
If `true`, send receipt to email of Customer when payment request fails.

`SendToOtherAddresses`\
Array of email addresses to send receipt to when payment request fails.

## Payment Response

See [Payment Response](https://documentation.paysimple.com/reference/payment-object) for response definition.

# OpenAPI definition

```json
{
  "openapi": "3.1.0",
  "info": {
    "title": "paysimple-api-40-do-not-delete",
    "version": "1.1"
  },
  "servers": [
    {
      "url": "https://api.paysimple.com/v4"
    }
  ],
  "security": [
    {}
  ],
  "paths": {
    "/payment": {
      "post": {
        "summary": "New Payment",
        "description": "Collect a payment for the specified `AccountId`.",
        "operationId": "new-payment",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "properties": {
                  "AccountId": {
                    "type": "integer",
                    "description": "Required.  The system identifier for the credit card Account or ACH account used for the payment. This is the `Id` attribute from the credit card object or ACH account object created in the previous step.",
                    "format": "int32"
                  },
                  "Amount": {
                    "type": "number",
                    "description": "Required. The amount to charge. Enter a number only, do not include the $. You can enter an integer or a decimal. If you use more than 2 decimal places, the system will round to the nearest penny-- i.e. entering 3.129 will result in a payment amount of 3.13.  Cannot exceed 2,000,000.00",
                    "format": "double"
                  },
                  "CVV": {
                    "type": "string",
                    "description": "Optional.  Credit card security code. Should be 4 characters for American Express or 3 characters for any other card type.",
                    "default": "null"
                  },
                  "PaymentSubType": {
                    "type": "string",
                    "description": "Optional.  This field defaults to `Moto` for credit card payments and `Web` for ACH payments if not included or left null.  CC Valid Values: `Swipe`, `Moto`.  ACH Valid Values: `Web`, `Tel`, `Ppd`, `Ccd`.",
                    "default": "MOTO or WEB"
                  },
                  "InvoiceId": {
                    "type": "integer",
                    "description": "Optional.  This is a system invoice identifier. If included it will seat the associated system invoice number in the InvoiceNumber attribute, and will apply the payment to the specified Invoice Id. NOTE: Invoice creation and management is not currently available via the API.",
                    "format": "int32"
                  },
                  "InvoiceNumber": {
                    "type": "string",
                    "description": "Optional.  This has a 50 characters max; the invoice number attached to the payment. If the number provided is a system invoice number, the associated InvoiceId will be attached to the payment and the payment will be applied to the system invoice. NOTE: Invoice creation and management is not currently available via the API."
                  },
                  "PurchaseOrderNumber": {
                    "type": "string",
                    "description": "Optional.  50 characters max. The purchase order number attached to the payment."
                  },
                  "OrderId": {
                    "type": "string",
                    "description": "Optional.  This has a 50 characters max; a back-end transaction identifier not included in the UI."
                  },
                  "Description": {
                    "type": "string",
                    "description": "Optional.  This has a 2048 characters max."
                  },
                  "Latitude": {
                    "type": "number",
                    "description": "Optional.  This field is not currently used in the UI, but will accept and save latitude values.",
                    "format": "double"
                  },
                  "Longitude": {
                    "type": "number",
                    "description": "Optional.  This field is not currently used in the UI, but will accept and save longitude values.",
                    "format": "double"
                  },
                  "SuccessReceiptOptions": {
                    "type": "object",
                    "description": "Optional.  See Receipt Options below.",
                    "properties": {}
                  },
                  "FailureReceiptOptions": {
                    "type": "object",
                    "description": "Optional.  See Receipt Options below.",
                    "properties": {}
                  },
                  "PaymentToken": {
                    "type": "string",
                    "description": "Optional. One time use token returned in PaySimpleJS."
                  },
                  "CardOnFileType": {
                    "type": "string",
                    "description": "Required for all COF transactions.  How the payment was collected. Options: `None`, `MerchantInitiated`, `CustomerInitiated`, `Recurring`, `Installment.`"
                  },
                  "NetworkTransactionId": {
                    "type": "string",
                    "description": "Conditional (required for Card on File transaction and requires CardOnFileType other than 'None').  Value provided by the card network to identify a specific card on file used in transactions of the same sale type. The response to the first successful transaction with a card on file will contain a Network Transaction Id. This id must be retained from the initial successful authorization and is required to be submitted with each subsequent sale or resubmission for a card on file."
                  },
                  "IsResubmission": {
                    "type": "boolean",
                    "description": "Conditional (requires CardOnFileType).  Set to true if the request is a resubmission of a previously failed authorization."
                  },
                  "ReturnUrl": {
                    "type": "string",
                    "description": "Conditional (required to support 3DS). A valid URL where customers will be redirected after completing 3DS verification. Only include if your customer is available to complete the verification. If not specified and 3DS is required the payment will fail with a 4040 error code."
                  }
                }
              }
            }
          }
        },
        "responses": {
          "201": {
            "description": "201",
            "content": {
              "application/json": {
                "examples": {
                  "Success": {
                    "value": {
                      "CustomerId": 9695143,
                      "CustomerFirstName": "Test",
                      "CustomerLastName": "Person",
                      "CustomerCompany": "NEW XYZ Company",
                      "ReferenceId": 0,
                      "Status": "Authorized",
                      "RecurringScheduleId": 0,
                      "PaymentType": "CC",
                      "PaymentSubType": "Moto",
                      "ProviderAuthCode": "Approved",
                      "TraceNumber": "659318",
                      "PaymentDate": "2018-01-12T07:00:00Z",
                      "ReturnDate": null,
                      "EstimatedSettleDate": "2018-01-16T07:00:00Z",
                      "EstimatedDepositDate": "2018-01-16T07:00:00Z",
                      "ActualSettledDate": null,
                      "CanVoidUntil": "2018-01-13T03:45:00Z",
                      "FailureData": null,
                      "RequiresReceipt": false,
                      "CVV": null,
                      "AccountId": 8989970,
                      "InvoiceId": null,
                      "Amount": 99.45,
                      "IsDebit": false,
                      "InvoiceNumber": null,
                      "PurchaseOrderNumber": null,
                      "OrderId": null,
                      "Description": null,
                      "Latitude": null,
                      "Longitude": null,
                      "SurchargeAmount": 0.01,
                      "SuccessReceiptOptions": null,
                      "NetworkTransactionId": "202107091214161",
                      "Id": 35067386,
                      "LastModified": "2018-01-12T17:33:46Z",
                      "CreatedOn": "2018-01-12T17:33:46Z"
                    }
                  },
                  "Card Decline": {
                    "value": {
                      "Meta": {
                        "Errors": null,
                        "HttpStatus": "Created",
                        "HttpStatusCode": 201,
                        "PagingDetails": null
                      },
                      "Response": {
                        "CustomerId": 8051100,
                        "CustomerFirstName": "John",
                        "CustomerLastName": "Doe",
                        "CustomerCompany": "Great Plumbing",
                        "ReferenceId": 0,
                        "Status": "Failed",
                        "RecurringScheduleId": 0,
                        "PaymentType": "CC",
                        "PaymentSubType": "Moto",
                        "ProviderAuthCode": "    DECLINE     ",
                        "TraceNumber": "05",
                        "PaymentDate": "2018-05-09T06:00:00Z",
                        "ReturnDate": null,
                        "EstimatedSettleDate": null,
                        "EstimatedDepositDate": null,
                        "ActualSettledDate": "2018-05-09T06:00:00Z",
                        "CanVoidUntil": "2018-05-10T02:45:00Z",
                        "FailureData": {
                          "Code": "4005",
                          "Description": "Do Not Honor",
                          "MerchantActionText": "Try a different payment method",
                          "IsDecline": true
                        },
                        "RequiresReceipt": false,
                        "CVV": null,
                        "AccountId": 7320843,
                        "InvoiceId": null,
                        "Amount": 9999.01,
                        "IsDebit": false,
                        "InvoiceNumber": null,
                        "PurchaseOrderNumber": null,
                        "OrderId": null,
                        "Description": null,
                        "Latitude": null,
                        "Longitude": null,
                        "SurchargeAmount": 0.01,
                        "SuccessReceiptOptions": null,
                        "FailureReceiptOptions": null,
                        "Id": 29124043,
                        "LastModified": "2018-05-09T21:03:45Z",
                        "CreatedOn": "2018-05-09T21:03:45Z"
                      }
                    }
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "title": "Success",
                      "type": "object",
                      "properties": {
                        "CustomerId": {
                          "type": "integer",
                          "example": 9695143,
                          "default": 0
                        },
                        "CustomerFirstName": {
                          "type": "string",
                          "example": "Test"
                        },
                        "CustomerLastName": {
                          "type": "string",
                          "example": "Person"
                        },
                        "CustomerCompany": {
                          "type": "string",
                          "example": "NEW XYZ Company"
                        },
                        "ReferenceId": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "Status": {
                          "type": "string",
                          "example": "Authorized"
                        },
                        "RecurringScheduleId": {
                          "type": "integer",
                          "example": 0,
                          "default": 0
                        },
                        "PaymentType": {
                          "type": "string",
                          "example": "CC"
                        },
                        "PaymentSubType": {
                          "type": "string",
                          "example": "Moto"
                        },
                        "ProviderAuthCode": {
                          "type": "string",
                          "example": "Approved"
                        },
                        "TraceNumber": {
                          "type": "string",
                          "example": "659318"
                        },
                        "PaymentDate": {
                          "type": "string",
                          "example": "2018-01-12T07:00:00Z"
                        },
                        "ReturnDate": {},
                        "EstimatedSettleDate": {
                          "type": "string",
                          "example": "2018-01-16T07:00:00Z"
                        },
                        "EstimatedDepositDate": {
                          "type": "string",
                          "example": "2018-01-16T07:00:00Z"
                        },
                        "ActualSettledDate": {},
                        "CanVoidUntil": {
                          "type": "string",
                          "example": "2018-01-13T03:45:00Z"
                        },
                        "FailureData": {},
                        "RequiresReceipt": {
                          "type": "boolean",
                          "example": false,
                          "default": true
                        },
                        "CVV": {},
                        "AccountId": {
                          "type": "integer",
                          "example": 8989970,
                          "default": 0
                        },
                        "InvoiceId": {},
                        "Amount": {
                          "type": "number",
                          "example": 99.45,
                          "default": 0
                        },
                        "IsDebit": {
                          "type": "boolean",
                          "example": false,
                          "default": true
                        },
                        "InvoiceNumber": {},
                        "PurchaseOrderNumber": {},
                        "OrderId": {},
                        "Description": {},
                        "Latitude": {},
                        "Longitude": {},
                        "SuccessReceiptOptions": {},
                        "NetworkTransactionId": {
                          "type": "string",
                          "example": "202107091214161"
                        },
                        "Id": {
                          "type": "integer",
                          "example": 35067386,
                          "default": 0
                        },
                        "LastModified": {
                          "type": "string",
                          "example": "2018-01-12T17:33:46Z"
                        },
                        "CreatedOn": {
                          "type": "string",
                          "example": "2018-01-12T17:33:46Z"
                        }
                      }
                    },
                    {
                      "title": "Card Decline",
                      "type": "object",
                      "properties": {
                        "Meta": {
                          "type": "object",
                          "properties": {
                            "Errors": {},
                            "HttpStatus": {
                              "type": "string",
                              "example": "Created"
                            },
                            "HttpStatusCode": {
                              "type": "integer",
                              "example": 201,
                              "default": 0
                            },
                            "PagingDetails": {}
                          }
                        },
                        "Response": {
                          "type": "object",
                          "properties": {
                            "CustomerId": {
                              "type": "integer",
                              "example": 8051100,
                              "default": 0
                            },
                            "CustomerFirstName": {
                              "type": "string",
                              "example": "John"
                            },
                            "CustomerLastName": {
                              "type": "string",
                              "example": "Doe"
                            },
                            "CustomerCompany": {
                              "type": "string",
                              "example": "Great Plumbing"
                            },
                            "ReferenceId": {
                              "type": "integer",
                              "example": 0,
                              "default": 0
                            },
                            "Status": {
                              "type": "string",
                              "example": "Failed"
                            },
                            "RecurringScheduleId": {
                              "type": "integer",
                              "example": 0,
                              "default": 0
                            },
                            "PaymentType": {
                              "type": "string",
                              "example": "CC"
                            },
                            "PaymentSubType": {
                              "type": "string",
                              "example": "Moto"
                            },
                            "ProviderAuthCode": {
                              "type": "string",
                              "example": "    DECLINE     "
                            },
                            "TraceNumber": {
                              "type": "string",
                              "example": "05"
                            },
                            "PaymentDate": {
                              "type": "string",
                              "example": "2018-05-09T06:00:00Z"
                            },
                            "ReturnDate": {},
                            "EstimatedSettleDate": {},
                            "EstimatedDepositDate": {},
                            "ActualSettledDate": {
                              "type": "string",
                              "example": "2018-05-09T06:00:00Z"
                            },
                            "CanVoidUntil": {
                              "type": "string",
                              "example": "2018-05-10T02:45:00Z"
                            },
                            "FailureData": {
                              "type": "object",
                              "properties": {
                                "Code": {
                                  "type": "string",
                                  "example": "4005"
                                },
                                "Description": {
                                  "type": "string",
                                  "example": "Do Not Honor"
                                },
                                "MerchantActionText": {
                                  "type": "string",
                                  "example": "Try a different payment method"
                                },
                                "IsDecline": {
                                  "type": "boolean",
                                  "example": true,
                                  "default": true
                                }
                              }
                            },
                            "RequiresReceipt": {
                              "type": "boolean",
                              "example": false,
                              "default": true
                            },
                            "CVV": {},
                            "AccountId": {
                              "type": "integer",
                              "example": 7320843,
                              "default": 0
                            },
                            "InvoiceId": {},
                            "Amount": {
                              "type": "number",
                              "example": 9999.01,
                              "default": 0
                            },
                            "IsDebit": {
                              "type": "boolean",
                              "example": false,
                              "default": true
                            },
                            "InvoiceNumber": {},
                            "PurchaseOrderNumber": {},
                            "OrderId": {},
                            "Description": {},
                            "Latitude": {},
                            "Longitude": {},
                            "SuccessReceiptOptions": {},
                            "FailureReceiptOptions": {},
                            "Id": {
                              "type": "integer",
                              "example": 29124043,
                              "default": 0
                            },
                            "LastModified": {
                              "type": "string",
                              "example": "2018-05-09T21:03:45Z"
                            },
                            "CreatedOn": {
                              "type": "string",
                              "example": "2018-05-09T21:03:45Z"
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "400": {
            "description": "400",
            "content": {
              "application/json": {
                "examples": {
                  "Invalid Customer Account Id": {
                    "value": " {\n  \"Meta\": {\n  \"Errors\": {\n      \"ErrorCode\": \"InvalidInput\",\n      \"ErrorMessages\": [\n        {\n          \"Field\": \"\",\n          \"Message\": \"Specified Customer Account Id is not valid\"\n        }\n      ]\n    },\n    \"HttpStatus\": \"BadRequest\",\n    \"HttpStatusCode\": 400,\n    \"PagingDetails\": null\n  },\n  \"Response\": null\n}"
                  },
                  "Account Deleted": {
                    "value": "{\n    \"Meta\": {\n        \"Errors\": {\n            \"ErrorCode\": \"InvalidInput\",\n            \"ErrorMessages\": [{\n                \"Field\": \"\",\n                \"Message\": \"Account with ID 394099 has been deleted\"\n            }],\n            \"TraceCode\": null\n        },\n        \"HttpStatus\": \"BadRequest\",\n        \"HttpStatusCode\": 400,\n        \"PagingDetails\": null\n    },\n    \"Response\": null\n}"
                  }
                },
                "schema": {
                  "oneOf": [
                    {
                      "title": "Invalid Customer Account Id",
                      "type": "object",
                      "properties": {
                        "Meta": {
                          "type": "object",
                          "properties": {
                            "Errors": {
                              "type": "object",
                              "properties": {
                                "ErrorCode": {
                                  "type": "string",
                                  "example": "InvalidInput"
                                },
                                "ErrorMessages": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "Field": {
                                        "type": "string",
                                        "example": ""
                                      },
                                      "Message": {
                                        "type": "string",
                                        "example": "Specified Customer Account Id is not valid"
                                      }
                                    }
                                  }
                                }
                              }
                            },
                            "HttpStatus": {
                              "type": "string",
                              "example": "BadRequest"
                            },
                            "HttpStatusCode": {
                              "type": "integer",
                              "example": 400,
                              "default": 0
                            },
                            "PagingDetails": {}
                          }
                        },
                        "Response": {}
                      }
                    },
                    {
                      "title": "Account Deleted",
                      "type": "object",
                      "properties": {
                        "Meta": {
                          "type": "object",
                          "properties": {
                            "Errors": {
                              "type": "object",
                              "properties": {
                                "ErrorCode": {
                                  "type": "string",
                                  "example": "InvalidInput"
                                },
                                "ErrorMessages": {
                                  "type": "array",
                                  "items": {
                                    "type": "object",
                                    "properties": {
                                      "Field": {
                                        "type": "string",
                                        "example": ""
                                      },
                                      "Message": {
                                        "type": "string",
                                        "example": "Account with ID 394099 has been deleted"
                                      }
                                    }
                                  }
                                },
                                "TraceCode": {}
                              }
                            },
                            "HttpStatus": {
                              "type": "string",
                              "example": "BadRequest"
                            },
                            "HttpStatusCode": {
                              "type": "integer",
                              "example": 400,
                              "default": 0
                            },
                            "PagingDetails": {}
                          }
                        },
                        "Response": {}
                      }
                    }
                  ]
                }
              }
            }
          }
        },
        "deprecated": false,
        "security": []
      }
    }
  },
  "x-readme": {
    "headers": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "explorer-enabled": false,
    "proxy-enabled": false
  },
  "x-readme-fauxas": true
}
```