Create an invoice

post

https://api.processout.com/invoices

Body Params

name

string

required

Name of the invoice (often an internal ID code from the merchant’s systems).

amount

string

required

Amount to be paid. Maximum 4 decimal places supported as per ISO 4217.

tax

object

Tax information for the invoice.

currency

string

required

Currency for payment of the invoice, in ISO 4217 format (for example, USD). Must be a valid ISO 4217 currency code with 3 characters

order_id

string

Your unique identifier for the order associated with this invoice. This field is displayed in the Dashboard and ProcessOut uses it to deduplicate invoices and transactions.

customer_id

string

Resource expandable
Customer linked to the invoice (generally the one making the purchase).

verification

boolean

Tags an invoice to be used as an verification invoice. When this is set to true, we will attempt to automatically utilise the lowest amount applicable for a given PSP & Currency. Otherwise, we will default to utilising the invoice amount provided.

expires_at

date

Expiry date for the invoice

auto_capture_at

date

Optional if you want us to auto capture for you. Expected value is a date and time in ISO 8601 format.

details

object

Details of the items or products that are being purchased.

risk

object

Risk assessment for the invoice.

device

object

Information about the device and channel used by the customer to initiate the payment.

external_fraud_tools

object

Information to forward to external fraud tools.

shipping

object

Shipping information for the invoice.

billing

object

Billing information for the invoice. This address will be used to populate the Customer and Card address if empty.

statement_descriptor

string

Item that will be listed for this purchase on the customer’s bank statement.
Maximum 25 characters long, should only contain letters, numbers, spaces, dots, asterisks and forward slashes

statement_descriptor_phone

string

Support phone number for this purchase on the customer’s bank statement.

statement_descriptor_city

string

City shown for this purchase on the customer’s bank statement. Maximum 22 characters long. Should only contain letters and numbers.

statement_descriptor_company

string

Your company name to show on the customer’s bank statement.

statement_descriptor_url

string

Support URL for this purchase on the customer’s bank statement.

initiation_type

string

Represent the initiation type of the transaction which can be Customer Initiated Transaction (cit) or Merchant Initiated Transaction (mit).
Allowed values are: cit or mit

payment_intent

string

The type of payment flow that generated the transaction.
Allowed values are: one-off, recurring, recurring-standing-order, recurring-subscription, installment, unscheduled, unscheduled-delayed-charge, unscheduled-resubmission, unscheduled-no-show or unscheduled-reauthorization.

This field should be used in combination with the initiation_type field to tag scenarios such as initial CIT of a recurring sequence.

payment_type

string

Optional information about the payment type
Allowed values are “moto” or “ecommerce”

return_url

string

For APMs, this is the URL to return to the app after payment is accepted.
Must be a valid URL

webhook_url

string

Custom webhook URL for this purchase.
Must be a valid URL

sca_exemption_reason

string

Optional reason for requesting SCA exemption (Note: This must also be supported by the PSP. Please contact us for more information.)
Allowed values are: low-value, trusted-beneficiary or transaction-risk-analysis

challenge_indicator

string

Optional challenge indicator field when requesting 3DS2 (Note: This must also be supported by the PSP. Please contact us for more information.)
Allowed values are: no-preference, no-challenge-requested, challenge-requested, challenge-requested-mandate, no-challenge-requested-tra-performed, no-challenge-requested-data-share-only, no-challenge-requested-sca-performed, no-challenge-requested-whitelist-exemption, challenge-requested-whitelist-prompt or cb-scoring

unsupported_feature_bypass

object

Bypass payment provider unsupported features set in the transaction

metadata

json

Defaults to {}

Custom key/value pair (string/string) metadata that can be used to identify the transaction. This information is passed to upstream payment providers that support similar metadata objects. Do not include personal data in this field.

gateway_data

json

Defaults to {}

Used for custom logics / data sent to payment providers.
This field is not standard across providers.

split_allocations

array of objects

An array of allocation objects that defines how a single payment should be divided among different recipients. Each object in this array represents one "split" of the total invoice amount.

split_allocations

submerchant

object

All fields are optional. The submerchant data is passed to payment processors that support PayFac/marketplace scenarios for compliance and settlement purposes. Please speak to your Account Manager to confirm this is supported on your Connections.

Headers

Idempotency-Key

string

Unique key to your request that will be used for idempotency

string

Responses

200200

400400

401401

4XX4XX