PayConexDecryptxShieldConexTECS Platform
API Reference
Request SandboxContact Us

Process a Force

post
https://api-cert.payconex.net/api/v4/accounts//payments/force

Process a Force.

Required Scopes

The API Key calling this endpoint must have one of the following scopes:

  • pcx:payments:*
  • pcx:payments:card_not_present:*
  • pcx:payments:card_not_present:force
Path Params
string
required
Body Params

Force Details.

billPayment
object
string
required

Auth Code of transaction to be forced

string

Optional field

string
enum
required

The type of Point of Sale used for the transaction

Allowed:
rules
object
string

A token reference used for making payments

shieldConexToken
object

The token returned from a Shieldconex operation

amounts
object
required
credentialOnFile
object
string
customer
object
shippingAddress
object
level2
object
string

The name of the Level3 Profile.

level3
object
items
array of objects
length ≥ 1
items
string
required
length between 1 and 12

International description code of the individual good or service being supplied.

Recommend using national or international list of standardized codes.

string
required
length between 1 and 35

Item description

string
required
length between 1 and 12

Merchant-defined description code of the item.

string
required

Quantity of the item (up to four decimal places).

DDDDDDD.CCCC

string
required
length between 1 and 12

Code for units of measurement used in international trade.

string
required

Unit cost of the item.

DDDDDDD.CC

string | null

Amount of any sales or value added taxes associated with the item.

string | null

LineItemVATAmount.

Submitted Tax rate used to calculate as a percentage.

Two-digit implied decimal.

For example, if 10.42%, submit 1042

string | null

Discount amount applied to the line item.

This field should be 0.00 if the unit cost reflects a discount price or if no line item discount applies

DDDDDDDDD.CC

string | null

Total full amount associated with the line item (including tax).

DDDDDDDDD.CC

string | null

Tax identification number of the merchant reporting the alternate tax amount.

Not applicable for US merchants. (tag must be present, but can be empty)

string | null

Tax identification number of the merchant reporting the alternate tax amount.

Not applicable for US merchants.

(tag must be present, but can be empty)

string | null
enum

Indicates whether discount was applied to the purchase price of the item.

0 = Not supported

1 = Amount is discounted

2 = Amount is not discounted

Allowed:
string | null
enum

Indicates whether extended item amount included the tax.

0 = Not supported

1 = Item Amount includes tax amount

2 = Item Amount does not include tax amount

Allowed:
string | null

Amount of the item (price multiplied by quantity).

DDDDDDDDD.CC

string | null
enum

Indicates whether ExtendedItemAmount is a Credit (taking away from the total amount of the sale) or Debit (adding to the total amount of the sale).

0 = Not supported

1 = Extended Item Amount is Credit

2 = Extended Item Amount is Debit

Allowed:
string | null

Discount rate for the line item.

Submitted as a percentage.

Two-digit implied decimal.

For example, if 10.42%, submit 1042

trace
object
string
length between 1 and 25

Name of the dynamic descriptor

Responses

Updated 12 months ago

Language
Credentials
Basic
base64
:
URL
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 12 months ago