Use this method to retrieve information about a refund.
To retrieve a refund, you need its refundId. Our gateway returned the refundId in the response of the Refund Payment method or the Create Refund method.
Note: If you don't have the refundId, use our List Refunds method to search for the refund.
Our gateway returns the following information about the refund:
Order details, including the refund amount and when we processed the refund.
Payment card details, including the masked card number, expiry date, and payment method.
Cardholder details, including their contact information and shipping address.
If the refund is a referenced refund, our gateway also returns details about the payment that the refund is linked to.
Parameters
Name
In
Type
Description
refundIdRequired
path
string
Unique identifier that our gateway assigned to the refund.
Responses
Successful request. Returns the specific refund.
200 OK · application/json
{"card":{"cardNumber":"453985******7062","entryMethod":"keyed","expiryDate":"1230","type":"Visa Credit"},"customFields":[{"name":"yourCustomField","value":"abc123"}],"order":{"amount":4999,"currency":"USD","dateTime":"2024-07-02T15:30:00Z","description":"Refund for order OrderRef6543","orderId":"OrderRef6543"},"processingTerminalId":"1234001","refundId":"CD3HN88U9F","transactionResult":{"approvalCode":"000000","authorizedAmount":-4999,"currency":"USD","responseCode":"A","responseMessage":"OK5","status":"ready","type":"refund"}}
Response schema · 94 of 112 fields
cardobjectrequired
Object that contains the details of the payment card.
balancesobject[]
Array of cardBalance objects. Our gateway returns this array only when the customer uses an Electronic Benefit Transfer (EBT) card.
amountintegerint64required
Current balance of the account. This value is in the currency's lowest denomination, for example, cents.
benefitCategorystringrequired
Indicates if the balance relates to an EBT Cash account or EBT SNAP account. cash – EBT Cash foodStamp – EBT SNAPcashfoodStamp
currencystringrequired
Currency of the transaction. The value for the currency follows the ISO 4217 standard.AEDAFNALLAMDANGAOAARSAUD+163 more
cardNumberstringrequired
Masked card number. Our gateway shows only the first six digits and the last four digits of the card number, for example, 500165******0000.12–19 chars
cardholderNamestring
Cardholder’s name.1–50 chars
cardholderSignaturestring
Cardholder’s signature.
emvTagsobject[]
Array of emvTag objects.
hexstringrequired
Hex code of the EMV tag.
valuestringrequired
Value of the EMV tag.
entryMethodstring
Method that the device used to capture the card details.icckeyedswipedswipedFallbackcontactlessIcccontactlessMsr
expiryDatestringrequired
Expiry date of the customer's card. The format is in MMYY.[0-9]{4}
secureTokenobject
Object that contains information about the secure token.
customerNamestringrequired
Customer's name.1–50 chars
linkobject
Object that contains HATEOAS links for the resource.+3 more fields at deeper levels — see the full spec
secureTokenIdstringrequired
Unique identifier that the merchant assigned to the secure token.1–200 chars
statusstringrequired
Status of the customer's bank account. The processor performs a security check on the customer's bank account and returns the status of the account. Note: Depending on the merchant's account settings, this feature may be unavailable.notValidatedcvvValidatedvalidationFailedissueNumberValidatedcardNumberValidatedbankAccountValidated
tokenstringrequired
Token that the merchant can use in future transactions to represent the customer's payment details. The token: Begins with the six-digit identification number 296753. Contains up to 12 digits. Contains a single check digit that we calculate using the Luhn algorithm.12–19 chars
securityChecksobject
Object that contains information about card verification and security checks.
avsResultstring
Indicates if the address that the customer provided in the request matches the address linked to the card. Y – The address in the request matches the address linked to the card. N – The address in the request doesn’t match the address linked to the card. A – The street address matches, but ZIP code or postal code doesn’t match. Z The ZIP code or postal code matches, but street address doesn’t match. U – The address information is unavailable. G – The issuer or card brand doesn’t support the Address Verification Service (AVS). R – The AVS is currently unavailable. Try again later. S – There was no AVS data in the request, or it was sent in the wrong format. F For UK addresses, the address in the request matches the address linked to the card. W – For US addresses, the nine-digit ZIP code or postal code in the request matches the address linked to the card but the street address doesn’t. X – For US addresses, the nine-digit ZIP code or postal code and the street address matches the address linked to the card. Note: Our gateway doesn’t automatically decline transactions when the address doesn’t match the address linked to the card, unless the merchant selects this setting in their account.YAZNURGS+3 more
cvvResultstring
Indicates if the card verification value (CVV) that the customer provided in the request matches the CVV on the card. M – The CVV matches the card’s CVV. N – The CVV doesn’t match the card’s CVV. P – The CVV wasn’t processed. U – The CVV isn’t registered. Note: Our gateway doesn’t automatically decline transactions when the CVV doesn’t match the card’s CVV, unless the merchant selects this setting in their account.MNPU
typestringrequired
Card brand that the card is linked to. For example, Visa.
customFieldsobject[]
Array of customField objects.
namestringrequired
Name of the custom field.1–56 chars
valuestringrequired
Value for the custom field.1–100 chars
customerobject
Object that contains the customer's contact details and address information.
billingAddressobject
Object that contains information about the address.
address1string
Address line 1.≤ 150 chars
address2string
Address line 2.≤ 150 chars
address3string
Address line 3.≤ 150 chars
citystring
City.≤ 50 chars
countrystring
Two-digit country code for the country that the business operates in. The format follows the ISO-3166-1 standard.2–2 chars
postalCodestring
Zip code or postal code.≤ 10 chars
statestring
Name of the state or state abbreviation.≤ 50 chars
contactMethodsobject[]
Array of polymorphic objects, which contain contact information. The value of the type parameter determines which variant you should use: email Email address phone Phone number mobile Mobile number fax Fax number
emailobject
+2 more fields at deeper levels — see the full spec
phoneobject
+2 more fields at deeper levels — see the full spec
mobileobject
+2 more fields at deeper levels — see the full spec
faxobject
+2 more fields at deeper levels — see the full spec
dateOfBirthstringdate
Customer's date of birth. The format for this value is YYYY-MM-DD.
firstNamestring
Customer's first name.0–60 chars
lastNamestring
Customer's last name.0–60 chars
notificationLanguagestringiso-639-1
Language that the customer uses for notifications. This code follows the ISO 639-1 alpha-2 standard.2–2 charsenfr
referenceNumberstring
Identifier of the transaction, also known as a customer code. For requests, you must send a value for referenceNumber if the customer provides one.0–48 chars
shippingAddressobject
Object that contains information about the customer and their shipping address.
addressobject
Object that contains information about the address.+7 more fields at deeper levels — see the full spec
recipientNamestring
Recipient's name.0–50 chars
operatorstring
Operator who requested the refund.0–50 chars
orderobjectrequired
Object that contains information about the refund.
amountintegerint64required
Total amount of the transaction. The value is in the currency’s lowest denomination, for example, cents.
currencystringrequired
Currency of the transaction. The value for the currency follows the ISO 4217 standard.AEDAFNALLAMDANGAOAARSAUD+163 more
dateTimestringdate-time
Date and time that the processor processed the transaction. Our gateway returns this value in the ISO 8601 format.
descriptionstringrequired
Description of the transaction.0–1024 chars
orderIdstringrequired
Unique identifier that the merchant assigns to the transaction.1–24 chars
dccOfferobject
Object that contains information about the dynamic currency conversion (DCC) offer. For more information about DCC, go to Dynamic Currency Conversion.
acceptedboolean
Indicates if the cardholder accepted DCC offer.
fxAmountintegerint64required
Amount in the cardholder’s currency in the currency’s lowest denomination, for example, cents.
fxCurrencystringrequired
Currency of the transaction in the card’s currency. The value for the currency follows the ISO 4217 standard.AEDAFNALLAMDANGAOAARSAUD+163 more
fxCurrencyCodestring
Three-digit currency code for the card. This code follows the ISO 4217 standard.3–3 chars
fxCurrencyExponentintegerint32
Number of decimal places between the smallest currency unit and a whole currency unit. For example, for GBP, the smallest currency unit is 1p and it is equal to £0.01. If you use GBP, the value for fxCurrencyExponent is 2.
fxRatenumberdoublerequired
Foreign exchange rate for the card's currency.
markupnumberdoublerequired
Markup percentage rate that the DCC provider applies to the foreign exchange rate.
markupTextstring
Supporting text for the markup rate.
offerReferencestring
Unique identifier of the DCC offer.
providerstring
Name of the DCC provider.
sourcestring
Source that the DCC provider used to get the foreign exchange rates.
paymentobject
Object that contains information about a payment.
amountintegerint64required
Amount of the payment. This value is in the currency’s lowest denomination, for example, cents.
currencystringrequired
Currency of the transaction. The value for the currency follows the ISO 4217 standard.AEDAFNALLAMDANGAOAARSAUD+163 more
dateTimestringdate-timerequired
Date and time that the payment was processed.
linkobject
Object that contains HATEOAS links for the resource.
hrefstringrequired
URL of the target resource.
methodstringrequired
HTTP method that you need to use with the target resource.
relstringrequired
Indicates the relationship between the current resource and the target resource.
paymentIdstringrequired
Unique identifier of the payment.10–10 chars
responseCodestringrequired
Response from the processor. A The processor approved the transaction. D The processor declined the transaction. E The processor received the transaction but will process the transaction later. P The processor authorized a portion of the original amount of the transaction. R The issuer declined the transaction and indicated that the customer should contact their bank. C The issuer declined the transaction and indicated that the merchant should keep the card as it was reported lost or stolen.ADEPRC
responseMessagestring
Response description from the processor.1–48 chars
statusstringrequired
Current status of the payment.readypendingdeclinedcompletereferralpickupreversalreturned+3 more
processingTerminalIdstringrequired
Unique identifier that we assigned to the terminal.4–50 chars
refundIdstringrequired
Unique identifier that our gateway assigned to the refund.10–10 chars
Object that contains information about the transaction response details.
approvalCodestring
Authorization code that the processor assigned to the transaction.1–48 chars
authorizedAmountintegerint64
Amount that the processor authorized for the transaction. This value is in the currency’s lowest denomination, for example, cents. Notes: For partial authorizations, this amount is lower than the amount in the request. If the value for authorizedAmount is negative, this indicates that the merchant sent funds to the customer.
cardSchemeReferenceIdstring
Identifier that the card brand assigns to the payment instruction.1–64 chars
currencystring
Currency of the transaction. The value for the currency follows the ISO 4217 standard.AEDAFNALLAMDANGAOAARSAUD+163 more
ebtTypestring
Indicates the subtype of EBT in the transaction.cashPurchasecashPurchaseWithCashbackfoodStampPurchasefoodStampVoucherPurchasefoodStampReturnfoodStampVoucherReturncashBalanceInquiryfoodStampBalanceInquiry+1 more
healthcareIndicatorstring
Indicates if we processed the payment as a healthcare expense. The value is one of the following: Y We processed the payment as a healthcare expense. N We processed the payment but it didn't contain any healthcare expenses. C We processed the payment but the card isn't linked to a Flexible Spending Account (FSA) or a Health Savings Account (HSA). R We processed the payment but the card doesn't support healthcare expenses.YNCR
processorResponseCodestring
Original response code that the processor sent.
responseCodestringrequired
Response from the processor. A The processor approved the transaction. D The processor declined the transaction. E The processor received the transaction but will process the transaction later. P The processor authorized a portion of the original amount of the transaction. R The issuer declined the transaction and indicated that the customer should contact their bank. C The issuer declined the transaction and indicated that the merchant should keep the card as it was reported lost or stolen.ADEPRC
responseMessagestring
Response description from the processor.1–48 chars
statusstringrequired
Status of the transaction. The value is one of the following: ready Successful transaction. We added the payment to the open batch. pending Successful transaction. We added the payment to the open batch, but we don't collect the funds until the merchant captures the transaction. declined Unsuccessful transaction. The cardholder's issuing bank declined the transaction. complete Successful transaction. The funds have moved to the merchant's bank account. referral Unsuccessful transaction. The issuing bank identified an issue with the transaction. You should treat a referral status as a declined transaction. pickup Unsuccessful transaction. The issuing bank has reported that the card is lost or stolen. reversal Transaction canceled. The transaction was canceled, and we removed the transaction from the open batch. admin Transaction under review. We have flagged an issue with the transaction. expired Transaction expired. If a transaction stays in pending status for too long, it expires. accepted Transaction in progress. The transaction is in progress with the processor but we can't confirm the result yet.readypendingdeclinedcompletereferralpickupreversaladmin+2 more
{"detail":"One or more validation errors occurred, see error section for more info","errors":[{"detail":"invalid date","message":"Expected time, got '' for start_time","parameter":"start_time"}],"status":400,"title":"Bad request","type":"https://docs.payroc.com/api/errors#bad-request"}
Response schema · 8 fields
detailstringrequired
Explanation of the problem
errorsobject[]
detailstring
Short detail of the validation errors
messagestring
Error message
parameterstring
The parameter or field causing the issues
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type
Identity could not be verified
401 Unauthorized · application/problem+json
{"detail":"Your identity could not be verified","status":401,"title":"Not Authorized","type":"https://docs.payroc.com/api/errors#not-authorized"}
Response schema · 4 fields
detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type
Do not have permissions to perform this action
403 Forbidden · application/problem+json
{"detail":"You do not have the required permissions to perform this action","instance":"https://api.payroc.com/v1/exampleResource/3","resource":"exampleResource","status":403,"title":"Forbidden","type":"https://docs.payroc.com/api/errors#forbidden"}
Response schema · 6 fields
detailstringrequired
Explanation of the problem
instancestring
Resource path the action was attempted on
resourcestring
Resource the action was attempted on
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type
Resource not found
404 Not Found · application/problem+json
{"detail":"Resource not found","resource":"(The Type of the Resource)","status":404,"title":"Not found","type":"https://docs.payroc.com/api/errors#not-found"}
Response schema · 5 fields
detailstringrequired
Explanation of the problem
resourcestring
Resource that was not found
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type
Not acceptable
406 Not Acceptable · application/problem+json
{"detail":"Resource does not support the representation requested","status":406,"title":"Not acceptable","type":"https://docs.payroc.com/api/errors#not-acceptable"}
Response schema · 4 fields
detailstringrequired
Explanation of the problem
statusintegerrequired
Http status code
titlestringrequired
Short description of the issue.
typestringrequired
URI reference identifying the problem type
An error has occured
500 Internal Server Error · application/problem+json
{"detail":"We are unable to process your request at this time","errors":[{"message":"Service offline"}],"status":500,"title":"Api error","type":"https://docs.payroc.com/api/errors#api-error"}