Payment Audit Service (Deprecated)

V3 Get Payment

Deprecated (use /v4/paymentaudit/payments/<paymentId> instead)

get/v3/paymentaudit/payments/{paymentId}

Path parameters

paymentIdstring uuid required

Payment Id

Query parameters

sensitiveboolean

Optional. If omitted or set to false, any Personal Identifiable Information (PII) values are returned masked. If set to true, and you have permission, the PII values will be returned as their original unmasked values.

Response

200 response, request completed okay

paymentIdstring uuid required

The id of the payment

payeeIdstring uuid required

The id of the paymeee

payorIdstring uuid required

The id of the payor

payorNamestring

The name of the payor

quoteIdstring uuid required

The quote Id used for the FX

sourceAccountIdstring uuid required

The id of the source account from which the payment was taken

sourceAccountNamestring

The name of the source account from which the payment was taken

remoteIdstring

The remote id by which the payor refers to the payee. Only populated once payment is confirmed

sourceAmountinteger

The source amount for the payment (amount debited to make the payment)

sourceCurrencystring

ISO 3 character currency code

paymentAmountinteger required

The amount which the payee will receive

paymentCurrencystring

ISO 3 character currency code

ratenumber float

The FX rate for the payment, if FX was involved. Note that (depending on the role of the caller) this information may not be displayed

invertedRatenumber float

The inverted FX rate for the payment, if FX was involved. Note that (depending on the role of the caller) this information may not be displayed

submittedDateTimestring date-time required

statusstring required

Current status of the payment. One of the following values: ACCEPTED, AWAITING_FUNDS, FUNDED, UNFUNDED, BANK_PAYMENT_REQUESTED, REJECTED, ACCEPTED_BY_RAILS, CONFIRMED, FAILED, WITHDRAWN

fundingStatusstring required

The funding status of the payment. One of the following values: [FUNDED, INSTRUCTED, UNFUNDED

routingNumberstring

The routing number for the payment.

accountNumberstring

The account number for the account which will receive the payment.

ibanstring

The iban for the payment.

paymentMemostring

The payment memo set by the payor

filenameReferencestring

ACH file payment was submitted in, if applicable

individualIdentificationNumberstring

Individual Identification Number assigned to the payment in the ACH file, if applicable

traceNumberstring

Trace Number assigned to the payment in the ACH file, if applicable

payorPaymentIdstring

paymentChannelIdstring

paymentChannelNamestring

accountNamestring

railsIdstring required

The rails ID. Default value is RAILS ID UNAVAILABLE when not populated.

countryCodestring

The country code of the payment channel.

returnCostinteger

The return cost if a returned payment.

returnReasonstring

railsPaymentIdstring

railsBatchIdstring

paymentSchemestring

rejectionReasonstring

Example response

{
  "traceNumber": "abodu123",
  "accountName": "My Account Name",
  "sourceCurrency": "sourceCurrency",
  "paymentMemo": "Payment memo",
  "paymentAmount": 0,
  "fundingStatus": "fundingStatus",
  "railsBatchId": "railsBatchId",
  "paymentChannelName": "My Payment Channel",
  "paymentScheme": "paymentScheme",
  "filenameReference": "file ref",
  "rate": 6.0274563,
  "paymentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "countryCode": "US",
  "returnReason": "Some Reason Value",
  "submittedDateTime": "2000-01-23T04:56:07.000+00:00",
  "sourceAmount": 12345,
  "railsId": "asdf123",
  "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "events": [
    {
      "principal": "Prinicple example",
      "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "eventDateTime": "2000-01-23T04:56:07.000+00:00",
      "routingNumber": "123123123",
      "accountName": "My account",
      "iban": "DE89 3704 0044 0532 0130 00",
      "sourceCurrency": "sourceCurrency",
      "sourceAmount": 1299,
      "eventType": "eventType",
      "paymentCurrency": "paymentCurrency",
      "accountNumber": "123123123",
      "paymentAmount": 1299
    },
    {
      "principal": "Prinicple example",
      "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "eventDateTime": "2000-01-23T04:56:07.000+00:00",
      "routingNumber": "123123123",
      "accountName": "My account",
      "iban": "DE89 3704 0044 0532 0130 00",
      "sourceCurrency": "sourceCurrency",
      "sourceAmount": 1299,
      "eventType": "eventType",
      "paymentCurrency": "paymentCurrency",
      "accountNumber": "123123123",
      "paymentAmount": 1299
    }
  ],
  "payorName": "payorName",
  "sourceAccountName": "My Account",
  "paymentChannelId": "123asdf",
  "invertedRate": 1.4658129,
  "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "individualIdentificationNumber": "1231231adf",
  "railsPaymentId": "railsPaymentId",
  "accountNumber": "123123232323",
  "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "remoteId": "aasdf123",
  "routingNumber": "123123123123",
  "returnCost": 1232,
  "iban": "DE89 3704 0044 0532 0130 00",
  "payorPaymentId": "123123asdf",
  "paymentCurrency": "paymentCurrency",
  "rejectionReason": "rejectionReason",
  "status": "status"
}

Changes

Changed in 7 of the 50 revisions of this API.1159100

