Get Payment

Velo Payments Sandbox for testing

https://api.sandbox.velopayments.com/

GET

/v4/paymentaudit/payments/{paymentId}

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

Request Example

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.sandbox.velopayments.com//v4/paymentaudit/payments/'

Response Example

200 - Example 1

{
    "accountName": "My Account Name",
    "accountNumber": "123123232323",
    "countryCode": "US",
    "events": [
        {
            "accountName": "accountName",
            "accountNumber": "accountNumber",
            "eventDateTime": "2000-01-23T04:56:07.000+00:00",
            "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "eventType": "PAYOUT_SUBMITTED",
            "iban": "iban",
            "paymentAmount": 1299,
            "principal": "principal",
            "routingNumber": "routingNumber",
            "sourceAmount": 1299
        },
        {
            "accountName": "accountName",
            "accountNumber": "accountNumber",
            "eventDateTime": "2000-01-23T04:56:07.000+00:00",
            "eventId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "eventType": "PAYOUT_SUBMITTED",
            "iban": "iban",
            "paymentAmount": 1299,
            "principal": "principal",
            "routingNumber": "routingNumber",
            "sourceAmount": 1299
        }
    ],
    "filenameReference": "file ref",
    "fundingStatus": "FUNDED",
    "iban": "DE89 3704 0044 0532 0130 00",
    "individualIdentificationNumber": "1231231adf",
    "invertedRate": 3.616076749251911,
    "isPaymentCcyBaseCcy": true,
    "payeeId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "paymentAmount": 7,
    "paymentChannelId": "123asdf",
    "paymentChannelName": "My Payment Channel",
    "paymentId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "paymentMemo": "Payment memo",
    "paymentMetadata": "sample metadata",
    "paymentTrackingReference": "paymentTrackingReference",
    "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "payorName": "payorName",
    "payorPaymentId": "123123asdf",
    "payout": {
        "payoutFrom": {
            "dbaName": "dbaName",
            "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payorName": "payorName",
            "principal": "principal",
            "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        },
        "payoutId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "payoutTo": {
            "dbaName": "dbaName",
            "payorId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
            "payorName": "payorName",
            "principal": "principal",
            "principalId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        }
    },
    "quoteId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "railsBatchId": "railsBatchId",
    "railsId": "asdf123",
    "railsPaymentId": "railsPaymentId",
    "rate": 9.301444243932576,
    "rejectionReason": "rejectionReason",
    "remoteId": "aasdf123",
    "remoteSystemId": "REMOTE_SYSTEM_ID",
    "remoteSystemPaymentId": "remoteSystemPaymentId",
    "returnCost": 1232,
    "returnReason": "Some Reason Value",
    "routingNumber": "123123123123",
    "sourceAccountId": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "sourceAccountName": "My Account",
    "sourceAmount": 12345,
    "status": "ACCEPTED",
    "submittedDateTime": "2000-01-23T04:56:07.000+00:00",
    "traceNumber": "abodu123",
    "transmissionType": "transmissionType",
    "withdrawable": true,
    "withdrawnReason": "withdrawnReason"
}

Request

Path Params

Query Params

Responses

🟢200200 response, request completed okay

application/json

Body

🟠400Invalid request. See Error message payload for details of failure

🟠401Invalid access token. May be expired or invalid

🟠403The authentication does not have permissions to access the resource This usually occurs when there is a valid authentication instance (client or user) but they do not have the required permissions

🟠404The resource was not found or is no longer available

Modified at 2022-09-11 21:50:19

Get List of Payments

Get Payout Statistics