v1

latestOpenAPI 3.0.2Apache License 2.02026-07-13109285691.8 KB

Payment Audit Service

Get Payment

Get the payment with the given id. This contains the payment history.

get/v4/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

remoteSystemIdstring

The velo id of the remote system orchestrating the payment. Not populated for normal Velo payments.

remoteSystemPaymentIdstring

The id of the payment in the remote system. Not populated for normal Velo payments.

sourceAmountinteger

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

sourceCurrencystring

ISO-4217 3 character currency code

paymentAmountinteger required

The amount which the payee will receive

paymentCurrencystring

ISO-4217 3 character currency code

ratenumber double

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 double

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

isPaymentCcyBaseCcyboolean

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, RETURNED, WITHDRAWN

fundingStatusstring required

Current 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.

payeeAddressCountryCodestring

The country code of the payee's address.

returnCostinteger

The return cost if a returned payment.

returnReasonstring

railsPaymentIdstring

railsBatchIdstring

railsAccountIdstring

paymentSchemestring

rejectionReasonstring

railsRejectionInformationstring

The original reason that the payment was rejected. This can be third party rails specific if rejected by the underlying third party rails logic.

withdrawnReasonstring

withdrawableboolean

autoWithdrawnReasonCodestring

Populated with rejection reason code if the payment was withdrawn automatically at instruct time

transmissionTypestring

The transmission type of the payment, e.g. ACH, SAME_DAY_ACH, WIRE, GACHO

transmissionTypeRequestedstring

The transmission type of the payment requested by the payor

paymentTrackingReferencestring

paymentMetadatastring

Metadata for the payment

transactionIdstring uuid

transactionReferencestring

Example response

{
  "traceNumber": "abodu123",
  "payout": {
    "payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "payoutFrom": {
      "principal": "principal",
      "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "dbaName": "dbaName",
      "payorName": "payorName"
    },
    "payoutTo": {
      "principal": "principal",
      "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "dbaName": "dbaName",
      "payorName": "payorName"
    }
  },
  "paymentScheme": "paymentScheme",
  "paymentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "submittedDateTime": "2000-01-23T04:56:07.000+00:00",
  "railsId": "asdf123",
  "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "railsRejectionInformation": "railsRejectionInformation",
  "events": [
    {
      "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "eventDateTime": "2000-01-23T04:56:07.000+00:00",
      "accountName": "accountName",
      "sourceCurrency": "EUR",
      "eventType": "eventType",
      "accountNumber": "accountNumber",
      "paymentAmount": 1299,
      "principal": "principal",
      "routingNumber": "routingNumber",
      "iban": "iban",
      "scheduledFor": "2000-01-23T04:56:07.000+00:00",
      "sourceAmount": 1299,
      "scheduledBy": "Aphra Behn",
      "paymentCurrency": "EUR",
      "scheduledAt": "2000-01-23T04:56:07.000+00:00"
    },
    {
      "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
      "eventDateTime": "2000-01-23T04:56:07.000+00:00",
      "accountName": "accountName",
      "sourceCurrency": "EUR",
      "eventType": "eventType",
      "accountNumber": "accountNumber",
      "paymentAmount": 1299,
      "principal": "principal",
      "routingNumber": "routingNumber",
      "iban": "iban",
      "scheduledFor": "2000-01-23T04:56:07.000+00:00",
      "sourceAmount": 1299,
      "scheduledBy": "Aphra Behn",
      "paymentCurrency": "EUR",
      "scheduledAt": "2000-01-23T04:56:07.000+00:00"
    }
  ],
  "transactionReference": "transactionReference",
  "railsPaymentId": "railsPaymentId",
  "payeeAddressCountryCode": "US",
  "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "transactionId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "returnCost": 1232,
  "withdrawnReason": "withdrawnReason",
  "iban": "DE89 3704 0044 0532 0130 00",
  "paymentMetadata": "sample metadata",
  "payorPaymentId": "123123asdf",
  "remoteSystemId": "REMOTE_SYSTEM_ID",
  "paymentCurrency": "EUR",
  "rejectionReason": "rejectionReason",
  "paymentTrackingReference": "paymentTrackingReference",
  "status": "status",
  "postInstructFxInfo": {
    "fxStatus": "INITIATED",
    "fxStatusUpdatedAt": "2000-01-23T04:56:07.000+00:00",
    "fxTransactionReference": "AB123GHI",
    "fxMode": "MANUAL"
  },
  "accountName": "My Account Name",
  "remoteSystemPaymentId": "remoteSystemPaymentId",
  "sourceCurrency": "EUR",
  "paymentMemo": "Payment memo",
  "railsAccountId": "railsAccountId",
  "paymentAmount": 7,
  "fundingStatus": "fundingStatus",
  "railsBatchId": "railsBatchId",
  "paymentChannelName": "My Payment Channel",
  "filenameReference": "file ref",
  "rate": 9.301444243932576,
  "countryCode": "US",
  "returnReason": "Some Reason Value",
  "withdrawable": true,
  "autoWithdrawnReasonCode": "autoWithdrawnReasonCode",
  "isPaymentCcyBaseCcy": true,
  "sourceAmount": 12345,
  "transmissionType": "transmissionType",
  "payorName": "payorName",
  "sourceAccountName": "My Account",
  "paymentChannelId": "123asdf",
  "invertedRate": 3.616076749251911,
  "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "individualIdentificationNumber": "1231231adf",
  "accountNumber": "123123232323",
  "transmissionTypeRequested": "transmissionTypeRequested",
  "remoteId": "aasdf123",
  "routingNumber": "123123123123",
  "schedule": {
    "scheduledFor": "2000-01-23T04:56:07.000+00:00",
    "scheduleStatus": "SCHEDULED",
    "notificationsEnabled": true,
    "scheduledBy": "Aphra Behn",
    "scheduledByPrincipalId": "8946953b-1e3b-49cf-9da4-b704cbb78f3e",
    "scheduledAt": "2000-01-23T04:56:07.000+00:00"
  }
}