Payments

Retrieve payment

Changed on

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.

get/payments/{paymentId}

Request

  • Base URL
    https://api.payroc.com/v1
  • URL
    https://api.payroc.com/v1/payments/{paymentId}
  • Auth
    HTTP bearer

Path parameters

paymentIdstring required

Unique identifier of the payment that the merchant wants to retrieve.

Response

Successful request. Returns the payment.

paymentIdstring required

Unique identifier that our gateway assigned to the transaction.

processingTerminalIdstring required

Unique identifier of the terminal that initiated the transaction.

operatorstring

Operator who initiated the request.

supportedOperationsSupportedOperationsItems[]

Array of operations that you can perform on the transaction. Our gateway can return any of the following values:

Changes

  • 817f57a896f3Revision changes
    • breaking

      the // response property's maxLength was increased from 100 to 255 for the response status

    • info

      added the optional property // to the response with the status

  • 9fc1e1d5b4a8Revision changes
    • warning

      deleted the header request parameter Authorization

    • info

      the endpoint scheme security Bearer was added to the API