Retrieve payment
Use this method to retrieve information about a card payment.
To retrieve a payment, you need its paymentId. Our gateway returned the paymentId in the response of the Create Payment method.
Note: If you don’t have the paymentId, use our List Payments method to search for the payment.
Our gateway returns the following information about the payment:
- Order details, including the transaction amount and when it was processed.
- Payment card details, including the masked card number, expiry date, and payment method.
- Cardholder details, including their contact information and shipping address.
- Payment details, including the payment type, status, and response.
If the merchant saved the customer’s card details, our gateway returns a secureTokenID, which you can use to perform follow-on actions.
Path parameters
paymentId
Unique identifier of the payment that the merchant wants to retrieve.
Headers
Authorization
Bearer authentication of the form Bearer <token>, where token is your auth token.
Response
Successful request. Returns the payment.
paymentId
Unique identifier that our gateway assigned to the transaction.
processingTerminalId
Unique identifier of the terminal that initiated the transaction.
order
Object that contains information about the payment.
card
Object that contains information about the card.
transactionResult
Object that contains information about the transaction response details.
operator
Operator who initiated the request.
customer
Object that contains the customer's contact details and address information.
refunds
Array of refundSummary objects.
Each object contains information about refunds linked to the transaction.
supportedOperations
Array of operations that you can perform on the transaction.
capture
- Capture the payment.refund
- Refund the payment.fullyReverse
- Fully reverse the transaction.partiallyReverse
- Partially reverse the payment.incrementAuthorization
- Increase the amount of the authorization.adjustTip
- Adjust the tip post-payment.addSignature
- Add a signature to the payment.setAsReady
- Set the transaction’s status toready
.setAsPending
- Set the transaction’s status topending
.setAsDeclined
- Set the transaction’s status todeclined
.
customFields
Array of customField objects.