Visa Direct Connect API Reference
Visa Direct Connect
Search API Reference
- Getting Started
- How to Use Visa Direct Connect
- Authentication and Encryption
- Error Codes
- Product Terms
- Request & Response Codes
API Reference
Callback API-Initial Version - Deprecated
- EventPayout Status Notification
- EventPayout Return Notification
- EventLedger Notification
- EventBalance Notification
Eligibility
- postEligibility check of Card
Exception Management
- delCancel Account Payout
- postAdjust cards payouts or payin transactions
- postPayin reversal transaction
- delCancel Wallet Payout
Get Requirements
- getGet Metadata Wallets
- getGet Metadata Accounts
Notification API
- EventPayout Metadata Change Notification
- EventAccount Balance Notification
- EventPayout Status Notification
- EventFlexible Settlement Notification
- EventPayout Return Notification
- EventLedger Notification
Payin
- postAccount Funding to Cards
Payout
- postSend Payout To Account
- postSend Payout To Wallet
- postSend Payout to cards
Transaction Management
- getQuery Cards transaction
- getQuery Account Payout
- getQuery Wallet Payout
Transactional API - Initial Version - Deprecated
- postSend Payout
- postRequest Exception
- getQuery Payout
- getGet Account Balance
- delCancelPayout
- postValidate Payout
Validate
- postValidate Wallet payout
- postValidate Account Payout
Verify
- postVerify Wallet
- postVerify Cards
- postVerify Account
Download Visa Direct Connect API Reference
Callback API-Initial Version - Deprecated
Payout Status Notification Webhook v1 - Latest
Request
Header Parameters
| keyId | string VDP Gateway client MLE (Message Level Key) Key-ID used for callback message encryption (if enabled by client) Example: fffe3feb-3c22-488d-9381-23453289773b |
Request Body schema: application/json
One of:
- PayoutNotificationReceivedRequest-12
- PayoutNotificationProcessRequest-12
- PayoutNotificationFailedRequest-3
Transaction Detail
| clientReferenceId required |
string [ 1 .. 35 ] characters Identifier assigned by the Originating Entity to uniquely identify the transaction. ISO20022 field name: Transaction Information And Status - Original Transaction Identification Only alphanumeric and '-' characters are allowed. |
| destinationAmount required |
number The destination amount that will be deposited to the beneficiary account... Example: 12.34 |
| destinationCurrencyCode required |
string 3 characters The 3-character ISO-4217 code in this field reflects the currency associated with the destination amount... Example: "USD" |
| initiatingPartyId required |
integer Identifier assigned by Visa to uniquely identify the Originating Entity who initiates the transaction... Example: 100111 |
| notificationDateTime required |
string ISO 8601 formatted UTC Timestamp... Example: 2020-05-05T12:12:12.000Z |
| payoutId required |
string [ 1 .. 50 ] characters This is a unique identifier generated by Visa for the original payout... Example: "5003f6a0-2c44-11b2-aa57-47378ae53313_1" |
| settlementAmount required |
number This is the amount to be debited from Originating Entity/Visa Client's funding account... Example: 12.34 |
| settlementCurrencyCode required |
string 3 characters The settlement currency code... Example: "USD" |
| status required |
string Status of the transaction... Example: "PAYMENT_RECEIVED" |
| transactionAmount required |
number The amount to debit from merchant's funding account or credit to beneficiary's bank account... Example: 12.34 |
| transactionCurrencyCode required |
string 3 characters The 3-character ISO-4217 code in this field reflects the currency associated to the transaction amount... Example: "USD" |
| transactionDateTime required |
string ISO 8601 formatted UTC Timestamp... Example: 2020-05-05T12:12:12.000Z |
| endToEndId | string [ 1 .. 35 ] characters Identifier assigned by the Originating Entity's customer to track the transaction end-to-end... Example: "5003f6a02c4411b2aa5747378ae5331" |
| expectedPostingDate | string This is an estimated date by which the payout should be posted... |
| fundsAvailableDateTime | string Funds available Date and Time of the payment |
| fxConversionRate | number This field contains the exchange rate applied to the pair of settlementCurrencyCode and destinationCurrencyCode... Example: 0.07 |
| payoutSpeed | string Originating Entity to indicate the desired payout speed for the payment... Example: "standard" |
| reasonDetails | object |
| --- | --- |
| code required |
string 5 characters If the Transaction Status is RETURNED or REJECTED... Example: "RE101" |
| comment | string [ 1 .. 255 ] characters comment for the action |
| description | string [ 1 .. 105 ] characters Indicates the PSP return description when the payout is returned... |
| payoutMethod | string
Originating Entity must indicate the payout method i.e. Account, Wallet or Card... Valid values: "B", "W", "C" |
Responses
- 200: ok
- 400: When any field fails schematic validation...
- 404: Resource not found
- 503: Service Unavailable