Payment Resource

Get Single Payment in Batch

get/customers/{customerId}/batches/{batchId}/payments/{id}

Request

  • Base URL
    https://masspaysandbox.api.convera.com/masspayments
  • URL
    https://masspaysandbox.api.convera.com/masspayments/customers/{customerId}/batches/{batchId}/payments/{id}
  • Auth
    none declared

Path parameters

customerIdstring required

customerId

batchIdstring required

batchId

idstring required

id

Query parameters

fieldsstring

Enter a single payment field or multiple payment fields (separated by a comma) to display a subset of the payment field(s). Example:fields=id, paymentReference

Response

OK

idstring
customerIdstring
statusstring
errorCodestring
partnerReferencestring
createdOnstring
lastUpdatedOnstring
paymentMethodstring
paymentReferencestring
paymentVersionstring
amountinteger
currencyCodestring
settlementAmountinteger
settlementCurrencyCodestring
isFixedAmountInSettlementCurrencyboolean
isDoddFrankboolean
chargeTypestring
valueDatestring
amountReturnedinteger
amountReturnedCurrencystring
uetrstring
purposeOfPaymentstring
purposeOfPaymentCodestring
instructionForBankstring
instructionCodeForBankstring
remittanceTypestring
updateErrorCodestring
updateErrorOnstring
outgoingOrderIdstring

Changes

No recorded changes to this operation across all 2 revisions of this API.