post https://testapi.payarc.net/v1/refunds/wo_reference
This API refunds a charge to a customer in the absense of an existing charge.
Click to view details about the parameters required for a transaction
1. Amount (amount
)
amount
)- Type:
integer
- Description: A positive integer in cents representing how much to charge.
- Required: Yes
- Format: Numeric (in cents)
- Min Length: 1 digit
- Max Length: 8 digits
- Example:
9
would be$0.09
99999999
would be$999,999.99
- Note: The minimum amount is
$0.50 USD
when testing in the test environment.
2. Currency (currency
)
currency
)- Type:
string
- Description: Three-letter ISO currency code, in lowercase.
- Required: Yes
- Format: Alphabetic
- Allowed Values:
usd
3. Card Number (card_number
)
card_number
)- Type:
integer
- Description: The 14-19 digit card number used for the transaction.
- Required: Yes
- Format: Numeric
- Min Length: 14 digits
- Max Length: 19 digits
- Note: Following are the examples:
- VISA: 4012000098765439 | Expiration: 12/2025 | CVV: 999
- MASTERCARD: 5146315000000055 | Expiration: 12/2025 | CVV: 998
- AMEX: 371449635392376 | Expiration: 12/2025 | CVV: 9997
- DISCOVER: 6011000993026909 | Expiration: 12/2025 | CVV: 996
- DISCOVER CUP: 6282000123842342 | Expiration: 12/2025 | CVV: 996
- DINERS: 3055155515160018 | Expiration: 12/2025 | CVV: 996
- JCB: 3530142019945859 | Expiration: 12/2025 | CVV: 996
4. Expiration Month (exp_month
)
exp_month
)- Type:
integer
- Description: The month value displayed on the card used for the transaction.
- Required: Yes
- Format: Numeric
- Min Month Value: 1
- Max Month Value: 12
- Example:
01
represents the month of January.
5. Expiration Year (exp_year
)
exp_year
)- Type:
integer
- Description: The YYYY value mentioned on the card used for the transaction.
- Required: Yes
- Format: Numeric
- Min Length: 2 digits
- Max Length: 4 digits
- Example:
2025
6. CVV (cvv
)
cvv
)- Type:
integer
- Description: The three or four digit security code on the card.
- Required: Conditional
- Format: Numeric
- Min Length: 3 digits
- Max Length: 4 digits
- Note:
- This field can be set as 'Required' or 'Optional' at the account level by a PAYARC Admin. Email [email protected] to contact the Admin.
- If this field is set as 'Required' and is not sent or is incorrect, then the transaction may be declined based on the risk parameters set.
- If this field is set as 'Optional' and is not sent or is incorrect, then the transaction will be processed as CVV availability not provided.
7. Reason (reason
)
reason
)- Type:
string
- Description: Reason for the refund.
- Required: Optional
- Format: Alphabetic
8. Statement Description (statement_description
)
statement_description
)- Type:
string
- Description: An arbitrary string to be displayed on the customer’s credit card statement.
- Required: Optional
- Format: Alphanumeric and Whitespace
- Min Length: 5 characters
- Max Length: 25 characters
- Example:
A1 Company
9. Card Holder Name (card_holder_name
)
card_holder_name
)- Type:
string
- Description: Name of the cardholder as mentioned on the card used to carry out a transaction.
- Required: Yes
- Format: Alphabetic and Whitespace
- Min Length: 2 characters
- Max Length: 30 characters
- Example:
John Smith
10. ZIP (zip
)
zip
)- Type:
integer
- Description: The cardholder's billing ZIP code.
- Required: Conditional
- Format: Numeric
- Min Length: 2 digits
- Max Length: 10 digits
- Example:
10469
- Note: This field will be 'Required' if address information is requested by the merchant.
11. Address Line 1 (address_line1
)
address_line1
)- Type:
string
- Description: The cardholder's billing address for line 1.
- Required: Conditional
- Format: Alphanumeric
- Min Length: 1 character
- Max Length: 200 characters
- Example:
103 Mason Street
- Note: This field will be 'Required' if address information is requested by the merchant.
12. Address Line 2 (address_line2
)
address_line2
)- Type:
string
- Description: The cardholder's billing address for line 2.
- Required: Optional
- Format: Alphanumeric
- Min Length: 1 character
- Max Length: 200 characters
- Example:
2nd Floor
13. City (city
)
city
)- Type:
string
- Description: The cardholder's city name. Can be a City/District/Suburb/Town/Village.
- Required: Conditional
- Format: Alphabetic and Whitespace
- Min Length: 1 character
- Max Length: 50 characters
- Example:
New York
- Note: This field will be 'Required' if address information is requested by the merchant.
14. State (state
)
state
)- Type:
string
- Description: The cardholder's state name. Can be State/County/Province/Region.
- Required: Conditional
- Format: Alphabetic and Whitespace
- Min Length: 1 character
- Max Length: 50 characters
- Example:
NY
- Note: This field will be 'Required' if address information is requested by the merchant.
15. Country (country
)
country
)- Type:
string
- Description: The cardholder's country name.
- Required: Conditional
- Format: Alphabetic
- Min Length: 1 character
- Max Length: 50 characters
- Example:
US
- Note: This field will be 'Required' if address information is requested by the merchant.
16. Receipt Phone (receipt_phone
)
receipt_phone
)- Type:
integer
- Description: The cardholder's phone number.
- Required: Optional
- Format: Numeric
- Min Length: 2 digits
- Max Length: 11 digits
- Example:
8772036624
17. Receipt Email (receipt_email
)
receipt_email
)- Type:
string
- Description: The cardholder's email address.
- Required: Optional
- Format: Alphanumeric and Special characters
- Min Length: 5 characters
- Max Length: 40 characters
- Example:
[email protected]
18. Customer ID (customer_id
)
customer_id
)- Type:
string
- Description: The unique identifier for a customer. A transaction is associated with a customer when a customer ID is included in the request.
- Required: Conditional
- Format: Alphanumeric
- Note:
customer_id
is required when the following values are not present in the request:token_id
,card_number
,track2Data
.