Jun 27, 20221e7a1734a45c56See the full diff
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  removed the ACCEPTED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the ACCEPTED_BY_RAILS enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the ACH_PAYMENT_RETURN_CANCELLED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the ACH_RETURN_RECEIVED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the ACH_SUBMITTED_TO_ODFI enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the AWAITING_FUNDS enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the BANK_PAYMENT_REQUESTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the BANK_PAYMENT_REQUESTED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the CONFIRMED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the EUR enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the EUR enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the EUR enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the EUR enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the FAILED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the FUNDED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the FUNDED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the GBP enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the GBP enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the GBP enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the GBP enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the INSTRUCTED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYMENT_ACCEPTED_BY_RAILS enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYMENT_AWAITING_FUNDS enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYMENT_CONFIRMED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYMENT_FAILED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYMENT_FUNDED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYMENT_SUBMITTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYMENT_SUBMITTED_ACCEPTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYMENT_SUBMITTED_REJECTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYMENT_UNFUNDED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_BATCH_EXECUTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_BATCH_FUNDED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_BATCH_FUNDS_RETURNED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_BATCH_FUNDS_RETURN_REQUEST enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_BATCH_QUOTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_BATCH_QUOTE_EXPIRED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_COMPLETED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_FUNDS_DENIED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_FUNDS_GRANTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_FUNDS_REQUEST enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_INSTRUCTED_V3 enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_QUOTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_SUBMITTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the PAYOUT_WITHDRAWN enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the REJECTED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the RETURN_PAYMENT_CANCELLATION_REQUESTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the RETURN_PAYMENT_FUNDING_REQUESTED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the SOURCE_AMOUNT_CONFIRMED enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the UNFUNDED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the UNFUNDED enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the USD enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the USD enum value from the // response property for the response status
  response-property-enum-value-removed
- ○
  removed the USD enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the USD enum value from the response property for the response status
  response-property-enum-value-removed
- ○
  removed the WITHDRAWN enum value from the response property for the response status
  response-property-enum-value-removed
This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jan 14, 20215e43696986393See the full diff
- ○
  api operation id getPaymentDetails removed and replaced with getPaymentDetailsV3
  api-operation-id-removed
- ○
  api tag Payment Audit Service (Deprecated) added
  api-tag-added
- ○
  api tag Payment Audit Service removed
  api-tag-removed
This revision also has 27 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Sep 25, 2020dd71433847a6424See the full diff
- ▲
  the / response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the / response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the / response's property type changed from no type to object for status
  response-property-type-changed
- ▲
  the / response's property type changed from no type to object for status
  response-property-type-changed
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property // to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/locationType deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
- ○
  response property errors/items/reasonCode deprecated
  response-property-deprecated
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jun 24, 2020aded220b0d7b4See the full diff
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the media type application/json for the response with the status
  response-media-type-added
- ○
  added the non-success response with the status
  response-non-success-status-added
This revision also has 26 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Dec 6, 2019fbe041e3d3256See the full diff
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the non-success response with the status
  response-non-success-status-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  added the optional property to the response with the status
  response-optional-property-added
- ○
  the response's property default value RAILS ID UNAVAILABLE was added for the status
  response-property-default-value-added
This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Jul 16, 201902b01d19d9e34See the full diff
- ▲
  the // response's property format changed from int32 to int64 for status
  response-property-type-changed
- ▲
  the // response's property format changed from int32 to int64 for status
  response-property-type-changed
- ▲
  the response's property format changed from decimal to float for status
  response-property-type-changed
- ▲
  the response's property format changed from decimal to float for status
  response-property-type-changed
Jul 15, 2019ced8e167a97c3597See the full diff
- ▲
  removed the media type application/json for the response with the status
  response-media-type-removed
- ▲
  the response's property format changed from float to decimal for status
  response-property-type-changed
- ▲
  the response's property format changed from float to decimal for status
  response-property-type-changed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  removed the optional property from the response with the status
  response-optional-property-removed
- ●
  added the new ACCEPTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new ACCEPTED_BY_RAILS enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new ACH_PAYMENT_RETURN_CANCELLED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new ACH_RETURN_RECEIVED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new ACH_SUBMITTED_TO_ODFI enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new AWAITING_FUNDS enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new BANK_PAYMENT_REQUESTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new BANK_PAYMENT_REQUESTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new CONFIRMED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new EUR enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new EUR enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new EUR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new EUR enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new FAILED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new FUNDED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new FUNDED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new GBP enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new GBP enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new GBP enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new GBP enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new INSTRUCTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYMENT_ACCEPTED_BY_RAILS enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYMENT_AWAITING_FUNDS enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYMENT_CONFIRMED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYMENT_FAILED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYMENT_FUNDED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYMENT_SUBMITTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYMENT_SUBMITTED_ACCEPTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYMENT_SUBMITTED_REJECTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYMENT_UNFUNDED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_BATCH_EXECUTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_BATCH_FUNDED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_BATCH_FUNDS_RETURNED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_BATCH_FUNDS_RETURN_REQUEST enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_BATCH_QUOTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_BATCH_QUOTE_EXPIRED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_COMPLETED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_FUNDS_DENIED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_FUNDS_GRANTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_FUNDS_REQUEST enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_INSTRUCTED_V3 enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_QUOTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_SUBMITTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new PAYOUT_WITHDRAWN enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new REJECTED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new RETURN_PAYMENT_CANCELLATION_REQUESTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new RETURN_PAYMENT_FUNDING_REQUESTED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new SOURCE_AMOUNT_CONFIRMED enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new UNFUNDED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new UNFUNDED enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new USD enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new USD enum value to the // response property for the response status
  response-property-enum-value-added
- ●
  added the new USD enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new USD enum value to the response property for the response status
  response-property-enum-value-added
- ●
  added the new WITHDRAWN enum value to the response property for the response status
  response-property-enum-value-added
- ○
  api operation id getPaymentDetailsV3 removed and replaced with getPaymentDetails
  api-operation-id-removed
- ○
  api tag Payment Audit Service added
  api-tag-added
- ○
  api tag Payment Audit Service (Deprecated) removed
  api-tag-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  removed the non-success response with the status
  response-non-success-status-removed
- ○
  the response's property default value RAILS ID UNAVAILABLE was removed for the status
  response-property-default-value-removed
This revision also has 257 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history