v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

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"
}