New Payment

post

https://api.paysimple.com/v4/payment

Collect a payment for the specified AccountId.

Body Params

AccountId

int32

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.

Amount

double

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

CVV

string

Defaults to null

Optional. Credit card security code. Should be 4 characters for American Express or 3 characters for any other card type.

PaymentSubType

string

Defaults to MOTO or WEB

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.

InvoiceId

int32

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.

InvoiceNumber

string

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

string

Optional. 50 characters max. The purchase order number attached to the payment.

OrderId

string

Optional. This has a 50 characters max; a back-end transaction identifier not included in the UI.

Description

string

Optional. This has a 2048 characters max.

Latitude

double

Optional. This field is not currently used in the UI, but will accept and save latitude values.

Longitude

double

Optional. This field is not currently used in the UI, but will accept and save longitude values.

PaymentToken

string

Optional. One time use token returned in PaySimpleJS.

CardOnFileType

string

Required for all COF transactions. How the payment was collected. Options: None, MerchantInitiated, CustomerInitiated, Recurring, Installment.

NetworkTransactionId

string

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

boolean

Conditional (requires CardOnFileType). Set to true if the request is a resubmission of a previously failed authorization.

ReturnUrl

string

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

201201

400400