SchemaPaymentsBank Transfer Payments

Retrieve payment

Use this method to retrieve information about a bank transfer 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.
  • Bank account details, including the customer’s name and account number.
  • Customer’s details, including the customer’s phone number.
  • Transaction details, including any refunds or re-presentments.

If the merchant saved the customer’s bank account details, our gateway returns a secureTokenID, which you can use to perform follow-on actions.

Path parameters

paymentIdstringRequired=10 characters
Unique identifier that our gateway assigned to the payment.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Response

Successful request. Returns the specific payment.
paymentIdstring=10 characters
Unique identifier that we assigned to the payment.
processingTerminalIdstring>=4 characters<=50 characters
Unique identifier that we assigned to the terminal.
orderobject
Object that contains information about the transaction.
bankAccountobject
Object that contains information about the bank account.
transactionResultobject
Object that contains information about the transaction.
customerobject or null
Object that contains information about the customer.
refundslist of objects or null
List of refunds issued against the payment
returnslist of objects or null
List of returns issued against the payment
representmentobject or null
Object that contains information about a payment.
customFieldslist of objects or null
Array of customField objects.

Errors